詳解go基于viper實(shí)現(xiàn)配置文件熱更新及其源碼分析
go第三方庫(kù) github.com/spf13/viper 實(shí)現(xiàn)了對(duì)配置文件的讀取并注入到結(jié)構(gòu)中,好用方便。
其中以
viperInstance := viper.New() // viper實(shí)例
viperInstance.WatchConfig()
viperInstance.OnConfigChange(func(e fsnotify.Event) {
log.Print("Config file updated.")
viperLoadConf(viperInstance) // 加載配置的方法
})
可實(shí)現(xiàn)配置的熱更新,不用重啟項(xiàng)目新配置即可生效(實(shí)現(xiàn)熱加載的方法也不止這一種,比如以文件的上次修改時(shí)間來(lái)判斷等)。
為什么這么寫(xiě)?這樣寫(xiě)為什么就能立即生效?基于這兩個(gè)問(wèn)題一起來(lái)看看viper是怎樣實(shí)現(xiàn)熱更新的。
上面代碼的核心一共兩處:WatchConfig()方法、OnConfigChange()方法。WatchConfig()方法用來(lái)開(kāi)啟事件監(jiān)聽(tīng),確定用戶操作文件后該文件是否可正常讀取,并將內(nèi)容注入到viper實(shí)例的config字段,先來(lái)看看WatchConfig()方法:
func (v *Viper) WatchConfig() {
go func() {
// 建立新的監(jiān)視處理程序,開(kāi)啟一個(gè)協(xié)程開(kāi)始等待事件
// 從I/O完成端口讀取,將事件注入到Event對(duì)象中: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對(duì)象有兩個(gè)屬性,Name為E:\etc\bizsvc\config.yml,Op為write(對(duì)文件的操作)
case event := <-watcher.Events:
// 清除內(nèi)部的..和他前面的元素,清除當(dāng)前路徑.,用來(lái)判斷操作的文件是否是configFile
if filepath.Clean(event.Name) == configFile {
// 如果對(duì)該文件進(jìn)行了創(chuàng)建操作或?qū)懖僮?
if event.Op&fsnotify.Write == fsnotify.Write || event.Op&fsnotify.Create == fsnotify.Create {
err := v.ReadInConfig()
if err != nil {
log.Println("error:", err)
}
v.onConfigChange(event)
}
}
case err := <-watcher.Errors:
// 有錯(cuò)誤將打印
log.Println("error:", err)
}
}
}()
watcher.Add(configDir)
<-done
}()
}
其中,fsnotify是用來(lái)監(jiān)控目錄及文件的第三方庫(kù); watcher, err := fsnotify.NewWatcher() 用來(lái)建立新的監(jiān)視處理程序,它會(huì)開(kāi)啟一個(gè)協(xié)程開(kāi)始等待讀取事件,完成 從I / O完成端口讀取任務(wù),將事件注入到Event對(duì)象中,即Watcher.Events;

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

執(zhí)行完v.ReadInConfig()后,config字段的內(nèi)容已經(jīng)是用戶修改的最新內(nèi)容了;
其中這行v.onConfigChange(event)的onConfigChange是核心結(jié)構(gòu)體Viper的一個(gè)屬性,類型是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)
}
它用來(lái)傳入本次event來(lái)執(zhí)行你寫(xiě)的函數(shù)。為什么修改會(huì)立即生效?相信第二個(gè)疑問(wèn)已經(jīng)得到解決了。
接下來(lái)看看OnConfigChange(func(e fsnotify.Event) {...... })的運(yùn)行情況:
func (v *Viper) OnConfigChange(run func(in fsnotify.Event)) {
v.onConfigChange = run
}
方法參數(shù)為一個(gè)函數(shù),類型為func(in fsnotify.Event)) {},這就意味著開(kāi)發(fā)者需要把你自己的執(zhí)行邏輯放到這個(gè)func里面,在監(jiān)聽(tīng)到event時(shí)就會(huì)執(zhí)行你寫(xiě)的函數(shù),所以就可以這樣寫(xiě):
viperInstance.OnConfigChange(func(e fsnotify.Event) {
log.Print("Config file updated.")
viperLoadConf(viperInstance) // viperLoadConf函數(shù)就是將最新配置注入到自定義結(jié)構(gòu)體對(duì)象的邏輯
})
而OnConfigChange方法的參數(shù)會(huì)賦值給形參run并傳到viper實(shí)例的onConfigChange屬性,以WatchConfig()方法中的v.onConfigChange(event)來(lái)執(zhí)行這個(gè)函數(shù)。
到此,第一個(gè)疑問(wèn)也就解決了。
到此這篇關(guān)于詳解go基于viper實(shí)現(xiàn)配置文件熱更新及其源碼分析的文章就介紹到這了,更多相關(guān)go viper文件熱更新內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
詳解Go語(yǔ)言單元測(cè)試中如何解決MySQL存儲(chǔ)依賴問(wèn)題
MySQL?存儲(chǔ)就是一個(gè)非常常見(jiàn)的外部依賴,這篇文章主要來(lái)和大家一起探討在?Go?語(yǔ)言中編寫(xiě)單元測(cè)試時(shí),如何解決?MySQL?存儲(chǔ)依賴,需要的可以參考一下2023-07-07
golang跳轉(zhuǎn)語(yǔ)句goto,break,continue的使用及區(qū)別說(shuō)明
這篇文章主要介紹了golang跳轉(zhuǎn)語(yǔ)句goto,break,continue的使用及區(qū)別說(shuō)明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2020-12-12
一文教你如何快速學(xué)會(huì)Go的struct數(shù)據(jù)類型
結(jié)構(gòu)是表示字段集合的用戶定義類型。它可以用于將數(shù)據(jù)分組為單個(gè)單元而不是將每個(gè)數(shù)據(jù)作為單獨(dú)的值的地方。本文就來(lái)和大家聊聊Go中struct數(shù)據(jù)類型的使用,需要的可以參考一下2023-03-03
golang編程入門(mén)之http請(qǐng)求天氣實(shí)例
這篇文章主要介紹了golang編程入門(mén)之http請(qǐng)求天氣實(shí)例,小編覺(jué)得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過(guò)來(lái)看看吧2018-08-08
一文告訴你大神是如何學(xué)習(xí)Go語(yǔ)言之make和new
當(dāng)我們想要在 Go 語(yǔ)言中初始化一個(gè)結(jié)構(gòu)時(shí),其實(shí)會(huì)使用到兩個(gè)完全不同的關(guān)鍵字,也就是 make 和 new,同時(shí)出現(xiàn)兩個(gè)用于『初始化』的關(guān)鍵字對(duì)于初學(xué)者來(lái)說(shuō)可能會(huì)感到非常困惑,不過(guò)它們兩者有著卻完全不同的作用,本文就和大家詳細(xì)講講2023-02-02
go 實(shí)現(xiàn)簡(jiǎn)易端口掃描的示例
該功能實(shí)現(xiàn)原理很簡(jiǎn)單,就是發(fā)送socket連接(IP+端口),如果能連接成功,說(shuō)明目標(biāo)主機(jī)開(kāi)放了某端口。當(dāng)要大量掃描端口時(shí),就需要寫(xiě)并發(fā)編程了。2021-05-05
Go語(yǔ)言-為什么返回值為接口類型,卻返回結(jié)構(gòu)體
這篇文章主要介紹了Go語(yǔ)言返回值為接口類型,卻返回結(jié)構(gòu)體的實(shí)例講解,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2021-04-04

