使用 Go Embed
go:embed 功能简化了在 Go 应用程序中嵌入静态资源的过程。通过在编译时将文件和目录嵌入到程序中，您可以创建自包含的二进制文件，避免了对外部文件的依赖。这个特性特别适用于需要嵌入静态资源的 Web 应用程序或命令行工具。
什么是 go:embed？
go:embed 是 Go 1.16 引入的新特性，用于在编译时将文件或目录嵌入到 Go 的二进制文件中。这样做可以使应用程序直接从内存访问这些资源，避免在运行时从磁盘读取的需求。这在构建便携式的自包含二进制文件时非常有用。
示例：嵌入单个文件
首先，创建一个 message.txt 文件，内容如下：
hello from bytesizego!
在 main.go 文件中编写以下代码：
package main
import (
_ "embed"
"fmt"
)
//go:embed message.txt
var message string
func main() {
fmt.Println(message)
}
程序运行后输出：
hello from bytesizego!
嵌入多个文件
如果需要嵌入多个文件，可以使用 embed.FS 来处理。例如，将多个文件放在 messages/ 目录中：
package main
import (
"embed"
"fmt"
)
//go:embed messages/*
var messages embed.FS
func main() {
files, _ := messages.ReadDir("messages")
for _, file := range files {
data, _ := messages.ReadFile("messages/" + file.Name())
fmt.Printf("File: %s\nContent: %s\n\n", file.Name(), string(data))
}
}
通过 ReadDir 和 ReadFile 方法，您可以与嵌入的文件进行交互。
嵌入目录
您还可以嵌入整个目录。在下面的例子中，我们嵌入了 static/ 目录下的文件：
package main
import (
"embed"
"fmt"
)
//go:embed static/*
var staticFiles embed.FS
func main() {
data, _ := staticFiles.ReadFile("static/index.html")
fmt.Println(string(data))
}
注意：嵌入的路径是相对于 go:embed 指定的根目录的。
创建 Web 应用
go:embed 可以非常方便地嵌入静态文件，并用于创建 Web 服务器。
package main
import (
"embed"
"net/http"
)
//go:embed static/*
var staticFiles embed.FS
func main() {
http.Handle("/", http.FileServer(http.FS(staticFiles)))
http.ListenAndServe(":8080", nil)
}
运行程序后，您可以通过浏览器访问 http://localhost:8080 来查看嵌入的静态文件。
将文件嵌入到结构体中
如果需要在程序中组织嵌入的内容，可以将它们嵌入到结构体中。下面的例子将两个 HTML 模板嵌入到结构体中：
package main
import (
"embed"
"fmt"
)
//go:embed templates/home.html
var homeTemplate string
//go:embed templates/about.html
var aboutTemplate string
type Templates struct {
Home string
About string
}
func main() {
t := Templates{
Home: homeTemplate,
About: aboutTemplate,
}
fmt.Println("Home Template:", t.Home)
fmt.Println("About Template:", t.About)
}
嵌入图像和 PDF 文件
对于非文本文件（如图像或 PDF 文件），可以使用字节切片来存储：
package main
import (
_ "embed"
"fmt"
)
//go:embed image.jpg
var imageData []byte
func main() {
fmt.Printf("Image size: %d bytes\n", len(imageData))
}
此方法适用于嵌入任何二进制文件。不过，嵌入较大的文件时要注意文件大小的影响。
使用 go:embed 的注意事项
- 文件大小：嵌入大文件会显著增加最终的二进制文件大小。
- 文件修改：对嵌入的文件进行修改后，您需要重新编译程序。
总结
go:embed 是一个强大且简洁的工具，适用于构建自包含的 Go 应用程序。它可以极大地简化静态资源的管理，尤其是在构建 Web 应用或需要嵌入配置文件的命令行工具时。
主要特点：
- 简单的语法：通过注释
//go:embed指定要嵌入的文件或目录。 - 更加自包含的二进制文件：无需额外的外部文件依赖，资源直接打包在二进制文件中。
- 支持嵌入文本文件、二进制文件以及整个目录。
利用 go:embed，您可以构建出更加高效和便携的 Go 应用。