Golang使⽤第三⽅包viper读取yaml配置信息操作Golang有很多第三⽅包,其中的 viper ⽀持读取多种配置⽂件信息。本⽂只是做⼀个⼩⼩demo,⽤来学习⼊门⽤的。
1、安装
go get github/spf13/viper
2、编写⼀个yaml的配置⽂件,config.yaml
database:
host: 127.0.0.1
user: root
dbname: test
pwd: 123456
3、编写学习脚本,读取config.yaml配置信息
package main
import (
"fmt"
"os"
"github/spf13/viper"
)
func main() {
//获取项⽬的执⾏路径
path, err := os.Getwd()
if err != nil {
panic(err)
}
config := viper.New()
config.AddConfigPath(path) //设置读取的⽂件路径
config.SetConfigName("config") //设置读取的⽂件名
config.SetConfigType("yaml") //设置⽂件的类型
//尝试进⾏配置读取
if err := config.ReadInConfig(); err != nil {
panic(err)
}
//打印⽂件读取出来的内容:
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、执⾏go
输出:
127.0.0.1
root
test
123456
ok!
补充:go基于viper实现配置⽂件热更新及其源码分析
go第三⽅库 github/spf13/viper 实现了对配置⽂件的读取并注⼊到结构中,好⽤⽅便。
其中以
viperInstance := viper.New() // viper实例
viperInstance.WatchConfig()
viperInstance.OnConfigChange(func(e fsnotify.Event) {
log.Print("Config file updated.")
viperLoadConf(viperInstance) // 加载配置的⽅法
})
可实现配置的热更新,不⽤重启项⽬新配置即可⽣效(实现热加载的⽅法也不⽌这⼀种,⽐如以⽂件的上次修改时间来判断等)。
为什么这么写?这样写为什么就能⽴即⽣效?基于这两个问题⼀起来看看viper是怎样实现热更新的。
上⾯代码的核⼼⼀共两处:WatchConfig()⽅法、OnConfigChange()⽅法。WatchConfig()⽅法⽤来开启事件监听,确定⽤户操作⽂件后该⽂件是否可正常读取,并将内容注⼊到viper实例的config字段,先来看看WatchConfig()⽅法:
func (v *Viper) WatchConfig() {
go func() {
// 建⽴新的监视处理程序,开启⼀个协程开始等待事件
// 从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\l
configDir, _ := filepath.Split(configFile) // E:\etc\bizsvc\
done := make(chan bool)
go func() {
for {
select {
// 读取的event对象有两个属性,Name为E:\etc\l,Op为write(对⽂件的操作)
case event := <-watcher.Events:
// 清除内部的..和他前⾯的元素,清除当前路径.,⽤来判断操作的⽂件是否是configFile
if filepath.Clean(event.Name) == configFile {
// 如果对该⽂件进⾏了创建操作或写操作
if event.Op&fsnotify.Write == fsnotify.Write || event.Op&fsnotify.Create == fsnotify.Create {
err := v.ReadInConfig()
if err != nil {
log.Println("error:", err)
}
}
}
case err := <-watcher.Errors:
// 有错误将打印
log.Println("error:", err)
}
}
}()
watcher.Add(configDir)
<-done
}()
}
其中,fsnotify是⽤来监控⽬录及⽂件的第三⽅库; watcher, err := fsnotify.NewWatcher() ⽤来建⽴新的监视处理程序,它会开启⼀个协程开始等待读取事件,完成从I / O完成端⼝读取任务,将事件注⼊到Event对象中,即Watcher.Events;
spring怎么读取yaml
执⾏v.ReadInConfig()后配置⽂件的内容将重新读取到viper实例中,如下图:
执⾏完v.ReadInConfig()后,config字段的内容已经是⽤户修改的最新内容了;
其中这⾏v.onConfigChange(event)的onConfigChange是核⼼结构体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来执⾏你写的函数。为什么修改会⽴即⽣效?相信第⼆个疑问已经得到解决了。
接下来看看OnConfigChange(func(e fsnotify.Event) {...... })的运⾏情况:
func (v *Viper) OnConfigChange(run func(in fsnotify.Event)) {
}
⽅法参数为⼀个函数,类型为func(in fsnotify.Event)) {},这就意味着开发者需要把你⾃⼰的执⾏逻辑放到这个func⾥⾯,在监听到event时就会执⾏你写的函数,所以就可以这样写:
viperInstance.OnConfigChange(func(e fsnotify.Event) {
log.Print("Config file updated.")
viperLoadConf(viperInstance) // viperLoadConf函数就是将最新配置注⼊到⾃定义结构体对象的逻辑
})
⽽OnConfigChange⽅法的参数会赋值给形参run并传到viper实例的onConfigChange属性,以WatchConfig()⽅法中的
到此,第⼀个疑问也就解决了。
以上为个⼈经验,希望能给⼤家⼀个参考,也希望⼤家多多⽀持。如有错误或未考虑完全的地⽅,望不吝赐教。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论