Go 標準包:viper 配置文件解析包

1. 介紹

Viper 是適用於 Go 應用程序（包括 Twelve-Factor App）的完整配置解決方案。它被設計用於在應用程序中工作，並且可以處理所有類型的配置需求和格式。目前Star 15.8k, 它支持以下特性：

• 設置默認值

• 從JSON、TOML、YAML、HCL、envfile和Java properties格式的配置文件讀取配置信息

• 實時監控和重新讀取配置文件（可選）

• 從環境變量中讀取

• 從遠程配置系統（etcd或Consul）讀取並監控配置變化

• 從命令行參數讀取配置

• 從buffer讀取配置

• 顯式配置值

2. 安裝

go get github.com/spf13/viper

3. 讀取yaml

viper可以解析JSON、TOML、YAML、HCL、envfile、properties多種格式的配置文件, 這裏只演示yaml格式的解析, 其他格式與此類似。

3.1 創建 yaml 文件

新建./app.yaml文件，內容如下:

app:
  name: Gin框架學習實踐
  version: v1.0
mysql:
  host: 127.0.0.1
  port: 3306
  user: root
  password: 123456

3.2  解析yaml文件

package main
import (
 "fmt"
 "github.com/spf13/viper"
)
type APP struct {
 Name    string `yaml:"name"`
 Version string `yaml:"version"`
}

type MYSQL struct {
 Host     string `yaml:"host"`
 Port     string `yaml:"port"`
 User     string `yaml:"user"`
 Password string `yaml:"password"`
}

type YamlConfig struct {
 App   APP   `yaml:"app"`
 Mysql MYSQL `yaml:"mysql"`
}
// 解析yaml配置文件
func main() {
 viperConfig := viper.New()
 // 設置配置文件名，沒有後綴
 viperConfig.SetConfigName("app")
 // 設置讀取文件格式爲: yaml
 viperConfig.SetConfigType("yaml")
 // 設置配置文件目錄(可以設置多個,優先級根據添加順序來)
 viperConfig.AddConfigPath(".")
 // 讀取解析
 if err := viperConfig.ReadInConfig(); err != nil {
  if _, ok := err.(viper.ConfigFileNotFoundError); ok {
   fmt.Printf("配置文件未找到！%v\n", err)
   return
  } else {
   fmt.Printf("找到配置文件,但是解析錯誤,%v\n", err)
   return
  }
 }
 // 映射到結構體
 var yamlConfig YamlConfig
 if err := viperConfig.Unmarshal(&yamlConfig);err != nil{
  fmt.Printf("配置映射錯誤,%v\n", err)
 }
 fmt.Printf("App: %+v\n",yamlConfig.App)
 fmt.Printf("Mysql: %+v\n",yamlConfig.Mysql)
}

運行輸出:

App: {Name:Gin框架學習實踐 Version:}
Mysql: {Host:127.0.0.1 Port:3306 User:root Password:123456}

3.3 讀取優先級

如果存在多個配置文件在不同的目錄下, 可以通過viper.AddConfigPath(path)來設置優先級，先添加的優先級越高。

修改 3.2 部分代碼

...
 viperConfig := viper.New()
 // 設置配置文件名，沒有後綴
 viperConfig.SetConfigName("app")
 // 設置讀取文件格式爲: yaml
 viperConfig.SetConfigType("yaml")
  // 設置配置文件目錄(可以設置多個,優先級根據添加順序來)
  viperConfig.AddConfigPath(".")
  viperConfig.AddConfigPath("./config")
...

先查找 (.) 當前目錄下是否有 app.yaml，如果沒有則去 (./config/) 中查找。

3.4 設置默認值

import (
 "github.com/spf13/viper"
)
// 解析yaml配置文件
func main()  {
 viperConfig := viper.New()
 // 指定配置文件
 viperConfig.SetConfigFile("./app.yaml")
 // 設置默認值
 viperConfig.SetDefault("app.version","v1.2.0")
 viperConfig.SetDefault("app.BuildDate","2020-10-10 12:12:12")
 // 讀取解析
 if err := viperConfig.ReadInConfig(); err != nil {
  if _, ok := err.(viper.ConfigFileNotFoundError); ok {
   panic("配置文件未找到！")
  } else {
   panic("找到配置文件,但是解析錯誤！")
  }
 }
  // 映射到結構體
 var yamlConfig YamlConfig
 if err := viperConfig.Unmarshal(&yamlConfig); err != nil {
  panic("配置映射錯誤！" + err.Error())
 }
 return &yamlConfig
}
// 新增BuildDate
type APP struct {
 Name      string    `yaml:"name"`
 Version   string    `yaml:"version"`
 BuildDate string     `yaml:"buildDate"`
}
// 同3.1
type MYSQL struct {
  ...
}
// 同3.1
type YamlConfig struct {
   ...
}
//輸出：&{App:{Name:Gin框架學習實踐 Version:v1.0 BuildDate:2020-10-10 12:12:12} Mysql:{Host:127.0.0.1 Port:3306 User:root Password:123456}}

