Go几种读取配置文件的方式

最新推荐文章于 2024-09-01 17:07:46 发布
最新推荐文章于 2024-09-01 17:07:46 发布
阅读量1.9k 收藏 1
点赞数 1
文章标签： 后端
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/techdashen/article/details/132549682
版权

比较有名的方案有

使用viper管理配置[1]


  • 支持多种配置文件格式，包括 JSON,TOML,YAML,HECL,envfile，甚至还包括Java properties
  • 支持为配置项设置默认值
  • 可以通过命令行参数覆盖指定的配置项
  • 支持参数别名

viper[2]按照这个优先级（从高到低）获取配置项的取值：

  • explicit call to Set: 在代码逻辑中通过viper.Set()直接设置配置项的值
  • flag：命令行参数
  • env：环境变量
  • config：配置文件
  • key/value store：etcd或者consul
  • default：默认值

按照这个优先级（从高到低）获取配置项的取值：

  • explicit call to Set: 在代码逻辑中通过viper.Set()直接设置配置项的值
  • flag：命令行参数
  • env：环境变量
  • config：配置文件
  • key/value store：etcd或者consul
  • default：默认值

优先级


验证一下 viper.Set() 的优先级高于 配置文件

package main

import (
 "fmt"

 "github.com/spf13/viper"
)

func main() {

 loadConfig()
}

func loadConfig() {

 configVar := "shuang-config.yaml"
 configVar = "" // 这行如果注释掉，则从指定的configVar读取配置文件；否则就各种条件去找了

 viper.Set("Global.Source", "优先级最高")

 if configVar != "" {
  // SetConfigFile 显式定义配置文件的路径、名称和扩展名。
  // Viper 将使用它而不检查任何配置路径。
  viper.SetConfigFile(configVar)
 } else {

  // 如果没有显式指定配置文件，则

  // 会去下面的路径里找文件名`cui-config`的文件  name of config file (without extension)
  // 按照 []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"}的顺序(居然还支持Java用的properties)
  viper.SetConfigName("cui-config")
  viper.AddConfigPath("/etc/myapp") // 找寻的路径
  viper.AddConfigPath("$HOME/.myapp/")
  viper.AddConfigPath(".")
 }

 err := viper.ReadInConfig()
 if err != nil {
  panic(fmt.Errorf("error reading config: %s", err))
 }

 fmt.Printf("到底用的是哪个配置文件: '%s'\n", viper.ConfigFileUsed())

 fmt.Printf("Global.Source这个字段的值为: '%s'\n", viper.GetString("global.source"))
}

输出:

到底用的是哪个配置文件: '/Users/fliter/config-demo/cui-config.yaml'
Global.Source这个字段的值为: '优先级最高'



验证一下 环境变量 的优先级高于 配置文件

package main

import (
 "fmt"

 "github.com/spf13/viper"
)

func main() {

 loadConfig()
}

func loadConfig() {

 configVar := "shuang-config.yaml"
 configVar = "" // 这行如果注释掉，则从指定的configVar读取配置文件；否则就各种条件去找了

 viper.Set("Global.Source", "优先级最高")
 viper.AutomaticEnv()

 if configVar != "" {
  // SetConfigFile 显式定义配置文件的路径、名称和扩展名。
  // Viper 将使用它而不检查任何配置路径。
  viper.SetConfigFile(configVar)
 } else {

  // 如果没有显式指定配置文件，则

  // 会去下面的路径里找文件名`cui-config`的文件  name of config file (without extension)
  // 按照 []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"}的顺序(居然还支持Java用的properties)
  viper.SetConfigName("cui-config")
  viper.AddConfigPath("/etc/myapp") // 找寻的路径
  viper.AddConfigPath("$HOME/.myapp/")
  viper.AddConfigPath(".")
 }

 err := viper.ReadInConfig()
 if err != nil {
  panic(fmt.Errorf("error reading config: %s", err))
 }

 fmt.Printf("到底用的是哪个配置文件: '%s'\n", viper.ConfigFileUsed())

 fmt.Printf("LANG这个字段的值为: '%s'\n", viper.GetString("LANG"))
}
alt

viper.AutomaticEnv()会绑定所有环境变量，

如果只希望绑定特定的，可以使用SetEnvPrefix("global.source", "MYAPP_GLOAL_SOURCE")，注意这个函数不会自动加上MYAPP的前缀.



验证一下 命令行参数的优先级高于 配置文件

viper可以配合pflag来使用，pflag可以理解为标准库flag的一个增强版，viper可以绑定到pflag上

和cobra，viper一样，pflag也是同一作者的作品

