嵌入文本文件

Question

我正在使用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更合适，请随时添加或告诉我们。}

Answer 1

go-bindata包看起来可能就是你感兴趣的内容。

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

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

Answer 2

嵌入文本文件

如果我们谈论文本文件，它们可以很容易地嵌入到源代码本身中。只需使用后引号来声明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

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

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`

如果文件不是“太大”（大多数图像/图标符合条件），还有其他可行的选项。您可以将文件的内容转换为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:;<=>?"

它已准备好使用，无需解码; un编辑由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:;<=>?")

Answer 3

还有一些奇特的方式 - 我使用maven plugin来构建GoLang项目，它允许使用JCP preprocessor将二进制块和文本文件嵌入到源中。在案例代码中，看起来就像下面的行（and some example can be found here）

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

Answer 4

捆绑 React 应用程序

从 Go 1.6 开始，go:embed 可以为我们完成这项工作。但是在捆绑 Web 静态内容时，它的默认示例（在 Internet 上）并没有像我们预期的那样工作。（我到处都看到 hello.txt）。

例如，您有一个来自 react 的构建输出，如下所示：

build/favicon.ico
build/index.html
build/asset-manifest.json
build/static/css/**
build/static/js/**
build/manifest.json

当您像这样使用 go:embed 时，它会将内容作为 http://localhost:port/build/index.html 提供，这不是我们想要的。

//go:embed build/*
var static embed.FS

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

事实上，我们还需要再进一步使用 fs.Sub 使其按预期工作：

package main

import (
    "embed"
    "io/fs"
    "log"
    "net/http"
)

//go:embed build/*
var static embed.FS

func main() {
    contentStatic, _ := fs.Sub(static, "build")
    http.Handle("/", http.FileServer(http.FS(contentStatic)))
    log.Fatal(http.ListenAndServe("localhost:8080", nil))
}

现在，http://localhost:8080 应该按预期提供您的网络应用程序。

归功于Amit Mittal。

Answer 5

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

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

5 个答案:

嵌入文本文件

嵌入二进制文件

存储为字节切片

存储为base64 `string`

存储为引用`string`

捆绑 React 应用程序

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

5 个答案:

嵌入文本文件

嵌入二进制文件

存储为字节切片

存储为base64 string

存储为引用string

捆绑 React 应用程序

存储为base64 `string`

存储为引用`string`