0x01 写在前面
笔者在初次使用 viper 作为项目的配置管理时,遇到了不管如何反序列化出来的 struct 都为空的情况。经过一番查找与试错,现将解决办法列于下文。
0x02 解决办法
首先贴上我的代码
var v *viper.Viper = viper.New() var cfg Config type ServerCfg struct { Port int `yaml:"port"` } type Database struct { User string `yaml:"user"` Passwd string `yaml:"passwd"` Addr string `yaml:"addr"` Net string `yaml:"net"` DBName string `yaml:"dbname"` AllowNativePasswords bool `yaml:"allownativepasswords"` } type Config struct { ServerCfg ServerCfg `yaml:"server"` DatabaseCfg Database `yaml:"database"` } func init() { addConfigPath() err := v.ReadInConfig() if err != nil { panic(fmt.Errorf("fatal error config file: %s", err)) } v.WatchConfig() v.OnConfigChange(func(in fsnotify.Event) { // TODO 当配置文件发生变化之后进行处理 fmt.Printf("there is something has changed!: %s ", in.Name) }) err = v.Unmarshal(&cfg) if err != nil { panic(fmt.Errorf("unmarshal error %v", err.Error())) } } // 添加所有的路径 func addConfigPath() { v.SetConfigFile("./config/config.yml") v.AddConfigPath(".") }
server: port: 3000 database: user: "homestead" passwd: "secret" addr: "127.0.0.1:3306" net: "tcp" dbname: "goblog" allownativepasswords: true
如上代码,反序列化出来的 struct 一定是空的。至于原因则是 viper 在处理多层级(单层不需要额外处理),如上文中的 server 与 database 这中结构时,需要使用 mapstructure 指定需要读取的配置项,这样才能正确的读取。修改如下:
config.go ...... type Config struct { ServerCfg ServerCfg `yaml:"server" mapstructure:"server"` DatabaseCfg Database `yaml:"database" mapstructure:"database"` } ......
0x03 写在后边
关于 viper 的用法可参见如下两篇文章:
- [viper README 中文](Go语言配置管理神器——Viper中文教程 - 知乎 (zhihu.com))
- [Go 配置管理库 Viper 怎么读取结构体嵌套的配置信息](Go 配置管理库 Viper 怎么读取结构体嵌套的配置信息?-腾讯云开发者社区-腾讯云 (tencent.com))