go embed失效不生效的问题(embed使用注意事项)

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容