alt


验证一下 默认值的优先级低于 配置文件

package main

import (
 "fmt"

 "github.com/spf13/viper"
)

func main() {

 loadConfig()
}

func loadConfig() {

 configVar := "shuang-config.yaml"
 configVar = "" // 这行如果注释掉，则从指定的configVar读取配置文件；否则就各种条件去找了

 //viper.Set("Global.Source", "优先级最高")
 viper.AutomaticEnv()

 viper.SetDefault("Global.Source", "优先级最低")

 if configVar != "" {
  // SetConfigFile 显式定义配置文件的路径、名称和扩展名。
  // Viper 将使用它而不检查任何配置路径。
  viper.SetConfigFile(configVar)
 } else {

  // 如果没有显式指定配置文件，则

  // 会去下面的路径里找文件名`cui-config`的文件  name of config file (without extension)
  // 按照 []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"}的顺序(居然还支持Java用的properties)
  viper.SetConfigName("cui-config")
  viper.AddConfigPath("/etc/myapp") // 找寻的路径
  viper.AddConfigPath("$HOME/.myapp/")
  viper.AddConfigPath(".")
 }

 err := viper.ReadInConfig()
 if err != nil {
  panic(fmt.Errorf("error reading config: %s", err))
 }

 fmt.Printf("到底用的是哪个配置文件: '%s'\n", viper.ConfigFileUsed())

 fmt.Printf("Global.Source这个字段的值为: '%s'\n", viper.GetString("Global.Source"))
}
alt


Watch机制(配置更新后 热加载)


该机制可以监听配置文件的修改, 这样就实现了热加载，修改配置后，无需重启服务

  • 对于本地文件，是通过fsnotify实现的，然后通过一个回调函数去通知应用来reload;

  • 对于Remote KV Store，目前只支持etcd，做法比较ugly，(5秒钟)轮询一次 而不是watch api

package main

import (
 "fmt"
 "time"

 "github.com/fsnotify/fsnotify"
 "github.com/spf13/viper"
)

func main() {

 loadConfig()
}

func loadConfig() {

 configVar := "shuang-config.yaml"
 configVar = "" // 这行如果注释掉，则从指定的configVar读取配置文件；否则就各种条件去找了

 if configVar != "" {
  // SetConfigFile 显式定义配置文件的路径、名称和扩展名。
  // Viper 将使用它而不检查任何配置路径。
  viper.SetConfigFile(configVar)
 } else {

  // 如果没有显式指定配置文件，则

  // 会去下面的路径里找文件名`cui-config`的文件  name of config file (without extension)
  // 按照 []string{"json", "toml", "yaml", "yml", "properties", "props", "prop", "hcl", "tfvars", "dotenv", "env", "ini"}的顺序(居然还支持Java用的properties)
  viper.SetConfigName("cui-config")
  viper.AddConfigPath("/etc/myapp") // 找寻的路径
  viper.AddConfigPath("$HOME/.myapp/")
  viper.AddConfigPath(".")
 }

 viper.WatchConfig()
 viper.OnConfigChange(func(e fsnotify.Event) {
  fmt.Printf("配置文件 %s 发生了更改!!! 最新的Global.Source这个字段的值为 %s:", e.Name, viper.GetString("Global.Source"))
 })

 err := viper.ReadInConfig()
 if err != nil {
  panic(fmt.Errorf("error reading config: %s", err))
 }

 fmt.Printf("到底用的是哪个配置文件: '%s'\n", viper.ConfigFileUsed())

 fmt.Printf("Global.Source这个字段的值为: '%s'\n", viper.GetString("Global.Source"))

 time.Sleep(10000e9)
}
alt

Go viper 配置文件读取工具[3]

