121

我正在使用 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 索引它们并照此提供它们。

如果没有好的方法可以做到这一点,或者我试图这样做是在吠叫错误的树,请告诉我。我只是认为最终用户会希望管理尽可能少的文件。

如果有比更合适的标签,请随时添加它们或让我知道。

4

5 回答 5

85

从 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/base64Go 在包中对 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:;<=>?")
于 2015-01-21T15:51:02.997 回答
80

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

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

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

于 2012-12-16T19:01:26.887 回答
7

捆绑 React 应用程序

例如,您有一个来自 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不是我们想要的内容(意外/build)。

//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应该按预期为您的 Web 应用程序提供服务。

归功于阿米特米塔尔

注意:go:embed需要 1.16 或更高版本。

于 2021-04-22T07:21:12.980 回答
2

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

var imageArray = []uint8{/*$binfile("./image.png","uint8[]")$*/}
于 2017-02-14T06:23:39.670 回答
1

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

于 2018-08-24T08:21:04.287 回答