embed简介

go embed 是 Go 1.16 中引入的特性，它允许将文件嵌入到 Go 代码中，以便在运行时访问这些文件。这对于将静态资源（如 HTML、CSS、JavaScript 文件）直接嵌入到 Go 二进制文件中，以及简化文件分发和部署非常有用。下面是关于 go embed 的详细介绍：

使用方式：

go embed 支持将文件嵌入到代码中的两种方式：

1. 嵌入单个文件：

   package main
   
   import (
       _ "embed"
       "fmt"
   )
   
   //go:embed myfile.txt
   var content string
   
   func main() {
       fmt.Println(content)
   }
   

2. 嵌入多个文件：

   package main
   
   import (
       _ "embed"
       "fmt"
   )
   
   //go:embed file1.txt file2.txt
   var content string
   
   func main() {
       fmt.Println(content)
   }
   

使用步骤：

1. 导入 _ "embed" 包，这样 embed 包就会被初始化。
2. 在变量声明前使用 //go:embed 注释，指定要嵌入的文件。你可以指定单个文件，也可以指定多个文件，用空格分隔。

访问嵌入文件：

使用 embed 包嵌入的文件是一个 string 、 []byte 或 embed.FS 类型的变量，你可以直接在代码中访问它们。在运行时，这些变量会被初始化为嵌入文件的内容。

用途：

• 将静态资源嵌入到 Go 二进制文件中，以便简化部署。
• 将配置文件或其他数据文件嵌入到应用程序中，无需外部文件依赖。
• 减少文件的分发和管理成本。

注意事项：

• 嵌入的文件内容会在编译时打包到二进制文件中，因此可能会增加二进制文件的大小。
• 嵌入的文件内容是只读的，无法在运行时修改。
• 嵌入文件的大小应适度，避免过大导致二进制文件过大。
• //go:embed 指令只能用于全局变量，不能用于函数内的局部变量。同时，它只能嵌入在 Go 源代码文件同一目录或子目录下的文件或目录。

总之，go embed 是一个强大的特性，使得在 Go 代码中嵌入文件变得更加方便和简单，特别是在需要将静态资源或配置文件包含在应用程序中时。

---

声明：本作品采用署名-非商业性使用-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)进行许可，使用时请注明出处。

Author: mengbin

blog: mengbin

Github: mengbin92

cnblogs: 恋水无意

---