脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 脚本专栏 → Golang → go读取配置文件

go语言中读取配置文件的方法总结

 更新时间：2023年08月29日 11:04:44   作者：fliter  
这篇文章主要为大家详细介绍了go语言中读取配置文件的几个常见方法,文中的示例代码讲解详细,具有一定的借鉴价值,需要的小伙伴可以参考下

使用viper管理配置

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

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

  • 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"))
}

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

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

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

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

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

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

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"))
}

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)
}

Go viper 配置文件读取工具

动态获取配置文件(viper）

configor

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

出自jinzhu大佬

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 配置文件工具

热更新

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)
}

完整代码

到此这篇关于go语言中读取配置文件的方法总结的文章就介绍到这了,更多相关go读取配置文件内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

  • 基于Go goroutine实现一个简单的聊天服务

    基于Go goroutine实现一个简单的聊天服务

    对于聊天服务，想必大家都不会陌生，因为在我们的生活中经常会用到，本文我们用 Go 并发来实现一个聊天服务器，这个程序可以让一些用户通过服务器向其它所有用户广播文本消息，文中通过代码示例介绍的非常详细,需要的朋友可以参考下
    2023-06-06
  • golang定时器和超时的使用详解

    golang定时器和超时的使用详解

    这篇文章主要介绍了golang定时器和超时的使用详解，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-12-12
  • golang 的string与[]byte转换方式

    golang 的string与[]byte转换方式

    这篇文章主要介绍了golang 的string与[]byte转换方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • Golang线上内存爆掉问题排查(pprof)与解决

    Golang线上内存爆掉问题排查(pprof)与解决

    这篇文章主要介绍了Golang线上内存爆掉问题排查(pprof)与解决,涉及到数据敏感,文中代码是我模拟线上故障的一个情况,好在我们程序都有添加pprof监控,于是直接通过go tool pprof分析,需要的朋友可以参考下
    2024-04-04
  • go新工具gonew生成模板工具链使用详解

    go新工具gonew生成模板工具链使用详解

    这篇文章主要为大家介绍了go新工具gonew生成模板工具链使用详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-08-08
  • 分享6个Go处理字符串的技巧小结

    分享6个Go处理字符串的技巧小结

    这篇文章主要介绍了分享6个Go处理字符串的技巧小结，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2019-12-12
  • prometheus client_go为应用程序自定义监控指标

    prometheus client_go为应用程序自定义监控指标

    这篇文章主要为大家介绍了prometheus client_go为应用程序自定义监控指标详解，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
    2023-02-02
  • Go接口构建可扩展Go应用示例详解

    Go接口构建可扩展Go应用示例详解

    本文深入探讨了Go语言中接口的概念和实际应用场景。从基础知识如接口的定义和实现，到更复杂的实战应用如解耦与抽象、多态、错误处理、插件架构以及资源管理，文章通过丰富的代码示例和详细的解释，展示了Go接口在软件开发中的强大功能和灵活性
    2023-10-10
  • Go检查结构体中是否存在某个字段及创建结构体切片或映射

    Go检查结构体中是否存在某个字段及创建结构体切片或映射

    这篇文章主要为大家介绍了Go检查结构体中是否存在某个字段及创建结构体切片或映射实现示例详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2024-01-01
  • Go自定义数据序列化的流程详解

    Go自定义数据序列化的流程详解

    在Go语言中,自定义数据的序列化是一个常见的需求,本文将深入探讨 Go 语言中自定义数据序列化的流程,包括关键概念、技巧和最佳实践,旨在帮助开发者更高效地进行数据序列化工作,需要的朋友可以参考下
    2024-06-06

最新评论