如何从远程Go包中获取data.yml文件？

Go的go mod vendor默认只管理Go源码文件，静态资源文件（比如你的data.yml）不会被自动包含到依赖包中。最优雅且简单的解决方式是让存放data.yml的repoA把文件嵌入到Go代码里，这样repoB导入包后就能直接访问。

步骤1：在repoA中嵌入data.yml #

在github.com/abc-company/repoA/package-with-data包下新建一个data.go文件，内容如下：

package packagewithdata // 这里要和包的实际名称一致

import _ "embed"

//go:embed data.yml
var DataYML []byte // 如果需要字符串格式，也可以定义为string类型

这个//go:embed是Go 1.16及以上版本支持的特性，会在编译时把data.yml的内容直接打包进Go二进制文件里，变成一个可直接访问的变量。

提交并推送这个data.go文件到repoA的远程仓库。

步骤2：在repoB中使用嵌入的YAML数据 #

1. 先更新repoB对repoA的依赖：

   go get github.com/abc-company/repoA/package-with-data@latest
   

2. 在functions.go中直接导入包并使用DataYML变量：

   import (
       "github.com/abc-company/repoA/package-with-data"
       "gopkg.in/yaml.v3"
   )
   
   // 假设你有对应的结构体来解析YAML内容
   type YourDataStruct struct {
       // 定义和data.yml对应的字段
       Key1 string `yaml:"key1"`
       Key2 int    `yaml:"key2"`
   }
   
   func YourFunction() {
       var data YourDataStruct
       // 解析嵌入的YAML数据
       if err := yaml.Unmarshal(packagewithdata.DataYML, &data); err != nil {
           // 处理错误
           panic(err)
       }
       // 现在可以使用解析后的data变量了
   }
   

如果之前没引入yaml包，先执行go get gopkg.in/yaml.v3安装依赖。

为什么这个方案合适？ #

• 不用复制粘贴文件，完全依赖Go的模块管理机制同步数据
• repoA更新data.yml后，repoB只要拉取最新版本的依赖就能拿到最新数据
• 实现简单，符合Go的官方最佳实践

内容的提问来源于stack exchange，提问作者dezdichado