Viper 是一个用于 Go 语言开发的配置处理库，它可以处理几乎所有格式的配置。Viper 支持：
- 设置默认值
- 读取 JSON、TOML、YAML、HCL、.env 和 .properties 配置文件
- 从环境变量、命令行和
io.Reader读取配置 - 从远程配置中心（例如 Consul）读取配置并监听修改
- 监听配置文件修改和自动重新加载配置
快速使用
安装：
$ go get github.com/spf13/viper
使用：
func TestViper(t *testing.T) {
viper.SetConfigName("config")
viper.SetConfigType("toml")
viper.AddConfigPath("./")
viper.SetDefault("mysql.host", "localhost")
viper.SetDefault("mysql.port", 3306)
if err := viper.ReadInConfig(); err != nil {
fmt.Println("read config error")
return
}
fmt.Printf("version:\t%v\n", viper.GetString("app_name"))
fmt.Printf("app_name:\t%v\n", viper.GetString("version"))
fmt.Printf("date:\t\t%v\n", viper.GetString("datetime"))
fmt.Printf("readonly:\t%v\n", viper.GetBool("readonly"))
}
配置文件 config.toml 如下
app_name = "daily-lib"
version = '1.1.2'
datetime = 2023-04-30T18:16:33
readonly = true
[mysql]
host = "127.0.0.1"
user = "root"
password = "123456"
timeout = "3s"
[server]
protocols = ["http", "https", "websocket"]
viper 使用需要设置文件名（SetConfigName）、设置文件类型（setConfigType）和搜索路径（AddConfigPath），然后调用 ReadInConfig 即可。
运行结果（已省略测试相关信息）
version: daily-lib
app_name: 1.1.2
date: 2023-04-30T18:16:33
readonly: true
有几点需要注意：
- 设置文件名时不要带后缀；
- 搜索路径可以设置多个，viper 会根据设置顺序依次查找；
- viper 获取值时使用
section.key的形式，即传入嵌套的键名； - 默认值可以通过
SetDefault方法设置。
读取键值
Get(key string) interface{}方法：根据名称返回键值，返回值是接口类型GetType(key string) Type：可以返回Type类型的值，Type可以是Bool/Float64/Int/String/Time/Duration/IntSlice/StringSlice。但是请注意，如果指定的键不存在或类型不正确，GetType方法返回对应类型的零值。
判断键是否存在可以使用 isSet 方法。另外，GetStringMap 和 GetStringMapString 直接以 map 返回某个键下面所有的键值对，前者返回 map[string]interface{}，后者返回map[string]string。 AllSettings 以 map[string]interface{} 的形式返回所有键值对。
fmt.Println("timeout:", viper.GetDuration("mysql.timeout"))
fmt.Println("server protocols:", viper.GetStringSlice("server.protocols"))
fmt.Println("mysql host exist:", viper.IsSet("mysql.port"))
fmt.Println("mysql:", viper.GetStringMapString("mysql"))
fmt.Println("all settings:", viper.AllSettings())
运行结果：
timeout: 3s
server protocols: [http https websocket]
mysql host exist: true
mysql: map[host:127.0.0.1 password:123456 timeout:3s user:root]
all settings: map[app_name:daily-lib date:2023-04-30 mysql:map[host:127.0.0.1 password:123456 port:3306 timeout:3s user:root] readonly:true server:map[protocols:[http https websocket]] version:1.1.2]
对于 getDuration 方法，只要是 time.ParseDuration 接受的格式都可以
设置键值
viper 支持在多个地方设置，使用下面的顺序依次读取：
- 调用
Set显示设置的； - 命令行选项；
- 环境变量；
- 配置文件；
- 默认值。
viper.Set
如果某个键通过viper.Set设置了值，那么这个值的优先级最高。
viper.Set("redis.port", 5381)
如果将上面这行代码放到程序中，运行程序，输出的redis.port将是 5381。
命令行选项
如果一个键没有通过viper.Set显示设置值，那么获取时将尝试从命令行选项中读取。 如果有，优先使用。viper 使用 pflag 库来解析选项。 我们首先在init方法中定义选项，并且调用viper.BindPFlags绑定选项到配置中：
func init() {
pflag.Int("redis.port", 8381, "Redis port to connect")
// 绑定命令行
viper.BindPFlags(pflag.CommandLine)
}
然后，在main方法开头处调用pflag.Parse解析选项。
编译、运行程序：
$ ./main.exe --redis.port 9381
redis port: 9381
如果不传入选项：
$ ./main.exe
redis port: 7381
注意，这里并不会使用选项redis.port的默认值。
但是，如果通过下面的方法都无法获得键值，那么返回选项默认值（如果有）。试试注释掉配置文件中redis.port看看效果。
环境变量
如果前面都没有获取到键值，将尝试从环境变量中读取。我们既可以一个个绑定，也可以自动全部绑定。
在init方法中调用AutomaticEnv方法绑定全部环境变量：
func init() {
// 绑定环境变量
viper.AutomaticEnv()
}
创建一个名为redis.port的环境变量，值为 10381。 运行程序，输出的redis.port值为 10381。
也可以单独绑定环境变量：
func init() {
// 绑定环境变量
viper.BindEnv("redis.port")
viper.BindEnv("go.path", "GOPATH")
}
func main() {
// 省略部分代码
fmt.Println("go path: ", viper.Get("go.path"))
}
调用BindEnv方法，如果只传入一个参数，则这个参数既表示键名，又表示环境变量名。 如果传入两个参数，则第一个参数表示键名，第二个参数表示环境变量名。
还可以通过viper.SetEnvPrefix方法设置环境变量前缀，这样一来，通过AutomaticEnv和一个参数的BindEnv绑定的环境变量， 在使用Get的时候，viper 会自动加上这个前缀再从环境变量中查找。
如果对应的环境变量不存在，viper 会自动将键名全部转为大写再查找一次。所以，使用键名gopath也能读取环境变量GOPATH的值。
配置文件
如果经过前面的途径都没能找到该键，viper 接下来会尝试从配置文件中查找。 为了避免环境变量的影响，需要删除redis.port这个环境变量。
看 快速使用 中的示例。
默认值
在上面的 快速使用 一节，我们已经看到了如何设置默认值，这里就不赘述了。
读取配置
从 io.Reader 中读取
viper 支持从 io.Reader 中读取配置。这种形式很灵活，来源可以是文件，也可以是程序中生成的字符串，甚至可以从网络连接中读取的字节流。
func main() {
viper.SetConfigType("toml")
tomlConfig := []byte(`
app_name = "awesome web"
[mysql]
ip = "127.0.0.1"
port = 3306
user = "dj"
password = 123456
`)
err := viper.ReadConfig(bytes.NewBuffer(tomlConfig))
if err != nil {
log.Fatal("read config failed: %v", err)
}
fmt.Println("redis port: ", viper.GetInt("redis.port"))
}
Unmarshal
viper 支持将配置 Unmarshal 到一个结构体中，为结构体中的对应字段赋值。
type Config struct {
AppName string
LogLevel string
MySQL MySQLConfig
Redis RedisConfig
}
type MySQLConfig struct {
IP string
Port int
User string
Password string
Database string
}
type RedisConfig struct {
IP string
Port int
}
func main() {
viper.SetConfigName("config")
viper.SetConfigType("toml")
viper.AddConfigPath(".")
err := viper.ReadInConfig()
if err != nil {
log.Fatal("read config failed: %v", err)
}
var c Config
viper.Unmarshal(&c)
fmt.Println(c.MySQL)
}
输出结果：
{127.0.0.1 3306 dj 123456 awesome}
保存配置
有时候，我们想要将程序中生成的配置，或者所做的修改保存下来。viper 提供了接口！
WriteConfig：将当前的 viper 配置写到预定义路径，如果没有预定义路径，返回错误。将会覆盖当前配置；SafeWriteConfig：与上面功能一样，但是如果配置文件存在，则不覆盖；WriteConfigAs：保存配置到指定路径，如果文件存在，则覆盖；SafeWriteConfig：与上面功能一样，但是入股配置文件存在，则不覆盖。
下面我们通过程序生成一个config.toml配置：
func main() {
viper.SetConfigName("config")
viper.SetConfigType("toml")
viper.AddConfigPath(".")
viper.Set("log_level", "DEBUG")
viper.Set("mysql.ip", "127.0.0.1")
viper.Set("mysql.port", 3306)
viper.Set("mysql.user", "root")
viper.Set("mysql.password", "123456")
err := viper.SafeWriteConfig()
if err != nil {
log.Fatal("write config failed: ", err)
}
}
运行后生成的配置文件如下：
log_level = "DEBUG"
[mysql]
ip = "127.0.0.1"
password = "123456"
port = 3306
user = "root"
监听文件修改
viper 可以监听文件修改，热加载配置。因此不需要重启服务器，就能让配置生效。
func main() {
viper.SetConfigName("config")
viper.SetConfigType("toml")
viper.AddConfigPath(".")
err := viper.ReadInConfig()
if err != nil {
log.Fatal("read config failed: %v", err)
}
viper.WatchConfig()
fmt.Println("redis port before sleep: ", viper.Get("redis.port"))
time.Sleep(time.Second * 10)
fmt.Println("redis port after sleep: ", viper.Get("redis.port"))
}
只需要调用viper.WatchConfig，viper 会自动监听配置修改。如果有修改，重新加载的配置。
上面程序中，我们先打印redis.port的值，然后Sleep 10s。在这期间修改配置中redis.port的值，Sleep结束后再次打印。 发现打印出修改后的值：
redis port before sleep: 7381
redis port after sleep: 73810
另外，还可以为配置修改增加一个回调：
viper.OnConfigChange(func(e fsnotify.Event) {
fmt.Printf("Config file:%s Op:%s\n", e.Name, e.Op)
})
这样文件修改时会执行这个回调。
viper 使用 fsnotify 这个库来实现监听文件修改的功能。