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

s8vozzvw  于 12个月前  发布在  Go
关注(0)|答案(5)|浏览(82)

我正在用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

5条答案

按热度按时间
dsf9zpds

dsf9zpds1#

从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 = `
<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。这可以由第三方工具/库（如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

存储二进制数据的 quoted 字符串字面量比存储为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:;<=>?"
(Note 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:;<=>?")
赞(0）分享  回复(0）举报  12个月前
qybjjes1

qybjjes12#

go-bindata包看起来可能是您感兴趣的。
https://github.com/go-bindata/go-bindata
它将允许您将任何静态文件转换为可以嵌入到代码中的函数调用，并在调用时返回文件内容的字节切片。

赞(0）分享  回复(0）举报  12个月前
kgsdhlau

kgsdhlau3#

Bundle 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应用程序提供服务了。
信用卡Amit Mittal

  • 注意：go:embed需要go 1.16或更高版本。*
赞(0）分享  回复(0）举报  12个月前
qgzx9mmu

qgzx9mmu4#

还有一些奇特的方法-我使用maven plugin来构建GoLang项目，它允许使用JCP preprocessor将二进制块和文本文件嵌入到源代码中。

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

字符串

赞(0）分享  回复(0）举报  12个月前
von4xj4u

von4xj4u5#

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

赞(0）分享  回复(0）举报  12个月前
我来回答

相关问题

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新问答

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com