【Golang】Golang使用embed加载、打包静态资源文件

【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模板，css，js和图片以及静态资源的路径一起上传到生产服务器。必须正确配置Web服务器，以便用户访问它。

现在，我们将所有这些资源都嵌入到程序中。我们只需要部署一个二进制文件并为程序本身配置它们即可。部署过程已大大简化!

常用场景

以下列举一些静态资源文件需要被嵌入到程序中的常用场景：

• Go模板：模板文件必须可用于二进制文件（模板文件需要对二进制文件可用）。 对于Web服务器二进制文件或那些通过提供init命令的CLI应用程序，这是一个相当常见的用例。 在没有嵌入的情况下，模板通常内联在代码中。例如示例qbec init的init命令。
• 静态web服务：有时，静态文件（如index.html或其他HTML，JavaScript和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 main

import (
	_ "embed" //导入` "embed"`包，即使`无显式的使用`
	"fmt"
)

//go:embed hello.txt
var data string

func main() {
   
   
	fmt.Println(data