详解Golang如何动态获取配置文件

 更新时间:2023年08月29日 10:42:59   作者:wmm369  
项目中经常获取一些常用配置文件,当有配置文件中的参数被修改后,如何的实时获取配置文件就很关键了,下面小编就来讲讲如何利用viper实时获取配置文件吧

项目中经常获取一些常用配置文件,当有配置文件中的参数被修改后,如何的实时获取配置文件就很关键了。这里推荐"viper"这个包,用来实时获取配置文件。

1.VIPER简介

viper【蝰蛇】

Viper是适用于Go应用程序的完整配置解决方案。它旨在在应用程序中工作,并且可以处理所有类型的配置需求和格式。它支持:

  • 设置默认值
  • 从JSON,TOML,YAML,HCL,envfile和Java属性配置文件中读取
  • 实时观看和重新读取配置文件(可选)
  • 从环境变量中读取
  • 从远程配置系统(etcd或Consul)中读取,并观察更改
  • 从命令行标志读取
  • 从缓冲区读取
  • 设置显式值

可以将Viper视为满足您所有应用程序配置需求的注册表。

2.使用说明

本文中的实例都是从viper的官方介绍中复制过来,只是介绍了简单的使用。完整的实例请查看【https://pkg.go.dev/github.com...

2.1建立默认值

viper.SetDefault("ContentDir", "content")
viper.SetDefault("LayoutDir", "layouts")
viper.SetDefault("Taxonomies", map[string]string{"tag": "tags", "category": "categories"})

2.2读取配置文件

viper.SetConfigName("config") // name of config file (without extension)
viper.SetConfigType("yaml") // REQUIRED if the config file does not have the extension in the name
viper.AddConfigPath("/etc/appname/")   // path to look for the config file in
viper.AddConfigPath("$HOME/.appname")  // call multiple times to add many search paths
viper.AddConfigPath(".")               // optionally look for config in the working directory
err := viper.ReadInConfig() // Find and read the config file
if err != nil { // Handle errors reading the config file
    panic(fmt.Errorf("Fatal error config file: %s \n", err))
}

2.3 读取和重新读取配置文件

viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
    fmt.Println("Config file changed:", e.Name)
})

2.4 获取值

在Viper中,根据值的类型,有几种获取值的方法。存在以下功能和方法:

  • 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{}

3. 实例代码

使用GIN框架,简单配置一个可以通过接口获取配置内容的http服务。当调用接口http://127.0.0.1:8080/getConfig可以获取配置项

步骤1:设置配置文件

在工作目录中创建config.yml文件,文件内容如下:

Version: "2.1"
Debug: false
MongoDB:
  IP: 127.0.0.1
  Port: 27017
  DbName: "db_name"

步骤二:编写服务代码

package main
import (
    "fmt"
    "github.com/fsnotify/fsnotify"
    "github.com/gin-gonic/gin"
    "github.com/spf13/viper"
)
var config *viper.Viper
func main() {
    config = initConfigure()
    r := gin.Default()
    r.GET("/getConfig", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "config": config.AllSettings(),
        })
    })
    r.Run() // listen and serve on 0.0.0.0:8080
}
func initConfigure() *viper.Viper {
    v := viper.New()
    v.SetConfigName("config") // 设置文件名称(无后缀)
    v.SetConfigType("yaml")   // 设置后缀名 {"1.6以后的版本可以不设置该后缀"}
    v.AddConfigPath("./")  // 设置文件所在路径
    v.Set("verbose", true) // 设置默认参数
    if err := v.ReadInConfig(); err != nil {
        if _, ok := err.(viper.ConfigFileNotFoundError); ok {
            panic(" Config file not found; ignore error if desired")
        } else {
            panic("Config file was found but another error was produced")
        }
    }
    // 监控配置和重新获取配置
    v.WatchConfig()
    v.OnConfigChange(func(e fsnotify.Event) {
        fmt.Println("Config file changed:", e.Name)
    })
    return v
}

步骤三:演示:

启动服务,通过postman调用http://127.0.0.1:8080/getConfig 可以获得如下参数:

这个时候把yml文件中的version修改成3.0。这个时候后台会打印输出一句

Config file changed: /Users/Keil/GoLang/src/tutorials/viper/config.yml

这是因为我在代码中调用了两个关键的函数,WatchConfig和OnConfigChange。函数OnConfigChange打印输出了这句,输出代码:
fmt.Println("Config file changed:", e.Name)

关于这两个函数的源码解析和工作原理,可以参考【go基于viper实现配置文件热更新及其源码分析】。里面介绍的比较详细。这里只是介绍如何使用。

此时再次调用接口,配置信息会变成如下:

4.资料链接

Viper简介

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

到此这篇关于详解Golang如何动态获取配置文件的文章就介绍到这了,更多相关Go配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • GO语言基础入门第一个go程序解读

    GO语言基础入门第一个go程序解读

    这篇文章主要为大家介绍了GO语言基础入门的第一个go程序解读,下面来带大家进入Go语言世界helloworld的大门吧,有需要的朋友可以借鉴参考下,希望能够有所帮助
    2021-11-11
  • GoPath模式和GoMoudle模式的相爱相杀

    GoPath模式和GoMoudle模式的相爱相杀

    这篇文章主要介绍了GoPath模式和GoMoudle模式的相爱相杀,本文通过实例图文相结合给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-03-03
  • 一文弄懂用Go实现MCP服务的示例代码

    一文弄懂用Go实现MCP服务的示例代码

    本文主要介绍了一文弄懂用Go实现MCP服务的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2025-04-04
  • Go语言使用net/http实现简单登录验证和文件上传功能

    Go语言使用net/http实现简单登录验证和文件上传功能

    这篇文章主要介绍了Go语言使用net/http实现简单登录验证和文件上传功能,使用net/http模块编写了一个简单的登录验证和文件上传的功能,在此做个简单记录,需要的朋友可以参考下
    2023-07-07
  • 一文详解go闭包(Closure)使用教程

    一文详解go闭包(Closure)使用教程

    在Go语言中,闭包(Closure)是一种特殊的函数,它可以捕获其创建时所在作用域中的变量,本文给大家详细介绍了go闭包(Closure)使用教程,感兴趣的朋友可以参考下
    2024-01-01
  • 谈谈golang的netpoll原理解析

    谈谈golang的netpoll原理解析

    本文详细介绍了Go语言中netpoll部分的实现细节和协程阻塞调度原理,特别是epoll在Linux环境下的工作原理,Go语言通过将epoll操作放在runtime包中,结合运行时调度功能,实现了高效的协程I/O操作,感兴趣的朋友跟随小编一起看看吧
    2024-11-11
  • go数据结构和算法BitMap原理及实现示例

    go数据结构和算法BitMap原理及实现示例

    这篇文章主要为大家介绍了go数据结构和算法BitMap原理及实现示例,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2022-07-07
  • Go语言使用sqlx操作MySQL

    Go语言使用sqlx操作MySQL

    sqlx 包作为一个扩展库,它在 database/sql 的基础上,提供了更高级别的便利,极大地简化了数据库操作,本文章将介绍如何通过sqlx包来操作 MySQL 数据库,感兴趣的可以了解下
    2024-11-11
  • Go语言interface详解

    Go语言interface详解

    这篇文章主要介绍了Go语言interface详解,本文讲解了什么是interface、interface类型、interface值、空interface、interface函数参数等内容,需要的朋友可以参考下
    2014-10-10
  • Go语言文件读取的一些总结

    Go语言文件读取的一些总结

    这篇文章主要介绍了Go语言文件读取的一些总结,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-08-08

最新评论