viper

文档：https://pkg.go.dev/github.com/spf13/viper
viper 支持Yaml、Json、TOML、HCL 等格式，读取非常的方便

type DecoderConfigOption

json解析映射配置

type DecoderConfigOption func(*mapstructure.DecoderConfig)

func DecodeHook(hook mapstructure.DecodeHookFunc) DecoderConfigOption

# 默认的规则如下 
mapstructure.ComposeDecodeHookFunc(
        mapstructure.StringToTimeDurationHookFunc(),
        mapstructure.StringToSliceHookFunc(","),
    )

type StringReplacer

type StringReplacer interface {
    // Replace returns a copy of s with all replacements performed.
    Replace(s string) string
}

type Option

func EnvKeyReplacer(r StringReplacer) Option 设置一个替换程序，用于将环境变量映射到内部键
func KeyDelimiter(d string) Option 设置分隔符，默认是”.”

type Viper

func GetViper() Viper 获取全局Viper实例
func New() Viper New返回一个初始化的Viper实例
func NewWithOptions(opts …Option) Viper
func Sub(key string) Viper Sub返回新的Viper实例，表示该实例的一个子树。Sub对键不区分大小写。

本地读取

func (v Viper) AddConfigPath(in string) 配置文件的父级路径
func (v Viper) SetConfigFile(in string) 显式地定义配置文件的路径、名称和扩展名
func (v Viper) SetConfigName(in string) 设置配置文件的名称。不包括扩展
func (v Viper) ReadInConfig() error 加载配置文件
func (v Viper) SetConfigPermissions(perm os.FileMode) 设置配置文件的权限
func (v Viper) SetConfigType(in string) 设置后缀名
func (v *Viper) SetTypeByDefaultValue(enable bool) 以设定的默认值的type作为真实type，而不是配置文件中的

#app.toml
[mysql]
host = "1.1.1.1"
port = "3306"
database = "xxxx"
user = "xxxx"
password = "1234"
charset = "utf8"
sql_log = true
MaxIdleConns = 5 # 空闲时最大的连接数
MaxOpenConns = 20 # 最大的连接数
[redis]
Address = "1.1.1.1:6379"    # ip地址+端口号                     
MaxIdle = 16            # 最大空闲数
MaxActive = 20            # 连接池的最大数据库连接数，设为0表示无限制
IdleTimeout = 3000        # 客户端超时时间单位是毫秒

func main() {
    v := viper.New()
    v.SetConfigName("app")
    v.AddConfigPath("./")
    //v.AddConfigPath("%GOPATH/src/")
    v.SetConfigType("toml")
    //v.SetConfigFile("/home/uhome/app/configs/app.toml")  //这样写简单明了
    if err := v.ReadInConfig();err != nil {
        fmt.Printf("err:%s\n",err)
    }
    fmt.Println(v.AllKeys())
    fmt.Println(v.AllSettings())
    fmt.Println(v.Get("mysql.host")) // 键的默认分隔符就是"."
}

获取远程配置

func (v Viper) AddRemoteProvider(provider, endpoint, path string) error 添加远程配置源
func (v Viper) AddSecureRemoteProvider(provider, endpoint, path, secretkeyring string) error 同上
func (v *Viper) ReadRemoteConfig() error 加载远程配置文件

viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001","/config/hugo.json")
viper.SetConfigType("json")supported extensions are "json", "toml", "yaml", "yml", "properties"
err := viper.ReadRemoteConfig()

io流配置

func (v *Viper) ReadConfig(in io.Reader) error 加载io流的配置文件

viper.SetConfigType("yaml") // or viper.SetConfigType("YAML")
// any approach to require this configuration into your program.
var yamlExample = []byte(`
Hacker: true
name: steve
hobbies:
- skateboarding
- snowboarding
- go
clothing:
  jacket: leather
  trousers: denim
age: 35
eyes : brown
beard: true
`)
viper.ReadConfig(bytes.NewBuffer(yamlExample))
viper.Get("name") // this would be "steve"

自定义kv

func (v Viper) Set(key string, value interface{}) 覆盖寄存器中键的值。Set对键不区分大小写
func (v Viper) SetDefault(key string, value interface{}) 设置默认值

取值或判断值

