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

go实现redigo的简单操作
golang操作redis主要有两个库，go-redis和redigo，今天我们就一起来介绍一下redigo的实现方法，需要的朋友可以参考下
2018-07-07
详解Golang官方中的一致性哈希组件
这篇文章主要为大家详细介绍了Golang官方中的一致性哈希组件的相关知识，文中的示例代码讲解详细，感兴趣的小伙伴可以跟随小编一起学习一下
2023-04-04
Go-RESTful实现下载功能思路详解
这篇文章主要介绍了Go-RESTful实现下载功能,文件下载包括文件系统IO和网络IO，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-10-10
Golang通脉之方法详情
这篇文章主要介绍了Golang通脉方法，Go语言中的方法（Method）是一种作用于特定类型变量的函数。这种特定类型变量叫做接收者（Receiver）。接收者的概念就类似于，其他语言中的this或者 self，具体内容请和小编一起来学习下面文章内容吧
2021-10-10
详解prometheus监控golang服务实践记录
这篇文章主要介绍了详解prometheus监控golang服务实践记录,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-11-11
Go语言中使用urfave/cli命令行框架
这篇文章介绍了Go语言中使用urfave/cli命令行框架的方法，文中通过示例代码介绍的非常详细。对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-07-07
Go语言转化php数组的示例代码
这篇文章主要为大家详细介绍了Go语言如何实现转化php数组的相关知识,文中的示例代码讲解详细,对我们深入学习GO语言有一定的帮助,需要的可以参考下
2023-11-11
Golang开发gRPC服务入门介绍
这篇文章主要介绍了Golang开发gRPC服务,Golang开发gRPC应用程序的套路也已经很清晰，这篇文章就来做一个简单的介绍，算是入门，需要的朋友可以参考下
2022-04-04
Golang中tinyrpc框架的源码解读详解
tinyrpc是一个高性能的基于protocol buffer的rpc框架。项目代码非常少，很适合初学者进行golang的学习。本文将从源码的角度带大家了解tinyrpc框架的使用，需要的可以参考一下
2023-01-01
go mutex互斥锁使用Lock和Unlock方法占有释放资源
Go号称是为了高并发而生的,在高并发场景下,势必会涉及到对公共资源的竞争,当对应场景发生时,我们经常会使用 mutex 的 Lock() 和 Unlock() 方法来占有或释放资源,虽然调用简单,但 mutex 的内部却涉及挺多的,本文来好好研究一下
2023-09-09