参考资料

  1. https://studygolang.com/articles/22483
  2. https://www.liwenzhou.com/posts/Go/viper_tutorial/ -李文周博客

    介绍

    在开发过程中，像数据库信息、邮件配置和其他的第三方服务密钥等这些固定的信息都会写在配置文件中，而配置文件又有多种表现形式和格式，有 JSON, TOML, YAML各种格式，而且测试环境，开发环境和生产环境用的配置文件也不是同一份，使用Viper将帮助我们更好的对配置文件进行管理。

什么是viper？

Viper是适用于Go应用程序（包括Twelve-Factor App）的完整配置解决方案。它被设计用于在应用程序中工作，并且可以处理所有类型的配置需求和格式。它支持以下特性：

  • 设置默认值
  • 从JSON、TOML、YAML、HCL、envfile和Java properties格式的配置文件读取配置信息
  • 实时监控和重新读取配置文件（可选）
  • 从环境变量中读取
  • 从远程配置系统（etcd或Consul）读取并监控配置变化
  • 从命令行参数读取配置
  • 从buffer读取配置
  • 显式配置值

viper支持的操作：

在构建现代应用程序时，你无需担心配置文件格式；你想要专注于构建出色的软件。Viper的出现就是为了在这方面帮助你的。 Viper能够为你执行下列操作：

  1. 查找、加载和反序列化JSON、TOML、YAML、HCL、INI、envfile和Java properties格式的配置文件。
  2. 提供一种机制为你的不同配置选项设置默认值。
  3. 提供一种机制来通过命令行参数覆盖指定选项的值。
  4. 提供别名系统，以便在不破坏现有代码的情况下轻松重命名参数。
  5. 当用户提供了与默认值相同的命令行或配置文件时，可以很容易地分辨出它们之间的区别。

安装

优先级

Viper会按照下面的优先级。每个项目的优先级都高于它下面的项目:

  • 显示调用Set设置值
  • 命令行参数（flag）
  • 环境变量
  • 配置文件
  • key/value存储
  • 默认值

重要： 目前Viper配置的键（Key）是大小写不敏感的。目前正在讨论是否将这一选项设为可选。

向viper存入值

注意：viper的key是大小写不敏感的

设置默认值

  1. viper.SetDefault("ContentDir", "content")
  2. viper.SetDefault("LayoutDir", "layouts")
  3. viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"})

读取配置文件

  1. viper.SetConfigFile("./config.yaml") // 指定配置文件路径
  2. viper.SetConfigName("config") // 配置文件名称(无扩展名)
  3. viper.SetConfigType("yaml") // 如果配置文件的名称中没有扩展名，则需要配置此项
  4. viper.AddConfigPath("/etc/appname/")   // 查找配置文件所在的路径
  5. viper.AddConfigPath("$HOME/.appname")  // 多次调用以添加多个搜索路径
  6. viper.AddConfigPath(".")               // 还可以在工作目录中查找配置
  7. err := viper.ReadInConfig() // 查找并读取配置文件
  8. if err != nil { // 处理读取配置文件的错误
  9.     panic(fmt.Errorf("Fatal error config file: %s \n", err))
  10. }

对找不到配置文件的错误处理：

  1. if err := viper.ReadInConfig(); err != nil {
  2.     if _, ok := err.(viper.ConfigFileNotFoundError); ok {
  3.         // 配置文件未找到错误；如果需要可以忽略
  4.     } else {
  5.         // 配置文件被找到，但产生了另外的错误
  6.     }
  7. }
  9. // 配置文件找到并成功解析

写入配置文件

  1. // 将当前配置写入“viper.AddConfigPath()”和“viper.SetConfigName”设置的预定义路径
  2. viper.WriteConfig()
  3. // 如果没有预定义的路径，则报错。如果存在，将不会覆盖当前的配置文件。
  4. viper.SafeWriteConfig()
  5. // 将当前的viper配置写入给定的文件路径。将覆盖给定的文件(如果它存在的话)
  6. viper.WriteConfigAs("/path/to/my/.config")
  7. // 因为该配置文件写入过，所以会报错
  8. viper.SafeWriteConfigAs("/path/to/my/.config") 
  9. viper.SafeWriteConfigAs("/path/to/my/.other_config")

