为了账号安全,请及时绑定邮箱和手机立即绑定

在Go程序中捆绑静态资源的最佳方法是什么?

在Go程序中捆绑静态资源的最佳方法是什么?

Go
收到一只叮咚 2021-05-14 14:15:15
我正在Go中开发一个小型Web应用程序,该应用程序旨在用作开发人员机器上的工具,以帮助调试其应用程序/ Web服务。该程序的界面是一个网页,其中不仅包括HTML,还包括一些JavaScript(用于功能),图像和CSS(用于样式)。我正在计划将此应用程序开源,因此用户应该只需能够运行Makefile,所有资源都将存放在所需的位置。但是,我也希望能够简单地分发具有尽可能少的文件/依赖关系的可执行文件。是否有将HTML / CSS / JS与可执行文件捆绑在一起的好方法,所以用户只需要下载并担心一个文件?现在,在我的应用程序中,提供一个静态文件看起来像这样:// called via http.ListenAndServefunc switchboard(w http.ResponseWriter, r *http.Request) {    // snipped dynamic routing...    // look for static resource    uri := r.URL.RequestURI()    if fp, err := os.Open("static" + uri); err == nil {        defer fp.Close()        staticHandler(w, r, fp)        return    }    // snipped blackhole route}因此非常简单:如果所请求的文件存在于我的静态目录中,请调用处理程序,该处理程序仅打开文件并尝试Content-Type在投放之前设置好商品。我的想法是,这没有必要基于真实的文件系统:如果有编译的资源,我可以简单地通过请求URI对其进行索引并按原样提供它们。如果没有很好的方法来执行此操作,或者我试图通过这样做来使错误的树吠叫,请告诉我。我只是认为最终用户希望管理的文件越少越好。
查看完整描述

3 回答

?
缥缈止盈

TA贡献2041条经验 获得超4个赞

从Go 1.16开始,go工具支持将静态文件直接嵌入到可执行二进制文件中。


您必须导入embed程序包,并使用//go:embed伪指令标记要嵌入的文件以及要将其存储到的变量。


将hello.txt文件嵌入可执行文件的3种方法:


import "embed"


//go:embed hello.txt

var s string

print(s)


//go:embed hello.txt

var b []byte

print(string(b))


//go:embed hello.txt

var f embed.FS

data, _ := f.ReadFile("hello.txt")

print(string(data))

使用embed.FS变量的类型,您甚至可以将多个文件包含到一个变量中,该变量将提供一个简单的文件系统界面:


// content holds our static web server content.

//go:embed image/* template/*

//go:embed html/index.html

var content embed.FS

在net/http具有支持来自值提供文件服务embed.FS使用http.FS()这样的:


http.Handle("/static/", http.StripPrefix("/static/", http.FileServer(http.FS(content))))

模板包还可以使用text/template.ParseFS(),html/template.ParseFS()函数和text/template.Template.ParseFS(),html/template.Template.ParseFS()方法来解析模板:


template.ParseFS(content, "*.tmpl")

下面的答案列出了您的旧选项(在Go 1.16之前)。


嵌入文字档

如果我们谈论的是文本文件,则可以轻松地将其嵌入源代码本身。只需使用反引号即可声明string文字,如下所示:


const html = `

<html>

<body>Example embedded HTML content.</body>

</html>

`


// Sending it:

w.Write([]byte(html))  // w is an io.Writer

优化提示:


由于大多数情况下,您只需要将资源写入io.Writer,就可以存储[]byte转换结果:


var html = []byte(`

<html><body>Example...</body></html>

`)


// Sending it:

w.Write(html)  // w is an io.Writer

唯一需要注意的是,原始字符串文字不能包含反引号字符(`)。原始字符串文字不能包含序列(与解释的字符串文字不同),因此,如果要嵌入的文本确实包含反引号,则必须中断原始字符串文字并将反引号连接为解释的字符串文字,例如以下示例:


var html = `<p>This is a back quote followed by a dot: ` + "`" + `.</p>`

性能不会受到影响,因为这些串联将由编译器执行。


嵌入二进制文件

存储为字节片

对于二进制文件(例如图像),最紧凑的(关于生成的本机二进制文件)和最有效的将是[]byte在源代码中将文件的内容作为。这可由go-bindata之类的第三方第三方库/库生成。


如果您不想为此使用第三方库,下面是一个简单的代码段,该代码段读取一个二进制文件,并输出Go源代码,该源代码声明了[]byte将使用文件的确切内容初始化的类型的变量:


imgdata, err := ioutil.ReadFile("someimage.png")

if err != nil {

    panic(err)

}


fmt.Print("var imgdata = []byte{")

for i, v := range imgdata {

    if i > 0 {

        fmt.Print(", ")

    }

    fmt.Print(v)

}

fmt.Println("}")

如果文件包含0到16个字节的示例输出(在Go Playground上尝试):


var imgdata = []byte{0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15}

储存为base64 string

如果文件不是“太大”(大多数图像/图标合格),那么还有其他可行的选择。您可以将文件的内容转换为Base64string并将其存储在源代码中。在应用程序启动(func init())或需要时,您可以将其解码为原始[]byte内容。Go在encoding/base64软件包中对Base64编码提供了很好的支持。


将(二进制)文件转换为base64string很简单:


data, err := ioutil.ReadFile("someimage.png")

if err != nil {

    panic(err)

}

fmt.Println(base64.StdEncoding.EncodeToString(data))

将结果base64字符串存储在您的源代码中,例如作为const。


解码只是一个函数调用:


const imgBase64 = "<insert base64 string here>"


data, err := base64.StdEncoding.DecodeString(imgBase64) // data is of type []byte

按报价储存 string

与存储为base64相比,效率更高,但在源代码中存储二进制数据的带引号的字符串文字可能会更长。我们可以使用以下strconv.Quote()函数获取任何字符串的带引号的形式:


data, err := ioutil.ReadFile("someimage.png")

if err != nil {

    panic(err)

}

fmt.Println(strconv.Quote(string(data))

对于包含从0到64的值的二进制数据,这是输出的样子(在Go Playground上尝试):


"\x00\x01\x02\x03\x04\x05\x06\a\b\t\n\v\f\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !\"#$%&'()*+,-./0123456789:;<=>?"


(请注意,strconv.Quote()在其前后附加引号。)


您可以在源代码中直接使用此带引号的字符串,例如:


const imgdata = "\x00\x01\x02\x03\x04\x05\x06\a\b\t\n\v\f\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !\"#$%&'()*+,-./0123456789:;<=>?"

它可以立即使用,无需解码;取消引用由Go编译器在编译时完成。


如果需要,也可以将其存储为字节片:


var imgdata = []byte("\x00\x01\x02\x03\x04\x05\x06\a\b\t\n\v\f\r\x0e\x0f\x10\x11\x12\x13\x14\x15\x16\x17\x18\x19\x1a\x1b\x1c\x1d\x1e\x1f !\"#$%&'()*+,-./0123456789:;<=>?")



查看完整回答
反对 回复 2021-05-24
?
杨魅力

TA贡献1811条经验 获得超6个赞

还有一种奇特的方式-我使用maven插件来构建GoLang项目,它允许使用JCP预处理器将二进制块和文本文件嵌入到源代码中。在这种情况下,代码看起来像下面的代码行(这里可以找到一些示例

var imageArray = []uint8{/*$binfile("./image.png","uint8[]")$*/}


查看完整回答
反对 回复 2021-05-24
  • 3 回答
  • 0 关注
  • 280 浏览
慕课专栏
更多

添加回答

举报

0/150
提交
取消
意见反馈 帮助中心 APP下载
官方微信