embed是go1.16引入的库,允许我们编译的时候内嵌文件到go的二进制文件,
最典型的应用,就是web服务器把前端build的二进制文件打包到一个二进制文件。这样用起来就很方便。
还有就是把配置文件打包到二进制文件之类的。
golang很多官方推出的库,未必好用,功能也不是最全的。
比如zip压缩就不是很好用,还有就是文件匹配的glob,它不支持**
语法
这个embed就有一些问题
这次我碰到了embed失效的问题。
go这类注释来表示的指令我之前其实没用过,虽然知道go generate这个指令但是并没有用过。
embed之前我在内嵌html文件的时候用过,那时候发现的问题是,好像只能在根路径使用(因为我的web的目录在根路径),因为好像不支持父级的相对路径,这个就导致难用,因为我本来想把这个内嵌写在router包里面的。
但是现在发现embed似乎是支持父级相对路径的
只是下面的不会生效,会报错
//go:embed ../test.txt
但是路径分隔符用反斜杠就没问题了。
//go:embed ..\test.txt
还有这次我碰到的指令不生效的问题
是因为指令和注释最大的区别是, 指令是//go:
,也就是说不能有空格,有空格的会被当做注释处理。
也就是官方只是匹配//go:指令
这样的前缀来解析指令。
// go:embed ..\test.txt
还有一个注意点是
embed只在package级别生效,也就是说在函数内的注释是不管的。
其他解决方案
最近给项目写了github action,用于提交新版本tag的时候,自动发布新版本。
然后发现我的项目在linux下编译报错了。
虽然我在windows本地的时候编译没有问题,
这时我发现那个父级目录的用法,应该是有问题的,至少在linux下编译会失败。。。
然后我就翻了github的issue,没有找到很好的解决方案。
因为我把配置文件放在根目录,也就是和main文件在同一个目录。所以没有什么好的方法。
也不能从main中导入,那样会有循环依赖的问题。。。
最后我从go github issue中找到两种方法
go generate
这个方法给人感觉就比较蠢,总之就是把文件拷贝到同级目录就没事了。
简单粗暴的方法
//go:generate cp -r ../../assets ./local-asset-dir
//go:embed local-asset-dir
var assetFs embed.FS
创建一个package,把文件放到这个package目录中
其实和上面的方法是一样的,甚至某种程度上还不如。
上面的方法,至少还能自由选择文件的位置。
最后我选择这种方法,创建一个package,在其他包引入。这似乎就是官方推荐的方式了。
package conf
import (
_ "embed"
)
//go:embed rabc_modal.conf
var CasbinModalStr string
//go:embed policy.csv
var PolicyCSV string
//go:embed config.yaml
var DefaultConfig string
另外我还在issue里看到,希望把/
作为模块根目录,这样确实能解决这个问题,但是这个被官方拒绝了。 https://github.com/golang/go/issues/58525