在go-nunu项目中跨包读取配置文件的两种方法

在基于go-nunu框架开发项目时，我们经常需要在不同的包中访问配置文件内容。本文将详细介绍两种在go-nunu项目中实现跨包读取配置的优雅解决方案。

问题背景

在go-nunu项目中，我们通常使用Viper库来管理配置文件。当我们在主包中使用conf.GetString("tencent.ak")这样的方式读取配置时，一切都很简单。但当我们想在工具类或其他包中访问这些配置值时，就会遇到访问权限问题，因为conf变量在其他包中不可见。

解决方案一：参数传递（推荐）

这是首选的解决方案，因为它遵循了良好的软件设计原则：

1. 显式依赖：通过参数传递配置，使得包的依赖关系更加清晰
2. 可测试性：更容易进行单元测试，可以传入模拟配置
3. 松耦合：包不直接依赖全局状态，降低了耦合度

实现方式很简单，只需要在调用工具类方法时，将配置对象作为参数传入：

// 在主包中
tool.DoSomething(conf)

// 在工具包中
func DoSomething(conf *viper.Viper) {
    ak := conf.GetString("tencent.ak")
    // 使用配置...
}

解决方案二：全局配置变量

当参数传递不太方便时，可以使用全局变量方式：

1. 修改/pkg/config/config.go文件
2. 添加一个导出的全局变量
3. 在初始化配置时设置这个变量

具体实现：

// 在pkg/config/config.go中
var Config *viper.Viper // 导出的全局配置变量

func NewConfig(p string) *viper.Viper {
    envConf := os.Getenv("APP_CONF")
    if envConf == "" {
        envConf = p
    }
    fmt.Println("load conf file:", envConf)
    return getConfig(envConf)
}

func getConfig(path string) *viper.Viper {
    conf := viper.New()
    conf.SetConfigFile(path)
    err := conf.ReadInConfig()
    if err != nil {
        panic(err)
    }
    Config = conf // 设置全局变量
    return conf
}

使用时，在其他包中可以直接引用：

import "your_project/pkg/config"

ak := config.Config.GetString("tencent.ak")

两种方案的比较

方案	优点	缺点
参数传递	依赖明确、易于测试、松耦合	需要修改调用链
全局变量	使用方便、无需修改调用链	隐藏依赖、难以测试、紧耦合

最佳实践建议

1. 优先使用参数传递：特别是对于业务逻辑代码
2. 谨慎使用全局变量：可以用于工具类、基础设施代码
3. 考虑使用依赖注入：在大型项目中，可以考虑使用wire等依赖注入工具
4. 配置接口化：可以定义配置接口，而不是直接暴露Viper对象

通过合理选择这两种方案，可以在go-nunu项目中优雅地实现跨包配置访问，同时保持代码的清晰和可维护性。