func (v Viper) AllKeys() []string 所有有值的key
func (v Viper) AllSettings() map[string]interface{} 合并所有设置并以map[string]接口{}的形式返回
func (v Viper) Get(key string) interface{}
func (v Viper) GetBool(key string) bool
func (v Viper) GetDuration(key string) time.Duration
func (v Viper) GetFloat64(key string) float64
func (v Viper) GetInt(key string) int
func (v Viper) GetInt32(key string) int32
func (v Viper) GetInt64(key string) int64
func (v Viper) GetIntSlice(key string) []int
func (v Viper) GetSizeInBytes(key string) uint
func (v Viper) GetString(key string) string
func (v Viper) GetStringMap(key string) map[string]interface{}
func (v Viper) GetStringMapString(key string) map[string]string
func (v Viper) GetStringMapStringSlice(key string) map[string][]string
func (v Viper) GetStringSlice(key string) []string
func (v Viper) GetTime(key string) time.Time
func (v Viper) GetUint(key string) uint
func (v Viper) GetUint32(key string) uint32
func (v Viper) GetUint64(key string) uint64
func (v Viper) InConfig(key string) bool 检查给定的键(或别名)是否在配置文件中
func (v Viper) IsSet(key string) bool 检查给定的键(或别名)是否在配置文件中设定了值

配置项合并

func (v Viper) MergeConfig(in io.Reader) error 将in与现有的配置文件合并
func (v Viper) MergeConfigMap(cfg map[string]interface{}) error 用现有配置从给定的映射中合并配置
func (v *Viper) MergeInConfig() error 合并

嵌套结构体

func (v Viper) Sub(key string) Viper

app:
  cache1:
    max-items: 100
    item-size: 64
  cache2:
    max-items: 200
    item-size: 80
subv := viper.Sub("app.cache1")
subv.GetInt64("max-items") // 100
subv.GetInt64("item-size") // 64

监听配置变化

func (v Viper) WatchConfig() 监视本地配置
func (v Viper) OnConfigChange(run func(in fsnotify.Event)) 文件发生变化时

package main
import (
    "fmt"
    "github.com/fsnotify/fsnotify"
    "github.com/spf13/viper"
    "log"
    "time"
)
func main() {
    v := viper.New()
    v.SetConfigFile("app.toml") //这样写简单明了
    if err := v.ReadInConfig(); err != nil {
        fmt.Printf("err:%s\n", err)
    }
    fmt.Println(v.Get("mysql.host")) // 键的默认分隔符就是"."
    go func() {
        for {
            time.Sleep(time.Second * 5)
            v.WatchConfig()
            v.OnConfigChange(func(e fsnotify.Event) {
                log.Println("config file changed", e.Name)
                // 这里更新配置。。。
            })
        }
    }()
    time.Sleep(20 * time.Second)
}

func (v *Viper) WatchRemoteConfig() error 监视远程配置

var runtime_viper = viper.New()
//增加远程配置
runtime_viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001", "/config/hugo.yml")
runtime_viper.SetConfigType("yaml")
// 读取远程配置
err := runtime_viper.ReadRemoteConfig()
// 解析到runtime_conf
runtime_viper.Unmarshal(&runtime_conf)
go func(){
    for {
        time.Sleep(time.Second * 5) // delay after each request
        // currently, only tested with etcd support
        err := runtime_viper.WatchRemoteConfig()
        if err != nil {
            log.Errorf("unable to read remote config: %v", err)
            continue
        }
        //5秒将runtime_conf更新一次
        runtime_viper.Unmarshal(&runtime_conf)
    }
}()

func (v *Viper) WatchRemoteConfigOnChannel() error

配置文件保存

func (v Viper) SafeWriteConfig() error 写入当前文件，如果不存在返回错误，如果存在不会覆盖
func (v Viper) SafeWriteConfigAs(filename string) error 写入指定文件，如果存在不会覆盖
func (v Viper) WriteConfig() error 将当前的配置写入当前文件，如果不存在返回错误（如果存在，覆盖）
func (v Viper) WriteConfigAs(filename string) error 将当前的配置写入指定文件（覆盖）

Unmarshal例子

func (v *Viper) Unmarshal(rawVal interface{}, opts …DecoderConfigOption) error 将配置映射到结构体

[mysql]
host = "1.1.1.2"
port = "3306"
dataBase = "xxxx"
user = "xxxx"
passWord = "1234"
charset = "utf8"
sqlLog = true
maxIdleConns = 5 # 空闲时最大的连接数
maxOpenConns = 20 # 最大的连接数
[redis]
host = "1.1.1.1"
port = "6379"
dataBase = "xxxx"
user = "xxxx"
passWord = "1234"
maxIdle = 16            # 最大空闲数
maxActive = 20            # 连接池的最大数据库连接数，设为0表示无限制
idleTimeout = 3000        # 客户端超时时间单位是毫秒

