Golang工具库viper的使用教程

更新时间：2023年07月21日 14:25:54 作者：uccs

viper 是 go 项目中用来读取配置文件的库，支持读取 yaml、toml、json、hcl、env 等格式的配置文件，下面就来和大家聊聊它的具体使用吧

读取环境变量

viper 可以读取终端的环境变量

如果你用的是 zsh 在 ~/.zshrc 中设置，如果是 bash 在 ~/.bashrc 中设置

写环境变量时，等号两边不能有空格，否则会报错

export APP_DEBUG=true

写好后，记得 source 一下，或者重启终端

source ~/.zshrc

使用 viper.AutomaticEnv 将环境变量都读取到 viper 中

然后就可以使用 viper.GetBool("APP_DEBUG") 来获取环境变量了

func GetEnvInfo(env string) bool {
	viper.AutomaticEnv()
	return viper.GetBool(env)
}
app_debug := GetEnvInfo("APP_DEBUG")
fmt.Println(app_debug) // true

读取本地的配置文件

新建一个 config-debug.yaml 文件，内容如下：

host: "127.0.0.1"
port: 50051

然后使用 viper 读取，setConfigFile 填写的路径是相对于 main.go 的路径

使用 viper.ReadInConfig 来读取配置文件

viper.SetConfigFile("./config-debug.yaml")
if err := viper.ReadInConfig(); err != nil {
  panic(err)
}
fmt.Println(viper.GetString("host")) // "127.0.0.1"

使用 viper.SetConfigName 来设置文件名，viper.SetConfigType 来设置文件类型，可以更灵活的读取配置文件

viper.SetConfigName 设置文件名，不需要带后缀
viper.SetConfigType 设置文件类型
viper.AddConfigPath 设置文件路径

viper.SetConfigName("config-debug")
viper.SetConfigType("yaml")
viper.AddConfigPath("./")
if err := viper.ReadInConfig(); err != nil {
  panic(err)
}
fmt.Println(viper.GetString("host")) // "127.0.0.1"

将配置文件中的配置映射到结构体中

每次使用 viper.GetString 来获取配置文件中的配置，都会写很多重复的代码，可以将配置文件中的配置映射到结构体中

新建结构体，结构体的字段名要和配置文件中的字段名一致，使用 mapstructure 标签来映射

type Server struct {
  Host string `mapstructure:"host"`
  Port int    `mapstructure:"port"`
}

使用 viper.Unmarshal 将配置文件中的配置映射到结构体中

var server Server
viper.SetConfigName("config-debug")
viper.SetConfigType("yaml")
viper.AddConfigPath("./")
if err := viper.ReadInConfig(); err != nil {
  panic(err)
}
if err := viper.Unmarshal(&server); err != nil {
	panic(err)
}
fmt.Println(server.Host) // "127.0.0.1"

监听配置信息的变化

如果配置文件发生变化，viper 支持在运行时监听配置文件的变化

使用 viper.WatchConfig 来监听配置文件的变化，使用 viper.OnConfigChange 来监听配置文件的变化

onConfigChange 传入的参数是一个函数，函数的参数是 fsnotify.Event，在函数中重新读取配置文件，然后将配置文件中的配置映射到结构体中

viper.OnConfigChange(func(e fsnotify.Event) {
  _ = viper.ReadInConfig()
  _ = viper.Unmarshal(&server)
})
viper.WatchConfig()

到此这篇关于Golang工具库viper的使用教程的文章就介绍到这了,更多相关Golang viper内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

Go
viper

golang中sync.Mutex的实现方法
本文主要介绍了golang中sync.Mutex的实现方法，mutex 主要有两个 method: Lock() 和 Unlock()，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-04-04
go语言遍历文件夹示例
这篇文章主要介绍了go语言遍历文件夹示例,本文直接给出实现代码,需要的朋友可以参考下
2015-03-03
Golang实现不被复制的结构体的方法
sync包中的许多结构都是不允许拷贝的，因为它们自身存储了一些状态(比如等待者的数量)，如果你尝试复制这些结构体，就会在你的 IDE中看到警告，那这是怎么实现的呢，下文就来和大家详细讲讲
2023-03-03
Golang Cron 定时任务的实现示例
这篇文章主要介绍了Golang Cron 定时任务的实现示例，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2020-05-05
Go语言实现本地缓存的策略详解
今天给大家分享的是Go语言本地缓存的一些内容，主要是结合bigcache和fastcache两个优秀的开源代码库，总结一些设计思路和感悟，文章通过代码示例介绍的非常详细,需要的朋友可以参考下
2023-07-07
Go 实现英尺和米的简单单位换算方式
这篇文章主要介绍了Go 实现英尺和米的简单单位换算方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-04-04
go语言生成随机数和随机字符串的实现方法
随机数在很多时候都可以用到，尤其是登录时，本文就详细的介绍一下go语言生成随机数和随机字符串的实现方法，具有一定的参考价值，感兴趣的可以了解一下
2021-12-12
详解Go module的介绍及使用
module是一个相关Go包的集合，它是源代码更替和版本控制的单元。这篇文章主要介绍了Go module的介绍及使用,需要的朋友可以参考下
2020-10-10
Golang中函数(Function)和方法(Method)的区别详解
在Golang中，大家必然会频繁使用到函数（Function）和方法（Method），但是有的同学可能并没有注意过函数和方法的异同点，函数和方法都是用来执行特定任务的代码块，虽然很相似，但也有很大的区别，所以本文将详细讲解函数和方法的定义以及它们的异同点
2023-07-07
go语言检测文件是否存在的方法
这篇文章主要介绍了go语言检测文件是否存在的方法,实例分析了Go语言文件操作的相关技巧,需要的朋友可以参考下
2015-03-03