Golang的viper库

1.作用

viper 是一个配置解决方案，拥有丰富的特性：

支持 JSON/TOML/YAML/HCL/envfile/Java properties 等多种格式的配置文件；
可以设置监听配置文件的修改，修改时自动加载新的配置；
从环境变量、命令行选项和io.Reader中读取配置；
从远程配置系统中读取和监听修改，如 etcd/Consul；
代码逻辑中显示设置键值。

2.快速使用

安装：

$ go get github.com/spf13/viper

使用：

package mainimport ("fmt""log""github.com/spf13/viper"
)func main() {viper.SetConfigName("config")viper.SetConfigType("toml")viper.AddConfigPath(".")viper.SetDefault("redis.port", 6381)err := viper.ReadInConfig()if err != nil {log.Fatal("read config failed: %v", err)}fmt.Println(viper.Get("app_name"))fmt.Println(viper.Get("log_level"))fmt.Println("mysql ip: ", viper.Get("mysql.ip"))fmt.Println("mysql port: ", viper.Get("mysql.port"))fmt.Println("mysql user: ", viper.Get("mysql.user"))fmt.Println("mysql password: ", viper.Get("mysql.password"))fmt.Println("mysql database: ", viper.Get("mysql.database"))fmt.Println("redis ip: ", viper.Get("redis.ip"))fmt.Println("redis port: ", viper.Get("redis.port"))
}

config.toml

app_name = "awesome web"# possible values: DEBUG, INFO, WARNING, ERROR, FATAL
log_level = "DEBUG"[mysql]
ip = "127.0.0.1"
port = 3306
user = "dj"
password = 123456
database = "awesome"[redis]
ip = "127.0.0.1"
port = 7381

viper 的使用非常简单，它需要很少的设置。设置文件名（SetConfigName）、配置类型（SetConfigType）和搜索路径（AddConfigPath），然后调用ReadInConfig。
viper会自动根据类型来读取配置。使用时调用viper.Get方法获取键值。

编译、运行程序：

awesome web
DEBUG
mysql ip:  127.0.0.1
mysql port:  3306
mysql user:  dj
mysql password:  123456
mysql database:  awesome
redis ip:  127.0.0.1
redis port:  7381

有几点需要注意：

设置文件名时不要带后缀；
搜索路径可以设置多个，viper 会根据设置顺序依次查找；
viper 获取值时使用section.key的形式，即传入嵌套的键名；
默认值可以调用viper.SetDefault设置。

3.读取键

viper 提供了多种形式的读取方法。在上面的例子中，我们看到了Get方法的用法。Get方法返回一个interface{}的值，使用有所不便。

GetType系列方法可以返回指定类型的值。
其中，Type 可以为Bool/Float64/Int/String/Time/Duration/IntSlice/StringSlice。
但是请注意，如果指定的键不存在或类型不正确，GetType方法返回对应类型的零值。

如果要判断某个键是否存在，使用IsSet方法。
另外，GetStringMap和GetStringMapString直接以 map 返回某个键下面所有的键值对，前者返回map[string]interface{}，后者返回map[string]string。
AllSettings以map[string]interface{}返回所有设置。

// 省略包名和 import 部分func main() {viper.SetConfigName("config")viper.SetConfigType("toml")viper.AddConfigPath(".")err := viper.ReadInConfig()if err != nil {log.Fatal("read config failed: %v", err)}fmt.Println("protocols: ", viper.GetStringSlice("server.protocols"))fmt.Println("ports: ", viper.GetIntSlice("server.ports"))fmt.Println("timeout: ", viper.GetDuration("server.timeout"))fmt.Println("mysql ip: ", viper.GetString("mysql.ip"))fmt.Println("mysql port: ", viper.GetInt("mysql.port"))if viper.IsSet("redis.port") {fmt.Println("redis.port is set")} else {fmt.Println("redis.port is not set")}fmt.Println("mysql settings: ", viper.GetStringMap("mysql"))fmt.Println("redis settings: ", viper.GetStringMap("redis"))fmt.Println("all settings: ", viper.AllSettings())
}

我们在配置文件 config.toml 中添加protocols和ports配置：

[server]
protocols = ["http", "https", "port"]
ports = [10000, 10001, 10002]
timeout = 3s

编译、运行程序，输出：

protocols:  [http https port]
ports:  [10000 10001 10002]
timeout:  3s
mysql ip:  127.0.0.1
mysql port:  3306
redis.port is set
mysql settings:  map[database:awesome ip:127.0.0.1 password:123456 port:3306 user:dj]
redis settings:  map[ip:127.0.0.1 port:7381]
all settings:  map[app_name:awesome web log_level:DEBUG mysql:map[database:awesome ip:127.0.0.1 password:123456 port:3306

4.设置键值

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
awesome web
DEBUG
mysql ip:  127.0.0.1
mysql port:  3306
mysql user:  dj
mysql password:  123456
mysql database:  awesome
redis ip:  127.0.0.1
redis port:  9381

如何不传入选项：

$ ./main.exe
awesome web
DEBUG
mysql ip:  127.0.0.1
mysql port:  3306
mysql user:  dj
mysql password:  123456
mysql database:  awesome
redis ip:  127.0.0.1
redis port:  7381

注意，这里并不会使用选项redis.port的默认值。

但是，如果通过下面的方法都无法获得键值，那么返回选项默认值（如果有）。试试注释掉配置文件中redis.port看看效果。

环境变量

如果前面都没有获取到键值，将尝试从环境变量中读取。我们既可以一个个绑定，也可以自动全部绑定。

在init方法中调用AutomaticEnv方法绑定全部环境变量：

func init() {// 绑定环境变量viper.AutomaticEnv()
}

为了验证是否绑定成功，我们在main方法中将环境变量 GOPATH 打印出来：

func main() {// 省略部分代码fmt.Println("GOPATH: ", viper.Get("GOPATH"))
}

通过系统 -> 高级设置 -> 新建创建一个名为redis.port的环境变量，值为 10381。
运行程序，输出的redis.port值为 10381，并且输出中有 GOPATH 信息。

也可以单独绑定环境变量：

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的值。

5.参考文章

传送门