package main
import (
    "fmt"
    "github.com/spf13/viper"
)
type MysqlConfig struct {
    Host     string
    Port     string
    DataBase string
}
type RedisConfig struct {
    Host     string
    Port     string
    DataBase string
}
type config struct {
    Mysql MysqlConfig   // 变量名与toml中保持一致，首字母大写
    Redis RedisConfig
}
func main() {
    v := viper.New()
    v.SetConfigFile("app.toml") //这样写简单明了
    if err := v.ReadInConfig(); err != nil {
        fmt.Printf("err:%s\n", err)
    }
    fmt.Println(v.Get("mysql.host")) // 键的默认分隔符就是"."
    var m config
    fmt.Println(v.Unmarshal(&m))
    fmt.Printf("%+v", m)
}
{Mysql:{Host:1.1.1.2 Port:3306 DataBase:xxxx} Redis:{Host:1.1.1.1 Port:6379 DataBase:xxxx}}

package main
import (
    "fmt"
    "github.com/spf13/viper"
)
type MysqlConfig struct {
    Host     string   
    Port     string   
    DataBase string   
}
func main() {
    v := viper.New()
    v.SetConfigFile("app.toml") //这样写简单明了
    if err := v.ReadInConfig(); err != nil {
        fmt.Printf("err:%s\n", err)
    }
    fmt.Println(v.Get("mysql.host")) // 键的默认分隔符就是"."
    var m MysqlConfig
    fmt.Println(v.Sub("mysql").Unmarshal(&m))
    fmt.Printf("%+v", m)
}
{Host:1.1.1.2 Port:3306 DataBase:xxxx}

字段TAG

Viper 使用的是github.com/mitchellh/mapstructure

plugin:
    client_cert: false
    key: "123"
    content_format: "json111"
    http_compression: true
    http_method: "get"
    batch_size: 1000
    queue_size: 1500
    server_port: 9001

type Config struct {
    Client_Cert      bool   `mapstructure:"client_cert"`
    Key              string `mapstructure:"key"`
    Content_Format   string `mapstructure:"content_format"`
    Http_Compression bool   `mapstructure:"http_compression"`
    Http_Method      string `mapstructure:"http_method"`
    Batch_Size       int64  `mapstructure:"batch_size"`
    Queue_Size       int64  `mapstructure:"queue_size"`
    Server_Port      int64  `mapstructure:"server_port"`
}
func GetConfig() {
    var c Config
    path := "app.yml"
    v := viper.New()
    v.SetConfigFile(path)
    if err := v.ReadInConfig(); err != nil {
        fmt.Printf("err:%s\n", err)
    }
    v.Sub("plugin").Unmarshal(&c)
    fmt.Printf("%#v\n", c)
}
main.Config{Client_Cert:false, Key:"123", Content_Format:"json111", Http_Compression:true, Http_Method:"get", Batch_Size:1000, Queue_Size:1500, Server_Port:9001}

绑定环境变量

func (v Viper) SetEnvPrefix(in string)
func (v Viper) BindEnv(input …string) error
func (v Viper) SetEnvKeyReplacer(r strings.Replacer) 设定key的替换
func (v *Viper) SetEnvPrefix(in string) 设定key的前缀，那么就只会加载这个
注意：对大小写敏感
如果需要小写字符串，可使用EnvKeyReplacer

SetEnvPrefix("spf") // 将转换为大写
BindEnv("id")
os.Setenv("SPF_ID", "13")
id := Get("id") // 13

同Flags与cobra一起使用

func (v Viper) BindFlagValue(key string, flag FlagValue) error
func (v Viper) BindFlagValues(flags FlagValueSet) (err error)
func (v Viper) BindPFlag(key string, flag pflag.Flag) error
func (v Viper) BindPFlags(flags pflag.FlagSet) error

func main() {
    // using standard library "flag" package
    flag.Int("flag", 1234, "help message for flagname")
    pflag.CommandLine.AddGoFlagSet(flag.CommandLine)
    fmt.Println(pflag.CommandLine.Args())
    pflag.Parse()
    viper.BindPFlags(pflag.CommandLine)
    i := viper.GetInt("flag") // retrieve value from viper
    fmt.Println(i)
}

serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))