Golang配置管理Viper的实现

 更新时间:2025年07月25日 09:30:23   作者:小许cod  
Viper是Go语言配置管理库,支持JSON/YAML/TOML等多格式,可动态监听配置变更,本文就来介绍一下Golang配置管理Viper的实现,感兴趣的可以了解一下

viper简介

Viper 是一个完整的 Go 应用程序配置解决方案,优势就在于开发项目中你不必去操心配置文件的格式而是让你腾出手来专注于项目的开发。其特性如下:

  • 支持 JSON/TOML/YAML/HCL/envfile/Java properties 等多种格式的配置文件
  • 可以设置监听配置文件的修改,修改时自动加载新的配置
  • 从环境变量、命令行选项和io.Reader,远程K/V中读取配置
  • 从远程配置系统中读取和监听修改,如 etcd/Consul
  • 代码逻辑中显示设置键值

总结起来就是支持多种类型,支持动态更新,而且非常便捷。毕竟大家都用的东西肯定是得到了大部分人的认可!

基本使用

使用流程可以概括为设置文件名(SetConfigName)、配置类型(SetConfigType )和搜索路径( AddConfigPath),然后读取配置(ReadInConfig)。
因为Viper没有默认配置,因为需要在初始化前告诉上面这些信息

viperConfig.SetConfigName("config")
viperConfig.SetConfigType("yaml")
viperConfig.AddConfigPath("/etc/appname/")  
err := viperConfig.ReadInConfig() 
if err != nil {
    panic(fmt.Errorf("Fatal error config file: %w \n", err))
}

从Viper中获取配置值得方式

如下有一个redis的yaml文件的配置

redis:
    user:admin                
    password: 123456          
    host: 127.0.0.1
    port: 6379               
    database: 0  

主要有以下方式获取配置的值,没有找到对应的值将返回对应类型的零值,比如 int返回0

Get(key string) : interface{}
GetBool(key string) : bool
GetFloat64(key string) : float64
GetInt(key string) : int
GetIntSlice(key string) : []int
GetString(key string) : string
GetStringMap(key string) : map[string]interface{}
GetStringMapString(key string) : map[string]string
GetStringSlice(key string) : []string
GetTime(key string) : time.Time
GetDuration(key string) : time.Duration
IsSet(key string) : bool
AllSettings() : map[string]interface{}

获取嵌套类型的user的值

GetString("redis.user")

如果你需要一次性加载所有文件到并解析到变量中,可以用viper.Unmarshal,将会以map[struct{}]的形式解析。或者只需要一部分配置时,比如解析到struct可以用UnmarshalKey,其实redis就是Key指的是对应的redis配置的父节点。

viper.Unmarshal(&ConfigSetting)
viper.UnmarshalKey("redis", &param.RedisConfig)

从IO/Reader中获取配置

自定义配置源

viper.SetConfigType("yaml") 

// 你的程序需要的任何配置,如下
var yamlDemo = []byte(`
name: zhangsan
age:18
`)

viper.ReadConfig(bytes.NewBuffer(yamlDemo))

viper.Get("name") //获取到的值是zhangsan

io.Reader读取配置,Viper.Set将设置并覆盖配置值

监听读取配置

运行时动态读取更新配置能力是非常方便的,如果不能动态更新配置,那么线上的服务要修改某个配置就不得不重启服务,Viper支持在程序运行时动态的监听配置。只需告诉viper实例watchConfig,前提是在基本使用部分一样设置文件名,类型等配置

viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
  // 配置文件发生变更之后会调用的回调函数
    fmt.Println("Config file changed:", e.Name)
})

配置说明:WatchConfig()方法、OnConfigChange()方法。WatchConfig()方法用来开启事件监听,确定用户操作文件后该文件是否可正常读取,并将内容注入到viper实例的config字段

viper的动态监听配置时使用的fsnotify,fsnotify是用来监控目录及文件的第三方库; watcher, err := fsnotify.NewWatcher() 用来建立新的监视处理程序,它会开启一个协程开始等待读取事件,完成 从I / O完成端口读取任务,将事件注入到Event对象中,即Watcher.Events,具体大家可以看看源码。

