Go之embed指令嵌入静态文件到二进制包
原创
go 1.16开始提供了embed指令 , 可以将静态资源嵌入到编译包里面
这样就可以把网页模板等文件直接打包了,就不需要每次还要拷贝静态文件
常规用法:
import _ "embed"
//go:embed hello.txt
var s string
func main() {
print(s)
}作为一个文件路径,也支持多个,以及通配符
//go:embed hello1.txt hello2.txt
var f embed.FS
func main() {
data1, _ := f.ReadFile("hello1.txt")
fmt.Println(string(data1))
data2, _ := f.ReadFile("hello2.txt")
fmt.Println(string(data2))
}但是
路径里面不能包含 . .. 这种相对路径的符号否则报错 , 也不能以/ 开头
这就意味着 , 如果模板文件在单独的目录里 , 那么需要有个go的包以及go文件对外提供全局变量
类似我这样
package static
import "embed"
//go:embed templates/*
var TemplatesEmbed embed.FS
//go:embed js/*
var JsEmbed embed.FS如果与gin的模板渲染配合使用
templ := template.Must(template.New("").ParseFS(static.TemplatesEmbed,"templates/*.html"))
engine.SetHTMLTemplate(templ)渲染模板的时候就可以直接来 , 模板的路径是在 ./static/templates/index.html
c.HTML(http.StatusOK, "index.html", gin.H{
"Title": title,
})
embed FS 的语法规则
- 使用通配符 //go:embed image/*
- 多行定义 //go:embed
- 同行定义多资源文件，可直接引入文件夹（包含文件夹中的文件） //go:embed image resources/test.html
例1：
import (
"embed"
"fmt"
)
//go:embed resources/hello.txt resources/index.gohtml
//go:embed resources/test.html resources/test.css
var multi embed.FS
func tEmbedMulti() {
dirEntry, err := multi.ReadDir("resources")
if err != nil {
fmt.Println(err)
return
}
for _, entry := range dirEntry {
fmt.Println(entry.Name())
}
}输出：
hello.txt
index.gohtml
test.css
test.html
例2：
import (
"embed"
"fmt"
)
// go:embed image/* 可替换下方的 go:embed
//go:embed image
var multi embed.FS
func tEmbedMulti() {
dirEntry, err := multi.ReadDir("image")
if err != nil {
fmt.Println(err)
return
}
for _, entry := range dirEntry {
fmt.Println(entry.Name())
}
}输出：
404.jpg
go.jpg
注意
- 使用 //go:embed 的时候，一定要引入 embed 包，可以使用 _ 来引入(import _"embed")，不然会报错：//go:embed only allowed in Go files that import "embed"
- // 和 go:embed 之间不能有空格， // go:embed 这种写法是不能解析的。
- //go:embed 指令只能用在包一级的变量中，不能用在函数或方法级别。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。
原创声明：本文系作者授权腾讯云开发者社区发表，未经许可，不得转载。
如有侵权，请联系 cloudcommunity@tencent.com 删除。
评论
登录后参与评论
推荐阅读
目录