动态获取配置文件(viper）[4]



configor[5]


Configor: 一个Golang配置工具，支持YAML，JSON，TOML，Shell环境，支持热加载

出自jinzhu大佬[6]

alt 

package main

import (
 "fmt"

 "github.com/jinzhu/configor"
)

type Config struct {
 APPName string `default:"app name"`
 DB      struct {
  Name     string
  User     string `default:"root"`
  Password string `required:"true" env:"DBPassword"`
  Port     uint   `default:"3306"`
 }
 Contacts []struct {
  Name  string
  Email string `required:"true"`
 }
}

func main() {
 var conf = Config{}
 err := configor.Load(&conf, "config.yml")

 // err := configor.New(&configor.Config{Debug: true}).Load(&conf, "config.yml")  // 测试模式，也可以通过环境变量开启测试模式(CONFIGOR_DEBUG_MODE=true go run main.go )，这样就无需修改代码

 //err := configor.New(&configor.Config{Verbose: true}).Load(&conf, "config.yml") // 模式，也可以通过环境变量开启详细模式(CONFIGOR_VERBOSE_MODE=true go run main.go )，这样就无需修改代码
 if err != nil {
  panic(err)
 }
 fmt.Printf("%v \n", conf)
}

开启 测试模式 or 详细模式


既可以在代码中显式开启，如 err := configor.New(&configor.Config{Debug: true}).Load(&conf, "config.yml")

也可以通过环境变量开启，如 CONFIGOR_DEBUG_MODE=true go run main.go


加载多个配置文件


// application.yml 的优先级 大于 database.json, 排在前面的配置文件优先级大于排在后的的配置
configor.Load(&Config, "application.yml", "database.json")

根据环境变量加载配置文件 or 从shell加载配置项


详细可参考 Golang Configor 配置文件工具[7]


热更新


package main

import (
 "fmt"
 "time"

 "github.com/jinzhu/configor"
)

type Config struct {
 APPName string `default:"app name"`
 DB      struct {
  Name     string
  User     string `default:"root"`
  Password string `required:"true" env:"DBPassword"`
  Port     uint   `default:"3306"`
 }
 Contacts []struct {
  Name  string
  Email string `required:"true"`
 }
}

func main() {
 var conf = Config{}

 // reload模式,可实现热加载

 err := configor.New(&configor.Config{
  AutoReload:         true,
  AutoReloadInterval: time.Second,
  AutoReloadCallback: func(config interface{}) {
   // config发生变化后出发什么操作
   fmt.Printf("配置文件发生了变更%#v\n", config)
  },
 }).Load(&conf, "config.yml")

 // 无reload模式
 //err := configor.Load(&conf, "config.yml")

 // err := configor.New(&configor.Config{Debug: true}).Load(&conf, "config.yml")  // 测试模式，也可以通过环境变量开启测试模式(CONFIGOR_DEBUG_MODE=true go run main.go )，这样就无需修改代码

 //err := configor.New(&configor.Config{Verbose: true}).Load(&conf, "config.yml") // 模式，也可以通过环境变量开启详细模式(CONFIGOR_VERBOSE_MODE=true go run main.go )，这样就无需修改代码
 if err != nil {
  panic(err)
 }
 fmt.Printf("%v \n", conf)

 time.Sleep(100000e9)
}
alt

完整代码[8]

参考资料

[1]

使用viper管理配置: https://cloud.tencent.com/developer/article/1540672

 [2]

viper: https://github.com/spf13/viper

 [3]

Go viper 配置文件读取工具: https://cloud.tencent.com/developer/article/1677426

 [4]

动态获取配置文件(viper）: https://segmentfault.com/a/1190000022828484

 [5]

configor: https://github.com/jinzhu/configor

 [6]

jinzhu大佬: https://github.com/jinzhu

 [7]

Golang Configor 配置文件工具: https://www.jianshu.com/p/f826d2cc361b

 [8]

完整代码: https://github.com/cuishuang/config-demo

本文由 mdnice 多平台发布

techdashen
关注
go-config:一个简单的go配置库
05-26
去配置 轻松，有状态的go配置。 一个简单的go配置库，支持标志，环境变量，toml，yaml和JSON配置格式。 go-config还支持同时使用多个配置格式选项。 例如，您可以提供标志和环境变量。 因为创建配置文件很繁琐，所以go-config可以为您生成配置文件。 这有助于消除配置文件中的人为错误，并使配置文件更易于维护，因为您只需要在单个位置进行更改即可。 入门 获取库： > go get -u github.com/pcelvng/go-config 一般使用： // myapp.go package main import ( "fmt" "os" "time" "github.com/pcelvng/go-config" ) func main () { appCfg := options { RunDuration : time . Secon
Go中配置文件读取的几种方式
热门推荐
rickiyang的博客
05-17 1万+
日常开发中读取配置文件包含以下几种格式： json 格式字符串 K=V 键值对 xml 文件 yml 格式文件 toml 格式文件 前面两种书写简单，解析过程也比较简单。xml形式书写比较累赘，yml是树形结构，为简化配置而生，toml是一种有着自己语法规则的配置文件格式，我们一一来看使用方式，各位看官自行比较哪种更加实用。 1.读取json格式的文件 package main import...
GoLang：Go语言开发环境的配置
最新发布
jclee95的个人博客
09-01 2495
本文简要介绍Go语言开发环境部署。
golang 读取项目配置文件
T1Y的博客
08-09 679
介绍golang项目中配置文件的读取相关内容，包括项目结构，具体实现代码等内容。
Go（三）Go配置文件
lomtom's Blog
09-24 2446
文章目录思路实现编写配置文件编写结构体读取文件使用 本文首发于CSDN，作者：lomtom 原文链接：https://blog.csdn.net/qq_41929184/article/details/119995581 个人网站：https://lomtom.top，个人公众号：博思奥园，同步更新。 你的支持就是我最大的动力。 Go系列： Go（一）基础入门 Go（二）结构体 Go（三）Go配置文件 Go（四）Redis操作 熟悉使用SpringBoot的同学，再去使用Go之后，就会发现Sprin
Go语言---读取配置文件数据
MrLi_IT的博客
07-01 2466
方便部署，省去了修改重新打包的步骤
viper配置框架的介绍支持zookeeper的读取和监听
09-16
不仅如此，Viper还支持读取环境变量、监听配置文件变动、从远程配置系统（如etcd和Consul）获取配置，并能响应这些配置的实时变化。然而，尽管Viper功能丰富，但它并不直接支持从Zookeeper中读取和监听配置。 ...
Go-viper-一个Go应用程序的完整配置解决方案
08-13
Go-viper是一个专门为Go语言应用程序设计的全面配置管理库，由知名Go开发者spf13创建。这个库的出现解决了Go应用在处理配置文件时的复杂性和多样性问题，支持从命令行参数、环境变量、配置文件（JSON, TOML, YAML, ...
dials:Dials是Go的可扩展配置包
03-18
它支持几种不同的配置源，包括： JSON，YAML和TOML配置文件环境变量命令行标志（用于Go的包和包）监视的配置文件，并在监视文件有更改时重新读取默认值为什么选择转盘？ Dials是一种配置解决方案，它支持多个配置源...
Json2Csv:基于GoLang的JSON转CSV文件转换器
05-05
Go语言，又称Golang，是由Google开发的一种静态类型、编译型、并发型且具有垃圾回收功能的编程语言。Go以其简洁的语法、高效的性能以及内置的并发支持，受到了许多开发者喜爱，尤其适合构建系统级工具和高性能服务。...
legifrance-go:去包来操作legifrance转储文件
06-14
《使用Go语言高效处理Legifrance转储文件——legifrance-go详解》 在数字化时代，法律信息的管理和检索变得尤为重要。法国政府的官方法律出版平台Legifrance提供了丰富的法律资源，而`legifrance-go`正是一个专门...
golang读取各种配置文件(ini、json、yaml)
秋̶᭄ꦿ攻城狮࿆ྂ
11-02 2883
日常项目中,读取各种配置文件是避免不了的,本文主要介绍了golang读取各种配置文件(ini、json、yaml),文中通过示例代码介绍的非常详细,对大家的学习或者工作具...
器 | Go四种方式读取环境配置文件
DynmicResource的博客
07-18 1516
theme: jzman 「本文已参与好文召集令活动，点击查看：后端、大前端双赛道投稿，2万元奖池等你挑战！」 配置文件在一个项目中至关重要，如何高效的读取配置尤为关键。如果不采用任何三方库，最常用的方式是通过文件I/O获取文件的内容，但我毕竟只是想要读取个配置文件，这还要进行文件操作，未免有些造轮子了。而且，文件的格式多种多样，如何格式的读取文件内容和根据不同的环境读取也是一个不小...
go读取yaml,json,ini等配置文件
simply
08-31 2221
实际项目中，要读取一些json等配置文件。今天就来说一说，Golang 是如何读取YAML,JSON,INI等配置文件的。
【Go|第2期】Go读取ini配置文件
Commas的博客
03-06 1524
go-ini是一个非常方便、高效的go配置文件操作库。
go配置文件管理-viper
一个菜鸟的博客
06-09 549
go配置文件管理-viper
超详细go语言环境配置！！！
qq_57287010的博客
01-15 1万+
字节跳动青训营-go语言保姆级环境配置
Go开发学习 | 如何快速读取json/yaml/ini等格式的配置文件使用示例
WeiyiGeek 唯一极客IT知识分享
05-30 1665
描述: 作为开发者相信对应用程序的配置文件并不陌生吧，例如 Java Spring Boot 里的 class 目录中程序配置，当然go语言相关项目也是可以根据配置文件的格式内容进行读取的，常规的配置文件格式有 json、ini、yaml (个人推荐)、properties 等，我们可以使用其为程序配置一些初始化的可变参数，例如 数据库字符串链接以及认证密码等等。好，下面作者将依次从json、ini、以及yaml、properties 等顺序进行讲解。0x01 常用模块。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值