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\n",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\n", error)
    //fmt.Printf("config.init vipConfig是%v\n",vipConfig,)
    database := config.GetDatabaseInfo()
    fmt.Printf("直接獲取common[database]配置是%v\n", database)
    fmt.Printf("直接獲取common[database][host]配置是%v\n", database["host"])
 
    //因為我們不知道 vipConfig 的下級是什么類型的數據，所以這里使用了interface{}
    //因此所有的類型、任意動態的內容都可以解析成 interface{}。
    for key,val := range vipConfig.(map[string]interface{}){        //循環接口類型，獲取配置信息
        fmt.Printf("vipConfig 的key是%v val是%v\n",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\n",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\n",k,v )
                    }
                }
            }
        }
    }
 
    //viper可以獲取服務器的環境變量
    GO111MODULE := config.GetEnvInfo("GO111MODULE")
    fmt.Printf("GO111MODULE的值是%v\n",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