Golang 项目配置文件读取之 viper 实践

最新推荐文章于 2024-10-10 21:32:00 发布

qhh0205

最新推荐文章于 2024-10-10 21:32:00 发布

阅读量1.8k

点赞数 1

分类专栏： Go 文章标签： golang viper

本文链接：https://blog.csdn.net/qianghaohao/article/details/107290171

版权

本文介绍了在Golang项目中使用viper进行配置文件读取的方法。通过创建独立的config包，包含初始化配置、获取配置及配置校验等功能，实现配置管理的标准化。在项目启动时初始化viper，其他包可通过GetConfig()函数访问配置信息。

摘要由CSDN通过智能技术生成

Golang 项目配置文件读取之 viper 实践

在我们做一个工程化项目的时候，经常涉及到配置文件的读取，viper 包很好地满足这一需求，而且在 Golang 生态中是流行度最高的。导入方式：

import "github.com/spf13/viper"

这里分享下我对 viper 包的使用关键实践：

首先，在代码工程中单独定义一个包（我一般起名为 config 或者 configloader），这个包专门用来读取加载配置文件，并做相关校验，包里面我定义 3 个函数和 1 个全局变量：

var viperConfig *viper.Viper: 全局配置变量；
func Init(configDir string) error: 初始化加载配置文件；
func GetConfig() *viper.Viper: 获取配置文件，供其他包调用，拿到配置文件实例；
func validateConfig(v *viper.Viper) error: 校验配置文件；

接下来在工程入口处引用上面这个配置包的 Init 函数做配置文件的初始化和加载，加载的结果就是实例化一个 *viper.Viper 全局变量，在其他包中用的时候调用这个配置包的 func GetConfig() *viper.Vipe 函数即可拿到这个全局变量，即配置文件内容。

示例代码（代码仅供参考，截取字自前做的爬虫程序部分代码）：

package configloader

import (
	"fmt"

	"github.com/spf13/viper"

	"example.com/pkg/util/fs"
)

// viperConfig 全局配置变量
var viperConfig *viper.Viper

// 初始化配置文件相关设置，在 main 包中调用进行初始化加载
func Init(configDir string) error {
   
	if configDir == "" {
   
		return fmt.Errorf("config directory is empty")
	}