在Go程序中捆绑静态资源的最佳方式是什么?
我在Go上开发一个小型的Web应用程序,这个应用程序可以在开发人员的机器上作为一个工具来帮助debugging他们的应用程序/ Web服务。 程序的接口是一个不仅包含HTML,还包含一些JavaScript(用于function),图像和CSS(用于样式)的网页。 我正在计划开源这个应用程序,所以用户应该能够运行一个Makefile,所有的资源都将到达他们需要去的地方。 不过,我也希望能够尽可能less的文件/依赖关系来分发可执行文件。 有没有一种很好的方法来捆绑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索引它们,并为它们服务。
如果没有一个好的方法来做到这一点,或者我正在试图做这个错误的树,让我知道。 我只是想,最终用户将欣赏尽可能less的文件pipe理。
如果有更合适的标签比去 ,请随时添加或让我知道。
go-bindata包看起来可能是你感兴趣的。
https://github.com/jteeuwen/go-bindata
它将允许您将任何静态文件转换为可embedded代码中的函数调用,并在调用时返回文件内容的字节片段。
embedded文本文件
如果我们正在谈论文本文件,他们可以很容易地embedded到源代码本身。 只要使用后面的引号来声明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
只有你必须小心的是原始string文字不能包含反引号字符(`)。 原始string文字不能包含序列(与解释的string文字不同),因此,如果要embedded的文本包含反引号,则必须拆分原始string文字并将反引号连接为解释的string文字,如下例所示:
var html = `<p>This is a back quote followed by a dot: ` + "`" + `.</p>`
性能不受影响,因为这些连接将由编译器执行。
embedded二进制文件
作为一个字节片段进行分割
对于二进制文件(如图像)来说,最紧凑(关于生成的本机二进制文件),最有效的方法是将源文件中的文件内容作为[]byte
。 这可以由像go-bindata这样的第三方的toos /库生成 。
如果你不想为此使用第三方库,下面是一个简单的代码片断,它读取一个二进制文件,并输出Go源代码,声明一个types为[]byte
的variables,该variables将被初始化为文件:
data, 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))
将结果base64string存储在源代码中,例如作为一个const
。
解码它只是一个函数调用:
const imgBase64 = "<insert base64 string here>" data, err := base64.StdEncoding.DecodeString(imgBase64) // data is of type []byte
存储为引用的string
比存储为base64更有效,但源代码中可能更长的是存储二进制数据的带引号的string文字。 我们可以使用strconv.Quote()
函数获得任何string的引用forms:
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()
将附加引号并加上引号。)
你可以在源代码中直接使用这个带引号的string,例如:
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:;<=>?")
也有一些奇特的方法 – 我使用Maven插件来构buildGoLang项目,它允许使用JCP预处理器将二进制块和文本文件embedded到源中。 在案例代码只是看起来像下面的行( 和一些例子可以在这里find )
var imageArray = []uint8{/*$binfile("./image.png","uint8[]")$*/}