环境:
go v1.15
为什么需要将资源嵌入到可执行文件
举例说明
- 嵌入web前端资源, 如js/css/html, 用于将包含了web页面的项目通过一个go可执行文件发布出去, 使用者不需要额外管理这些静态文件. Drone既如此.
- 嵌入template模板文件, 还是为了发布简单, 不再需要将tpl文件复制到服务器.
如何嵌入资源到Go可执行文件
翻阅 Awesome Go#resource-embedding
笔者只尝试了两个包: go rice 与 statik, 下面简单的讲解它们的使用方法.
go rice
https://github.com/GeertJohan/go.rice
#0. 安装rice
go get github.com/GeertJohan/go.rice/rice
#1. 导出资源为go文件
编写main.go文件
package main
import (
rice "github.com/GeertJohan/go.rice"
)
func init() {
_, _ = rice.FindBox("./public") # 替换为你的静态资源文件夹
}
在此文件夹下运行rice提供的命令
rice embed-go
将在当前文件夹下生成一个文件: rice-box.go
#2. 使用内嵌的资源
你需要引入这个文件, 比如将这个文件复制到你的另一个项目中, 或者 import 它.
只要引入了生成的文件, 项目中就能通过rice包提供的API访问到内嵌的资源.
box, _ := rice.FindBox("./public")
bs, err := box.Bytes("test.txt")
或者直接使用HTTP包提供静态资源服务:
http.Handle("/", http.FileServer(rice.MustFindBox("./public").HTTPBox()))
http.ListenAndServe(":8080", nil)
QA
为什么rice会这样设计?
你会注意到, 如果要使用 rice embed-go 命令, 那么当前文件夹下必须得有一个go文件, 并且此文件中需要调用 rice.FindBox或者 rice.MustFindBox 方法.
这是因为rice支持3个资源来源, 并有以下优先级
Order of precedence
When opening a new box, the rice.FindBox(..) tries to locate the resources in the following order:
- embedded (generated as rice-box.go)
- appended (appended to the binary executable after compiling)
- 'live' from filesystem
需要注意的是它支持 'live' from filesystem, 这表示当你没使用rice embed-go命令生成内嵌资源时, rice会使用本地资源, 并且是实时的, 这在开发时十分方便. 假如你在编写一个html文件, 有了这个特性, 你就可以一边修改这个html文件, 一边刷新浏览器就能拿到最新的内容, 而不需要重启go服务.
statik
https://github.com/rakyll/statik
#0. 安装 statik
go get github.com/rakyll/statik/fs
#1. 导出资源为go文件
statik -src=/path/to/your/project/public
它会在当前目录下生成一个包 statik, 包里有statik.go文件.
#2. 使用内嵌的资源
首先记得需要引入 statik 生成的包
import (
"github.com/rakyll/statik/fs"
_ "./statik" // TODO: Replace with the absolute import path
)
访问内嵌的资源.
statikFS, err := fs.New()
if err != nil {
log.Fatal(err)
}
// Access individual files by their paths.
r, err := statikFS.Open("/hello.txt")
if err != nil {
log.Fatal(err)
}
defer r.Close()
contents, err := ioutil.ReadAll(r)
if err != nil {
log.Fatal(err)
}
fmt.Println(string(contents))
或者直接使用HTTP包提供静态资源服务:
statikFS, err := fs.New()
if err != nil {
log.Fatal(err)
}
// Serve the contents over HTTP.
http.Handle("/public/", http.StripPrefix("/public/", http.FileServer(statikFS)))
http.ListenAndServe(":8080", nil)
对比rice与statik
相比rice, statik更加直观/简单. 它只有一个一个功能: 将静态资源打包为go文件, 而没有 rice 的 'live' from filesystem 功能.
如果你没有在开发环境访问静态文件的需求, 可能使用statik更简单.
更值得一提的是, rice 没有压缩资源, 这会导致它打包出的go运行文件会更大一些, 而statik默认压缩了资源. (对于一个9M的编译之后的Vue前端项目, 使用rice会使你的运行文件增大9M, 而使用statik只会增大5M左右)
疑难杂症
如何使用Gin + rice/statik 提供静态资源服务?
如果想通过固定的前缀访问静态资源
只需要使用到 route.StaticFS() 方法
g := gin.Default()
g.StaticFS("/static", rice.MustFindBox("./public").HTTPBox())
如果想在根目录提供静态资源服务
这种情况就会麻烦一点, 这是因为 route.StaticFs() 不是为此而设计的, 因此需要用到中间件实现.
参考 github.com/gin-contrib/static 编写方法:
type embeddingFileSystem struct {
fs http.FileSystem
}
func (b *embeddingFileSystem) Exists(c *gin.Context, prefix string, filepath string) bool {
if prefix == "" {
if _, err := b.fs.Open(filepath); err != nil {
return false
}
return true
} else {
if p := strings.TrimPrefix(filepath, prefix); len(p) < len(filepath) {
if _, err := b.fs.Open(p); err != nil {
return false
}
return true
}
}
return false
}
func EmbeddingFileSystem(fs http.FileSystem) *embeddingFileSystem {
return &embeddingFileSystem{
fs: fs,
}
}
func Serve(urlPrefix string, fs *embeddingFileSystem) gin.HandlerFunc {
fileserver := http.FileServer(fs.fs)
if urlPrefix != "" {
fileserver = http.StripPrefix(urlPrefix, fileserver)
}
return func(c *gin.Context) {
if fs.Exists(c, urlPrefix, c.Request.URL.Path) {
fileserver.ServeHTTP(c.Writer, c.Request)
c.Abort()
}
}
}
使用它
g := gin.Default()
fs := EmbeddingFileSystem(rice.MustFindBox("./public").HTTPBox())
g.Use(Serve("", fs))