从 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
源代码中的 a 。这可以由go-bindata等第三方工具/库生成。
如果您不想为此使用 3rd 方库,这里有一个简单的代码片段,它读取二进制文件,并输出声明类型变量的 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}
存储为 base64string
如果文件不是“太大”(大多数图像/图标都符合条件),那么还有其他可行的选项。您可以将文件的内容转换为 Base64string
并将其存储在您的源代码中。在应用程序启动时 ( func init()
) 或需要时,您可以将其解码为原始[]byte
内容。encoding/base64
Go 在包中对 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:;<=>?")