yaml文件同 3.1 創建的yaml文件

4. 從io.Reader讀取配置

4.1 代碼

func ReadFromByte() {
 // 定義配置變量
 yamVar := []byte(`
desc: viper使用
app:
  name: goItem
  version: v1.3
mysql:
   host: 127.0.0.1
   port: 3306
   user: root
   password: 123456
`)
 v := viper.New()
 // 設置解析格式
 v.SetConfigType("yaml")
 err := v.ReadConfig(bytes.NewBuffer(yamVar))
 if err != nil {
  fmt.Println(err)
  return
 }
 // 輸出變量
 fmt.Printf("desc: %v \n",v.Get("desc"))
 fmt.Printf("app.name: %v \n",v.Get("app.name"))
 fmt.Printf("app.version: %v \n",v.Get("app.version"))
 fmt.Printf("mysql: %v \n",v.Get("mysql"))
}

4.2 輸出

desc: viper使用 
app.name: goItem 
app.version: v1.3 
mysql: map[host:127.0.0.1 password:123456 port:3306 user:root]

5. 覆蓋和別名

5.1 創建配置文件test.yaml

name: Gin-use
author: 劉慶輝

5.2 代碼示例

type TestConfig struct {
 Name   string `yaml:"name"`
 Author string `yaml:"author"`
}

// 測試配置覆蓋
func main() {
 v := viper.New()
 v.SetConfigFile("./test.yaml")
 if err2 := v.ReadInConfig(); err2 != nil {
  if _, ok := err2.(viper.ConfigFileNotFoundError); ok {
   panic("配置文件未找到！")
  } else {
   panic("找到配置文件,但是解析錯誤！")
  }
 }
 // 設置別名
 v.RegisterAlias("author","UserName")
 var testConfig TestConfig
 // 覆蓋變量
 v.Set("name", "測試配置覆蓋")
 err := v.Unmarshal(&testConfig)
 if err != nil {
  fmt.Println(err)
  return
 }
 fmt.Printf("testConfig:%+v\n", testConfig)
 fmt.Printf("別名UserName:%+v\n", v.GetString("UserName"))
}
/**輸出
testConfig:{Name:測試配置覆蓋 Author:劉慶輝}
別名UserName:劉慶輝
*/

6. 動態修改

6.1 代碼

package main
import (
 "fmt"
 "github.com/fsnotify/fsnotify"
 "github.com/gin-gonic/gin"
 "github.com/spf13/viper"
)

type APP struct {
 Name      string `yaml:"name"`
 Version   string `yaml:"version"`
 BuildDate string `yaml:"buildDate"`
}
type MYSQL struct {
 Host     string `yaml:"host"`
 Port     string `yaml:"port"`
 User     string `yaml:"user"`
 Password string `yaml:"password"`
}
type YamlConfig struct {
 App   APP   `yaml:"app"`
 Mysql MYSQL `yaml:"mysql"`
}
var yamlConfig YamlConfig
func main() {
 engine := gin.Default()
 // 讀取配置
 WatchConfigYaml()
 engine.GET("/test", func(context *gin.Context) {
  context.JSON(200,gin.H{"config":yamlConfig})
 })
 _ = engine.Run()
}

// 動態監聽yaml配置文件
func WatchConfigYaml() {
 v := viper.New()
 v.SetConfigFile("./app.yaml")
 if err := v.ReadInConfig();err != nil {
  if _,ok := err.(viper.ConfigFileNotFoundError);ok{
   fmt.Printf("配置文件不存在:%v\n",err)
  } else {
   fmt.Printf("配置文件存在,解析失敗:%v\n",err)
  }
 }
 v.WatchConfig()
 v.OnConfigChange(func(e fsnotify.Event) {
  // 配置動態改變時，回調函數
  fmt.Printf("配置發生改變,重新解析配置: %v \n",e.Name)
  if err := v.Unmarshal(&yamlConfig);err != nil {
   fmt.Println(err)
  }
 })
 if err := v.Unmarshal(&yamlConfig);err != nil {
  fmt.Println(err)
 }
}

6.2 請求

啓動服務後，訪問: http://127.0.0.1:8080/test, 之後修改配置文件，保存後刷新瀏覽器器，會發現配置已經修改。無需重啓, 即可生效！

更多使用方法，可查看文檔: https://github.com/spf13/viper/

本文由 Readfog 進行 AMP 轉碼，版權歸原作者所有。
來源：https://mp.weixin.qq.com/s/5U5_DfeUaaMrHmQEhcMDzQ