Go打包附件内容到执行文件

前言

如果我们的应用在启动的时候需要对数据库进行初始化(比如建表等), 可以通过读取.sql文件内容直接执行. 但是, 这样会带出一个问题:

• 在发送可执行文件的时候, 需要连带着附件文件, 并且相对路径还不能出错. 这样太麻烦了
• 有时我们并不希望附件的内容被使用者看到

处于种种原因, 我们不希望这部分额外的内容以附件的形式出现, 有没有什么办法能够将附件内容直接打包进可执行文件中呢?

打包方法

直接在文件中定义

最容易想到的, 就是直接在.go文件中定义字符串, 比如这样:

var text = `xxx`

如此处理必然是可以的, 但有些不方便.

1. .sql文件可能是通过mysqldump导出的, 每次导出之后还需要将内容复制到.go文件中
2. 在编辑.sql文件的时候, IDE会提供语法高亮及输入提示, 这些在字符串中都是没有的

通过工具转换

既然我们想要将内容直接放在文件中, 同时又想将内容打包到二进制中. 是否可以通过脚本处理呢? 脚本从附件中读取内容, 并写入到.go文件中.

有一个名为go-bindata 的工具, 做的就是这样的事情. 具体操作可自行搜索, 这里不做赘述.

但是这个工具在3年前就不再更新了, 为什么呢? 因为官方支持了.

go build

或许是因为这样的呼声太大, 在go 1.16版本开始, 官方增加了embed包对这种操作进行了支持, 可以在编译阶段直接将静态资源打包到二进制中.

其大致用法如下:

import "embed"

// 将内容直接打包到二进制文件中
//go:embed test.txt
var test string

//go:embed test.txt
var test1 []byte

// 同时打包多个文件. 后接文件名或目录
//go:embed test.txt dir
// 作为文件
var test2 embed.FS

func main() {
	// 输出文件内容
	println(test)
	println(string(test1))
	
	b, err := test2.ReadFile("test.txt")
	if err != nil {
		panic(err)
	}
	println(string(b))
}

其中string/[]byte用来打包单个文件, embed.FS可以打包一批文件. 使用也比较简单, 看下文档就行了.

至此, Go程序已经可以天然且方便的将资源文件进行打包了.

总结

OK, 现在已经完美解决了我们最开始的问题, 以后在项目中遇到类似的需求, 可以直接使用啦.

至于其他语言, 比如PHP/Python等, 本来就是一堆源文件, 不会打包成二进制, 应该也不会有这种需求吧.