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


100

我正在Go中开发一个小型Web应用程序,该应用程序旨在用作开发人员机器上的工具,以帮助调试其应用程序/ Web服务。该程序的界面是一个网页,不仅包含HTML,而且还包含一些JavaScript(用于功能),图像和CSS(用于样式)。我正在计划对该应用程序进行开源采购,因此用户应该只需能够运行Makefile,所有资源都将存放在需要存放的地方。但是,我也希望能够简单地分发具有尽可能少的文件/依赖关系的可执行文件。是否有将HTML / CSS / JS与可执行文件捆绑在一起的好方法,因此用户只需要下载并担心一个文件?


现在,在我的应用程序中,提供静态文件看起来像这样:

// called via http.ListenAndServe
func 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对其进行索引并按原样提供它们。

如果没有很好的方法来执行此操作,或者我试图通过这样做来使错误的树叫bar,请告诉我。我只是认为最终用户希望尽可能少地管理文件。

如果有比 ,请随时添加它们或让我知道。



我实际上只是想到今天完全相同的问题。我可能会探索的解决方案是go generate与一个小的命令行实用程序(与我的源代码打包在一起)一起使用,以将文件转换为[]byte切片,这些切片作为变量嵌入到代码中,类似于这样stringer做(请参阅blog.golang.org) / generate)。
拉尔夫(Ralph)

Answers:


76

go-bindata软件包看起来可能是您感兴趣的软件包。

https://github.com/go-bindata/go-bindata

它将允许您将任何静态文件转换为可以嵌入到代码中的函数调用,并在调用时返回文件内容的字节片。


8
在我看来,支持这种做法似乎是自私的,但是无论如何我还是会这样做:p尽管记录显示,它不是软件包,而是命令行工具。
jimt

仅作记录,这就是我在项目中采取的道路。在某种程度上,@ jimt引入了一些新功能,使事情变得更加用户友好,但不再提供我所需的粒度,因此我编写了自己的工具,该工具功能较少,但专为我的用例而设计(我将该工具用作构建过程的序言):github.com/jimmysawczuk/go-binary
Jimmy Sawczuk 2015年

37

嵌入文字档

如果我们谈论的是文本文件,则可以轻松地将其嵌入源代码本身。只需使用反引号声明如下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源代码中的。这可以由第三方方gos / library如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

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

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

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:;<=>?")

有什么办法可以将sh文件绑定到可执行文件?
Kasun Siyambalapitiya

我猜数据应该在“存储为字节片”部分的第一个代码片段中为imgdata。
逻辑x

1
@deusexmachina你说得对,已修复。操场上的代码已经正确。
icza

2

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

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

@是否可以绑定具有sh上述目录或可执行文件的目录
Kasun Siyambalapitiya

@KasunSiyambalapitiya绑定目录?绑定sh文件?不明白你的意思。如果您希望将目录中的所有内容都嵌入,这就是我已经完成的工作go-bindata。例如,如果我放入//go:generate $GOPATH/bin/go-bindata -prefix=data/ -pkg=$GOPACKAGE data/一个(未生成的)go文件,go generate ./...它将在包的目录中运行go-bindata,将所有内容都嵌入一个数据子目录中,但删除了“ data /”前缀。
标记

1

作为go-bindata另一个答案中提到的流行替代方法,mjibson / esc还嵌入了任意文件,但特别方便地处理目录树。

By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.