读取远程配置

从Etcd中或Consul中读取配置,在Viper中启用远程支持需要导入viper/remote这个包,并且使用viper.AddRemoteProvider

import _ "github.com/spf13/viper/remote"

viper.AddSecureRemoteProvider("etcd",
        "https://127.0.0.1:2379",
        "conf.yaml",
        "key_path")
viper.SetConfigType("yaml")
err := viper.ReadRemoteConfig()
viper.Unmarshal(&remoteConfig)
if err != nil {
    panic(err)

总结

Viper基本的使用介绍就这些了, 虽然viper支持多配置同时使用,但是一个Viper实例只能寻一个配置路径。至于很多细节我们多去实践就很清楚啦

到此这篇关于Golang配置管理Viper的实现的文章就介绍到这了,更多相关Golang配置管理Viper内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 详解Golang中哪些类型可以作为map的key

    详解Golang中哪些类型可以作为map的key

    在 Go 语言中,map 是一种内置的关联数据结构类型,由一组无序的键值对组成,每个键都是唯一的,并与一个对应的值相关联,本文将详细介绍哪些类型的变量可以作为 map 的键,并通过实例进行说明,感兴趣的朋友可以参考下
    2024-01-01
  • GoFrame框架数据校验之校验对象校验结构体

    GoFrame框架数据校验之校验对象校验结构体

    这篇文章主要为大家介绍了GoFrame框架数据校验之校验对象校验结构体示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-06-06
  • Go语言Seeker接口与文件断点续传实战教程

    Go语言Seeker接口与文件断点续传实战教程

    Go语言的io包中Seeker接口为大文件处理或需要随机访问的场景提供了强大的支持,本文通过具体案例详细介绍了Seeker接口的应用,包括随机访问大文件、断点续传等场景,以及如何使用Seeker接口进行有效的文件读写操作
    2024-10-10
  • golang中json的omitempty使用操作

    golang中json的omitempty使用操作

    这篇文章主要介绍了golang中json的omitempty使用操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • GOLANG版的冒泡排序和快速排序分享

    GOLANG版的冒泡排序和快速排序分享

    这篇文章主要介绍了GOLANG版的冒泡排序和快速排序分享,需要的朋友可以参考下
    2015-03-03
  • Go项目编写Makefile规则文件概述

    Go项目编写Makefile规则文件概述

    这篇文章主要为大家介绍了Go项目编写Makefile文件规则概述,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步早日升职加薪
    2022-04-04
  • GoLang string类型深入分析

    GoLang string类型深入分析

    string 作为 go 语言中的基础类型,其实有一些需要反复揣摩的,可能是我们使用的场景太简单,也可能是我们不需要那可怜的一点优化来提高性能,对它也就没那么上心了
    2023-01-01
  • golang中使用aes加密的过程

    golang中使用aes加密的过程

    AES(Advanced Encryption Standard)是一种对称加密算法,适用于加密敏感数据,本文给大家介绍golang中使用aes加密的相关知识,感兴趣的朋友跟随小编一起看看吧
    2025-11-11
  • Go语言实现冒泡排序、选择排序、快速排序及插入排序的方法

    Go语言实现冒泡排序、选择排序、快速排序及插入排序的方法

    这篇文章主要介绍了Go语言实现冒泡排序、选择排序、快速排序及插入排序的方法,以实例形式详细分析了几种常见的排序技巧与实现方法,非常具有实用价值,需要的朋友可以参考下
    2015-02-02
  • 详解Go语言中rand(随机数)包的使用

    详解Go语言中rand(随机数)包的使用

    在Golang中,有两个包提供了rand,分别为math/rand和crypto/rand对应两种应用场景。math/rand包实现了伪随机数生成器。也就是生成 整形和浮点型;crypto/rand包实现了用于加解密的更安全的随机数生成器。本文就来和大家详细讲讲math/rand的使用
    2022-08-08

最新评论