免费91视频入口,国产微拍精品一区一再猛点,欧美激情一区二区三区在线

主頁 > 知識庫 > Golang使用第三方包viper讀取yaml配置信息操作

Golang使用第三方包viper讀取yaml配置信息操作

Golang有很多第三方包，其中的 viper 支持讀取多種配置文件信息。本文只是做一個小小demo，用來學(xué)習(xí)入門用的。

1、安裝

go get github.com/spf13/viper

2、編寫一個yaml的配置文件，config.yaml

database:
 host: 127.0.0.1
 user: root
 dbname: test
 pwd: 123456

3、編寫學(xué)習(xí)腳本main.go，讀取config.yaml配置信息

package main 
import (
 "fmt"
 "os" 
 "github.com/spf13/viper"
)
 
func main() {
 //獲取項目的執(zhí)行路徑
 path, err := os.Getwd()
 if err != nil {
 panic(err)
 }
 
 config := viper.New() 
 config.AddConfigPath(path)  //設(shè)置讀取的文件路徑
 config.SetConfigName("config") //設(shè)置讀取的文件名
 config.SetConfigType("yaml") //設(shè)置文件的類型
 //嘗試進(jìn)行配置讀取
 if err := config.ReadInConfig(); err != nil {
 panic(err)
 }
 
 //打印文件讀取出來的內(nèi)容:
 fmt.Println(config.Get("database.host"))
 fmt.Println(config.Get("database.user"))
 fmt.Println(config.Get("database.dbname"))
 fmt.Println(config.Get("database.pwd")) 
}

4、執(zhí)行g(shù)o run main.go

輸出:

127.0.0.1
root
test
123456

ok!

補充：go基于viper實現(xiàn)配置文件熱更新及其源碼分析

go第三方庫 github.com/spf13/viper 實現(xiàn)了對配置文件的讀取并注入到結(jié)構(gòu)中，好用方便。

其中以

viperInstance := viper.New() // viper實例
viperInstance.WatchConfig()
viperInstance.OnConfigChange(func(e fsnotify.Event) {
 log.Print("Config file updated.")
 viperLoadConf(viperInstance) // 加載配置的方法
})

可實現(xiàn)配置的熱更新，不用重啟項目新配置即可生效（實現(xiàn)熱加載的方法也不止這一種，比如以文件的上次修改時間來判斷等）。

為什么這么寫？這樣寫為什么就能立即生效？基于這兩個問題一起來看看viper是怎樣實現(xiàn)熱更新的。

上面代碼的核心一共兩處：WatchConfig()方法、OnConfigChange()方法。WatchConfig()方法用來開啟事件監(jiān)聽，確定用戶操作文件后該文件是否可正常讀取，并將內(nèi)容注入到viper實例的config字段，先來看看WatchConfig()方法：

func (v *Viper) WatchConfig() {
 go func() {
   // 建立新的監(jiān)視處理程序，開啟一個協(xié)程開始等待事件
   // 從I/O完成端口讀取，將事件注入到Event對象中：Watcher.Events
 watcher, err := fsnotify.NewWatcher() 
 if err != nil {
 log.Fatal(err)
 }
 defer watcher.Close()
 
 // we have to watch the entire directory to pick up renames/atomic saves in a cross-platform way
 filename, err := v.getConfigFile() 
 if err != nil {
 log.Println("error:", err)
 return
 }
 
 configFile := filepath.Clean(filename)  //配置文件E:\etc\bizsvc\config.yml
 configDir, _ := filepath.Split(configFile) // E:\etc\bizsvc\

 
 done := make(chan bool)
 go func() {
 for {
 select {
    // 讀取的event對象有兩個屬性，Name為E:\etc\bizsvc\config.yml，Op為write（對文件的操作）
 case event := -watcher.Events:
 // 清除內(nèi)部的..和他前面的元素，清除當(dāng)前路徑.，用來判斷操作的文件是否是configFile
  if filepath.Clean(event.Name) == configFile {
    // 如果對該文件進(jìn)行了創(chuàng)建操作或?qū)懖僮?
  if event.Opfsnotify.Write == fsnotify.Write || event.Opfsnotify.Create == fsnotify.Create {
  err := v.ReadInConfig()
  if err != nil {
  log.Println("error:", err)
  }
  v.onConfigChange(event)
  }
  }
 case err := -watcher.Errors:
     // 有錯誤將打印
  log.Println("error:", err)
 }
 }
 }() 
 watcher.Add(configDir)
 -done
 }()
}

