详解go基于viper实现配置文件热更新及其源码分析

拔剑起蒿莱

go第三方库 github.com/spf13/viper  实现了对配置文件的读取并注入到结构中，好用方便。
其中以

1. viperInstance := viper.New()        // viper实例
   
2. viperInstance.WatchConfig()
   
3. viperInstance.OnConfigChange(func(e fsnotify.Event) {
   
4.         log.Print("Config file updated.")
   
5.         viperLoadConf(viperInstance)  // 加载配置的方法
   
6. })

复制代码

可实现配置的热更新，不用重启项目新配置即可生效（实现热加载的方法也不止这一种，比如以文件的上次修改时间来判断等）。
为什么这么写？这样写为什么就能立即生效？基于这两个问题一起来看看viper是怎样实现热更新的。
上面代码的核心一共两处：WatchConfig()方法、OnConfigChange()方法。WatchConfig()方法用来开启事件监听，确定用户操作文件后该文件是否可正常读取，并将内容注入到viper实例的config字段，先来看看WatchConfig()方法：

1. func (v *Viper) WatchConfig() {
   
2.         go func() {
   
3.       // 建立新的监视处理程序，开启一个协程开始等待事件
   
4.       // 从I/O完成端口读取，将事件注入到Event对象中：Watcher.Events
   
5.                 watcher, err := fsnotify.NewWatcher()  
   
6.                 if err != nil {
   
7.                         log.Fatal(err)
   
8.                 }
   
9.                 defer watcher.Close()
   
10. 
    
11.                 // we have to watch the entire directory to pick up renames/atomic saves in a cross-platform way
    
12.                 filename, err := v.getConfigFile()  
    
13.                 if err != nil {
    
14.                         log.Println("error:", err)
    
15.                         return
    
16.                 }
    
17. 
    
18.                 configFile := filepath.Clean(filename)    //配置文件E:\etc\bizsvc\config.yml
    
19.                 configDir, _ := filepath.Split(configFile)  // E:\etc\bizsvc\
    
20. 
    
21.                 done := make(chan bool)
    
22.                 go func() {
    
23.                         for {
    
24.                                 select {
    
25.         // 读取的event对象有两个属性，Name为E:\etc\bizsvc\config.yml，Op为write（对文件的操作）
    
26.                                 case event := <-watcher.Events:
    
27.                 // 清除内部的..和他前面的元素，清除当前路径.，用来判断操作的文件是否是configFile
    
28.                                         if filepath.Clean(event.Name) == configFile {
    
29.         // 如果对该文件进行了创建操作或写操作
    
30.                                                 if event.Op&fsnotify.Write == fsnotify.Write || event.Op&fsnotify.Create == fsnotify.Create {
    
31.                                                         err := v.ReadInConfig()
    
32.                                                         if err != nil {
    
33.                                                                 log.Println("error:", err)
    
34.                                                         }
    
35.                                                         v.onConfigChange(event)
    
36.                                                 }
    
37.                                         }
    
38.                                 case err := <-watcher.Errors:
    
39.          // 有错误将打印
    
40.                                         log.Println("error:", err)
    
41.                                 }
    
42.                         }
    
43.                 }()
    
44. 
    
45.                 watcher.Add(configDir)
    
46.                 <-done
    
47.         }()
    
48. }

复制代码

其中，fsnotify是用来监控目录及文件的第三方库；  watcher, err := fsnotify.NewWatcher() 用来建立新的监视处理程序，它会开启一个协程开始等待读取事件，完成 从I / O完成端口读取任务，将事件注入到Event对象中，即Watcher.Events；

执行v.ReadInConfig()后配置文件的内容将重新读取到viper实例中，如下图：

执行完v.ReadInConfig()后,config字段的内容已经是用户修改的最新内容了；
其中这行v.onConfigChange(event)的onConfigChange是核心结构体Viper的一个属性，类型是func：

1. type Viper struct {
   
2.         // Delimiter that separates a list of keys
   
3.         // used to access a nested value in one go
   
4.         keyDelim string
   
5. 
   
6.         // A set of paths to look for the config file in
   
7.         configPaths []string
   
8. 
   
9.         // The filesystem to read config from.
   
10.         fs afero.Fs
    
11. 
    
12.         // A set of remote providers to search for the configuration
    
13.         remoteProviders []*defaultRemoteProvider
    
14. 
    
15.         // Name of file to look for inside the path
    
16.         configName string
    
17.         configFile string
    
18.         configType string
    
19.         envPrefix string
    
20. 
    
21.         automaticEnvApplied bool
    
22.         envKeyReplacer   *strings.Replacer
    
23. 
    
24.         config     map[string]interface{}
    
25.         override    map[string]interface{}
    
26.         defaults    map[string]interface{}
    
27.         kvstore    map[string]interface{}
    
28.         pflags     map[string]FlagValue
    
29.         env      map[string]string
    
30.         aliases    map[string]string
    
31.         typeByDefValue bool
    
32. 
    
33.         // Store read properties on the object so that we can write back in order with comments.
    
34.         // This will only be used if the configuration read is a properties file.
    
35.         properties *properties.Properties
    
36. 
    
37.         onConfigChange func(fsnotify.Event)
    
38. }

复制代码

它用来传入本次event来执行你写的函数。为什么修改会立即生效？相信第二个疑问已经得到解决了。
接下来看看OnConfigChange(func(e fsnotify.Event) {...... })的运行情况：

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

复制代码

方法参数为一个函数，类型为func(in fsnotify.Event)) {}，这就意味着开发者需要把你自己的执行逻辑放到这个func里面，在监听到event时就会执行你写的函数，所以就可以这样写：

1.         viperInstance.OnConfigChange(func(e fsnotify.Event) {
   
2.                 log.Print("Config file updated.")
   
3.                 viperLoadConf(viperInstance)  // viperLoadConf函数就是将最新配置注入到自定义结构体对象的逻辑
   
4.         })

复制代码

而OnConfigChange方法的参数会赋值给形参run并传到viper实例的onConfigChange属性，以WatchConfig()方法中的v.onConfigChange(event)来执行这个函数。
到此，第一个疑问也就解决了。
到此这篇关于详解go基于viper实现配置文件热更新及其源码分析的文章就介绍到这了,更多相关go viper文件热更新内容请搜索晓枫资讯以前的文章或继续浏览下面的相关文章希望大家以后多多支持晓枫资讯！

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

fge792351

感谢楼主分享。

123463479

顶顶更健康！！！

吗一修查

感谢楼主，顶。