监控配置文件

  1. func main() {
  2.     // 设置配置文件读取路径
  3.     viper.SetConfigFile("./config.yaml")
  5.     // 监控配置文件
  6.     viper.WatchConfig()
  7.     viper.OnConfigChange(func(e fsnotify.Event) {
  8.         // 配置文件发生变更之后会调用的回调函数
  9.         fmt.Println("Config file changed:", e.Name)
  10.     })
  12.     r := gin.Default()
  13.     r.GET("/version", func(c *gin.Context) {
  14.         c.String(200, viper.GetString("version"))
  15.     })
  16.     r.Run()
  17. }

从viper获取值

在Viper中，有几种方法可以根据值的类型获取值。存在以下功能和方法:

  • Get(key string) : interface{}
  • GetBool(key string) : bool
  • GetFloat64(key string) : float64
  • GetInt(key string) : int
  • GetIntSlice(key string) : []int
  • GetString(key string) : string
  • GetStringMap(key string) : map[string]interface{}
  • GetStringMapString(key string) : map[string]string
  • GetStringSlice(key string) : []string
  • GetTime(key string) : time.Time
  • GetDuration(key string) : time.Duration
  • IsSet(key string) : bool
  • AllSettings() : map[string]interface{}

需要认识到的一件重要事情是，每一个Get方法在找不到值的时候都会返回零值。为了检查给定的键是否存在，提供了IsSet()方法。

访问嵌套的键

如：

  1. {
  2.     "host": {
  3.         "address": "localhost",
  4.         "port": 5799
  5.     },
  6.     "datastore": {
  7.         "metric": {
  8.             "host": "127.0.0.1",
  9.             "port": 3099
  10.         },
  11.         "warehouse": {
  12.             "host": "198.0.0.1",
  13.             "port": 2112
  14.         }
  15.     }
  16. }

访问：

  1. GetString("datastore.metric.host") // (返回 "127.0.0.1")

提取子树

  1. app:
  2.   cache1:
  3.     max-items: 100
  4.     item-size: 64
  5.   cache2:
  6.     max-items: 200
  7.     item-size: 80
  9. // 提取子树
  10. subv := viper.Sub("app.cache1")
  12. // subv 现在代表：
  13. max-items: 100
  14. item-size: 64

反序列化

  1. type config struct {
  2.     Port int
  3.     Name string
  4.     PathMap string `mapstructure:"path_map"`
  5. }
  7. var C config
  9. err := viper.Unmarshal(&C)
  10. if err != nil {
  11.     t.Fatalf("unable to decode into struct, %v", err)
  12. }

序列化为字符串

  1. import (
  2.     yaml "gopkg.in/yaml.v2"
  3.     // ...
  4. )
  6. func yamlStringSettings() string {
  7.     c := viper.AllSettings()
  8.     bs, err := yaml.Marshal(c)
  9.     if err != nil {
  10.         log.Fatalf("unable to marshal config to YAML: %v", err)
  11.     }
  12.     return string(bs)
  13. }

viper实例

  1. package main
  3. import (
  4.     "fmt"
  5.     "net/http"
  7.     "github.com/gin-gonic/gin"
  8.     "github.com/spf13/viper"
  9. )
  11. func main() {
  12.     // 指定配置文件
  13.     viper.SetConfigFile("./config.yaml") 
  15.     // 读取(检测）配置信息
  16.     if err := viper.ReadInConfig(); err != nil {  
  17.         panic(fmt.Errorf("Fatal error config file: %s \n", err))
  18.     }
  20.     // 监控配置文件变化
  21.     viper.WatchConfig()
  23.     r := gin.Default()
  24.     // 访问/version的返回值会随配置文件的变化而变化
  25.     r.GET("/version", func(c *gin.Context) {
  26.         c.String(http.StatusOK, viper.GetString("version"))
  27.     })
  29.     if err := r.Run(
  30.         fmt.Sprintf(":%d", viper.GetInt("port"))); err != nil {
  31.         panic(err)
  32.     }
  33. }