Viper解析&加载配置

Viper解析&加载配置

1    Viper是什么

Viper是一个方便Go语言应用程序处理配置信息的库。它可以处理多种格式的配置。它支持的特性：

• 设置默认值
• 从JSON、TOML、YAML、HCL和Java properties文件中读取配置数据
• 可以监视配置文件的变动、重新读取配置文件
• 从环境变量中读取配置数据
• 从远端配置系统中读取数据，并监视它们（比如etcd、Consul）
• 从命令参数中读物配置
• 从buffer中读取
• 调用函数设置配置信息

2    安装viper

go get github.com/spf13/viper

在go的根目录下 新建 web/config目录 ,目录参考： /usr/local/go/web/config

3    Viper在Go项目中如何使用

在 config目录中，新建 config.yaml （配置）文件，内容如下：

common:
  database:
    name: test
    host: 127.0.0.1

3.1    在config目录中，新建 config.go （获取配置）文件，内容如下

package config
 
import (
    "fmt"
    "github.com/spf13/viper"
)
 
func Init() (interface{},error) {  //模块中供其他包调用的方法，首字母必须大写
    //viper设置 配置
    viper.Set("name","abc")
    fmt.Printf("name的值是%v
",viper.GetString("name") )
 
    //读取配置文件配置
    viper.AddConfigPath("config")
    viper.SetConfigName("config")
    error := viper.ReadInConfig()
    /*
    代码解析：
        viper.AddConfigPath("conf")用来指定yaml配置文件的路径
        viper.SetConfigName("config")用来指定配置文件的名称
        viper.ReadInConfig()是解析配置文件的函数，如果配置文件的路径错误获名称错误则解析失败，会报错误
        viper.GetString("database.name")是用来从配置文件中根据层级关系来获取数据
        最后，通过fmt.Println()对数据结果进行输出
    */
    if(error != nil){
        panic(error)
    }
    c := viper.AllSettings() //获取所有配置
    return c,nil
}
 
//获取数据库配置信息
func GetDatabaseInfo() map[string]interface{} {  //模块中供其他包调用的方法，首字母必须大写
    return viper.GetStringMap("common.database")
}
 
//获取环境变量
func GetEnvInfo(env string) string {
    viper.AutomaticEnv()
    return viper.GetString(env)
}

3.2    web目录中，新建 testviper.go （加载配置）文件，内容如下：

package main
 
import (
    "fmt"
    "web/config"
)
 
func main() {
    vipConfig,error := config.Init()                                  //vipConfig是配置
    fmt.Printf("config.init error是%v
", error)
    //fmt.Printf("config.init vipConfig是%v
",vipConfig,)
    database := config.GetDatabaseInfo()
    fmt.Printf("直接获取common[database]配置是%v
", database)
    fmt.Printf("直接获取common[database][host]配置是%v
", database["host"])
 
    //因为我们不知道 vipConfig 的下级是什么类型的数据，所以这里使用了interface{}
    //因此所有的类型、任意动态的内容都可以解析成 interface{}。
    for key,val := range vipConfig.(map[string]interface{}){        //循环接口类型，获取配置信息
        fmt.Printf("vipConfig 的key是%v val是%v
",key,val )
 
        switch val.(type) {                                          //判断val的类型
        case map[string]interface{}:                                //如果是 interface接口类型
            for ke,va := range val.(map[string]interface{}){        //循环接口类型，获取配置信息
                fmt.Printf("vipConfig 的ke是%v va是%v
",ke,va )
 
                switch va.(type) {                                    //判断va的类型
                case map[string]interface{}:                         //如果是 interface接口类型
                    for k,v := range va.(map[string]interface{}){   //循环接口类型，获取配置信息
                        fmt.Printf("vipConfig 的k是%v v是%v
",k,v )
                    }
                }
            }
        }
    }
 
    //viper可以获取服务器的环境变量
    GO111MODULE := config.GetEnvInfo("GO111MODULE")
    fmt.Printf("GO111MODULE的值是%v
",GO111MODULE)
 
}

3.3    使用 go run testviper.go 运行该文件即可

[root@localhost web]# go run testviper.go
name的值是abc
config.init error是<nil>
直接获取common[database]配置是map[host:[127.0.0.1] name:[test]]
直接获取common[database][host]配置是[127.0.0.1]
vipConfig 的key是common val是map[database:map[host:127.0.0.1 name:test]]
vipConfig 的ke是database va是map[host:127.0.0.1 name:test]
vipConfig 的k是name v是test
vipConfig 的k是host v是127.0.0.1
vipConfig 的key是name val是abc
GOROOT的值是on

4    总结

viper支持的加载配置文件类型很多，我们从配置文件读取或者获取相关需要的数据信息，根据文件后缀名查询分割相关的配置文件类型指定操作配置的后缀名指定。

本文由博客作者流雨声
github地址:https://github.com/vpc123