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

本篇文章给大家分享《在 Go 程序中捆绑静态资源的最佳方式是什么？》，覆盖了Golang的常见基础知识，其实一个语言的全部知识点一篇文章是不可能说完的，但希望通过这些问题，让读者对自己的掌握程度有一定的认识(B 数)，从而弥补自己的不足，更好的掌握它。

我正在 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 对它们进行索引并按原样提供它们。

如果没有好的方法可以做到这一点，请告诉我，或者我尝试这样做是找错了方向。我只是认为最终用户会喜欢管理尽可能少的文件。

^{如果有比 go 更合适的标签，请随时添加或让我知道。}

正确答案

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

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

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

从 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 支持使用 http.FS() 从 embed.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 = `

example embedded html content.

`

// sending it:
w.write([]byte(html))  // w is an io.writer

优化提示：

由于大多数时候您只需将资源写入 io.Writer，因此您还可以存储 []byte 转换的结果：

var html = []byte(`
example...
`)

// sending it:
w.write(html)  // w is an io.writer

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

var html = `
this is a back quote followed by a dot: ` + "`" + `.
`

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

嵌入二进制文件

存储为字节片

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

如果您不想为此使用第 3 方库，这里有一个简单的代码片段，它读取二进制文件，并输出声明 []byte 类型变量的 go 源代码，该变量将使用文件的具体内容：

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 = ""

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

文中关于的知识介绍，希望对你的学习有所帮助！若是受益匪浅，那就动动鼠标收藏这篇《在 Go 程序中捆绑静态资源的最佳方式是什么？》文章吧，也可关注golang学习网公众号了解相关技术文章。