其中，fsnotify是用來監(jiān)控目錄及文件的第三方庫； watcher, err := fsnotify.NewWatcher() 用來建立新的監(jiān)視處理程序，它會開啟一個協(xié)程開始等待讀取事件，完成從I / O完成端口讀取任務(wù)，將事件注入到Event對象中，即Watcher.Events；

執(zhí)行v.ReadInConfig()后配置文件的內(nèi)容將重新讀取到viper實例中，如下圖：

執(zhí)行完v.ReadInConfig()后,config字段的內(nèi)容已經(jīng)是用戶修改的最新內(nèi)容了；

其中這行v.onConfigChange(event)的onConfigChange是核心結(jié)構(gòu)體Viper的一個屬性，類型是func：

type Viper struct {
 // Delimiter that separates a list of keys
 // used to access a nested value in one go
 keyDelim string
 
 // A set of paths to look for the config file in
 configPaths []string
 
 // The filesystem to read config from.
 fs afero.Fs
 
 // A set of remote providers to search for the configuration
 remoteProviders []*defaultRemoteProvider
 
 // Name of file to look for inside the path
 configName string
 configFile string
 configType string
 envPrefix string
 
 automaticEnvApplied bool
 envKeyReplacer  *strings.Replacer
 
 config   map[string]interface{}
 override  map[string]interface{}
 defaults  map[string]interface{}
 kvstore  map[string]interface{}
 pflags   map[string]FlagValue
 env   map[string]string
 aliases  map[string]string
 typeByDefValue bool
 
 // Store read properties on the object so that we can write back in order with comments.
 // This will only be used if the configuration read is a properties file.
 properties *properties.Properties
 
 onConfigChange func(fsnotify.Event)
}

它用來傳入本次event來執(zhí)行你寫的函數(shù)。為什么修改會立即生效？相信第二個疑問已經(jīng)得到解決了。

接下來看看OnConfigChange(func(e fsnotify.Event) {...... })的運行情況：

func (v *Viper) OnConfigChange(run func(in fsnotify.Event)) {
 v.onConfigChange = run
}

方法參數(shù)為一個函數(shù)，類型為func(in fsnotify.Event)) {}，這就意味著開發(fā)者需要把你自己的執(zhí)行邏輯放到這個func里面，在監(jiān)聽到event時就會執(zhí)行你寫的函數(shù)，所以就可以這樣寫：

 viperInstance.OnConfigChange(func(e fsnotify.Event) {
 log.Print("Config file updated.")
 viperLoadConf(viperInstance) // viperLoadConf函數(shù)就是將最新配置注入到自定義結(jié)構(gòu)體對象的邏輯
 })

而OnConfigChange方法的參數(shù)會賦值給形參run并傳到viper實例的onConfigChange屬性，以WatchConfig()方法中的v.onConfigChange(event)來執(zhí)行這個函數(shù)。

到此，第一個疑問也就解決了。

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。如有錯誤或未考慮完全的地方，望不吝賜教。

您可能感興趣的文章:

Golang 限流器的使用和實現(xiàn)示例
Golang實現(xiàn)請求限流的幾種辦法(小結(jié))
聊聊Golang中很好用的viper配置模塊
golang常用庫之配置文件解析庫-viper使用詳解
golang 使用 viper 讀取自定義配置文件
golang接口IP限流,IP黑名單,IP白名單的實例

標(biāo)簽：武漢保定黔西松原宜春河池泰安鷹潭

巨人網(wǎng)絡(luò)通訊聲明：本文標(biāo)題《Golang使用第三方包viper讀取yaml配置信息操作》，本文關(guān)鍵詞 Golang,使用,第三方,包,viper,；如發(fā)現(xiàn)本文內(nèi)容存在版權(quán)問題，煩請?zhí)峁┫嚓P(guān)信息告之我們，我們將及時溝通與處理。本站內(nèi)容系統(tǒng)采集于網(wǎng)絡(luò)，涉及言論、版權(quán)與本站無關(guān)。