滁州网站建设哪个好点,iis发布网站无法访问,北京平台网站建设费用,天河做网站哪家好【Golang】Golang使用embed加载、打包静态资源文件 大家好 我是寸铁#x1f44a; 总结了一篇Golang使用embed加载静态资源文件的文章✨ 喜欢的小伙伴可以点点关注 #x1f49d; 前言
事情是这样的#xff1a;前不久#xff0c;有同学问我,golang怎么把静态资源文件打包成一…【Golang】Golang使用embed加载、打包静态资源文件 大家好 我是寸铁 总结了一篇Golang使用embed加载静态资源文件的文章✨ 喜欢的小伙伴可以点点关注 前言
事情是这样的前不久有同学问我,golang怎么把静态资源文件打包成一个可执行文件呢便于后序服务器资源的部署 经本人同意授权图像码掉。
这不今天这个问题的答案就来啦
背景
Go编译的程序非常适合部署如果没有通过CGO引用其它的库的话我们一般编译出来的可执行二进制文件都是单个的文件非常适合复制和部署。在实际使用中除了二进制文件可能还需要一些配置文件或者静态文件比如html模板、静态的图片、CSS、javascript等文件如何这些文件也能嵌入到二进制文件中那就太美妙我们只需复制、执行单个的可执行文件即可。
一些开源的项目很久以前就开始做这方面的工作比如gobuffalo/packr、markbates/pkger、rakyll/statik、knadh/stuffbin等等但是不管怎么说这些都是第三方提供的功能如果Go官方能内建支持就好了。2019末一个提案被提出issue#35950,期望Go官方编译器支持嵌入静态文件。后来Russ Cox专门写了一个设计文档Go command support for embedded static assets, 并最终实现了它。 应用场景 为什么需要embed包? 部署过程更简单。传统部署要么需要将静态资源与已编译程序打包在一起上传或者使用docker和dockerfile自动化前者这在精神上是很麻烦的。确保程序的完整性。在运行过程中损坏或丢失静态资源通常会影响程序的正常运行。独立控制程序所需的静态资源。
最常见的方法例如静态网站的后端程序要求将程序连同其所依赖的html模板cssjs和图片以及静态资源的路径一起上传到生产服务器。必须正确配置Web服务器以便用户访问它。
现在我们将所有这些资源都嵌入到程序中。我们只需要部署一个二进制文件并为程序本身配置它们即可。部署过程已大大简化!
常用场景
以下列举一些静态资源文件需要被嵌入到程序中的常用场景
Go模板模板文件必须可用于二进制文件模板文件需要对二进制文件可用。 对于Web服务器二进制文件或那些通过提供init命令的CLI应用程序这是一个相当常见的用例。 在没有嵌入的情况下模板通常内联在代码中。例如示例qbec init的init命令。静态web服务有时静态文件如index.html或其他HTMLJavaScript和CSS文件之类的静态文件需要使用golang服务器二进制文件进行传输以便用户可以运行服务器并访问这些文件。例如示例web server中嵌入静态资源文件数据库迁移另一个使用场景是通过嵌入文件被用于数据库迁移脚本。参考示例数据库迁移文件
定义 embed是在Go 1.16中新加包。它通过//go:embed指令可以在编译阶段将静态资源文件打包进编译好的程序(exe)中并提供访问这些文件的能力。 嵌入
对于单个的文件支持嵌入类型为string和 byte slice对于多个文件和文件夹支持嵌入为新的文件系统FS比如导入 embed包即使无显式的使用go:embed指令用来嵌入必须紧跟着嵌入后的变量名只支持嵌入为string, byte slice和embed.FS三种类型这三种类型的别名(alias)和命名类型(如type S string)都不可以! 同学们暂时看不懂别着急,后面会逐个对上面的特性进行使用 语法说明
go:embed指令用来嵌入必须紧跟着嵌入后的变量名
//go:embed 要嵌入的文件如下图片说明
把hello.txt文件嵌入到data这个字符串变量 导入 embed包即使无显式的使用
基本使用
嵌入字符串
对于单个的文件支持嵌入类型为string和 byte slice
先编写hello.txt文件文件内容可以自定义用于后面的各种操作。 demo
编写demo用于测试能否嵌入字符串demo如下
package mainimport (_ embed //导入 embed包即使无显式的使用fmt
)//go:embed hello.txt
var data stringfunc main() {fmt.Println(data)
}运行demo 如上图可以打印出嵌入文件的字符串变量的内容 这样就实现把一个txt文件嵌入到字符串变量啦
是不是很简单后面还有更强大的功能继续往下走 接着我们使用go build一键生成可执行文件(exe) 生成后,会在文件夹中出现如下exe文件 这时我们可以不妨大胆把原来要嵌入的文件hello.txt给重命名或者直接删掉看看能不能通过执行exe文件输出原来嵌入的文件的内容
使用重命名 使用删除 控制台输入如下命令:
.\embed.exe运行结果如下 可以发现删除或者重命名文件后仍然可以通过去执行生成的二进制文件去输出原来嵌入文件的内容 这就是嵌入功能的强大之处 嵌入byte slice
对于单个的文件支持嵌入类型为string和 byte slice
将上面data的数据类型改为[]byte即可 demo
package mainimport (_ embedfmt
)//go:embed hello.txt
var data []bytefunc main() {//将字节数组string化,输出字节数组的内容。fmt.Println(string(data))
}测试一下能否输出文件的内容
执行结果如下 再测试一下运行生成的可执行文件结果如下 可以发现照常可以输出原来嵌入文件的内容 嵌入文件系统FS
对于多个文件和文件夹支持嵌入为新的文件系统FS
使用embed.FS嵌入的文件变量,具有3种功能如下所示 嵌入一个文件
package mainimport (embed_ embedfmt
)//go:embed hello.txt
var data embed.FS //嵌入文件系统func main() {//data嵌入了一个文件系统,文件系统中有一个文件叫hello.txt//使用ReadFile读取这个文件的内容read, err : data.ReadFile(hello.txt)//输出内容fmt.Println(string(read), err)
}运行结果如下: 再测试一下运行生成的可执行文件结果如下 可以发现照常可以输出原来嵌入文件的内容 嵌入多个文件
编写另一个文件的内容如下 嵌入多个文件很简单只需要在后面添加文件即可。
//go:embed hello.txt hello1.txt
var data embed.FSdemo
package mainimport (embed_ embedfmt
)//go:embed hello.txt hello1.txt
var data embed.FSfunc main() {read, err : data.ReadFile(hello.txt)fmt.Println(string(read), err)read1, err : data.ReadFile(hello1.txt)fmt.Println(string(read1), err)
}
执行结果如下 再测试一下运行生成的可执行文件结果如下 嵌入一个文件夹 创建一个文件夹dir 再把之前的文件给转移到上面去。 demo
打印文件的名字
Info()的结构体信息如下
// FileInfo 接口描述了一个文件由 Stat 方法返回。
type FileInfo interface {Name() string // 文件的基本名称Size() int64 // 对于普通文件以字节为单位的长度对于其他文件类型取决于系统Mode() FileMode // 文件的模式位ModTime() time.Time // 修改时间IsDir() bool // 是否为目录的简写等同于 Mode().IsDir()Sys() any // 底层数据源可能返回 nil
}打印一下文件的名字
package mainimport (embed_ embedfmt
)//go:embed dir
var data embed.FSfunc main() {//读取文件夹dirdir, _ : data.ReadDir(dir)//entry为遍历dir文件夹中的每个文件for _, entry : range dir {info, _ : entry.Info() // 获取文件的信息fmt.Println(info.Name()) // 获取文件中的名字}
}运行结果如下 获取文件的内容
package mainimport (embed_ embedfmtpath
)//go:embed dir
var data embed.FSfunc main() {//读取文件夹dirdir, _ : data.ReadDir(dir)//entry为遍历dir文件夹中的每个文件for _, entry : range dir {info, _ : entry.Info() // 获取文件的信息//使用data的ReadFile方法打开文件//使用path.Join拼接文件的路径file, err : data.ReadFile(path.Join(dir, info.Name()))//输出内容fmt.Println(string(file), err)}
}
运行结果如下 注意事项
go embed的使用只能用于包级别声明的变量(全局变量) 不能放在方法中 结语
Go语言中的embed包是在Go 1.16版本中引入的用于将文件内容嵌入到Go程序中。 尽管embed提供了一种方便的方式来嵌入文件但它也有一些缺点 编译时间较长 当项目中嵌入的文件数量较多或文件较大时embed可能导致编译时间变长。每次修改嵌入的文件都需要重新构建整个程序。 不支持动态更新 由于嵌入的文件在编译时就被固定在可执行文件中因此无法在运行时动态更新嵌入的文件内容。如果需要在运行时更新文件可能需要使用其他方法如将文件存储在磁盘上并在需要时读取。 可执行文件大小增加 将文件嵌入到可执行文件中会增加可执行文件的大小。对于一些嵌入了大量或大型文件的应用程序这可能会导致可执行文件较大影响部署和传输时间。 不适用于所有场景 embed适用于将静态文件嵌入到程序中但不适用于所有场景。例如如果需要对配置文件进行频繁的写入和修改可能会选择将文件保存在独立的目录中。 总体而言embed是一个强大的工具特别适用于需要将资源文件打包到可执行文件中的情况。但在选择使用时需要权衡它的优点和缺点并根据项目的需求和约束进行选择 看到这里的小伙伴恭喜你又掌握了一个技能 希望大家能取得胜利坚持就是胜利 我是寸铁我们下期再见 往期好文
保姆级教程
【保姆级教程】Windows11下go-zero的etcd安装与初步使用
【保姆级教程】Windows11安装go-zero代码生成工具goctl、protoc、go-zero
【Go-Zero】手把手带你在goland中创建api文件并设置高亮 报错解决
【Go-Zero】Error: user.api 27:9 syntax error: expected ‘:‘ | ‘IDENT‘ | ‘INT‘, got ‘(‘ 报错解决方案及api路由注意事项
【Go-Zero】Error: only one service expected goctl一键转换生成rpc服务错误解决方案
【Go-Zero】【error】 failed to initialize database, got error Error 1045 (28000):报错解决方案
【Go-Zero】Error 1045 (28000): Access denied for user ‘root‘‘localhost‘ (using password: YES)报错解决方案
【Go-Zero】type mismatch for field “Auth.AccessSecret“, expect “string“, actual “number“报错解决方案
【Go-Zero】Error: user.api 30:2 syntax error: expected ‘)‘ | ‘KEY‘, got ‘IDENT‘报错解决方案
【Go-Zero】Windows启动rpc服务报错panic:context deadline exceeded解决方案 Go面试向
【Go面试向】defer与time.sleep初探
【Go面试向】defer与return的执行顺序初探
【Go面试向】Go程序的执行顺序
【Go面试向】rune和byte类型的认识与使用
【Go面试向】实现map稳定的有序遍历的方式
