Golang 使用 Viper 优雅读取 INI、JSON 和 YAML 配置文件

核心优势

• 格式兼容性强：无需编写解析器即可处理多种主流配置格式。
• 热加载支持：可在运行时监听配置文件变化并重新读取。
• 环境友好：支持环境变量、命令行标志位及默认值的优先级覆盖。

读取前准备

在使用 Viper 之前，需要确保项目中已安装该库。若未安装，可通过以下命令下载依赖：

go get github.com/spf13/viper

同时，建议将各类配置文件统一存放在项目的 conf/ 目录下，以便于路径管理与维护。

第1步：读取 ini 格式配置文件

目的：解析传统基于节（Section）结构的 ini 文件。
入口：新建 Viper 实例
动作：设置目录、文件名及类型为 ini
参数：SetConfigType("ini")
完成状态：成功返回错误时抛出，否则可直接通过 Get 系列方法取值。

代码实现

config := viper.New()
// 设置配置文件所在目录
config.AddConfigPath("./conf/")
// 设置文件名（不含扩展名）
config.SetConfigName("b")
// 指定文件格式为 ini
config.SetConfigType("ini")

if err := config.ReadInConfig(); err != nil {
    if _, ok := err.(viper.ConfigFileNotFoundError); ok {
        fmt.Println("找不到配置文件..")
    } else {
        fmt.Println("配置文件出错..")
    }
}

// 读取 redis 节的 host 字段
host := config.GetString("redis.host")
fmt.Println("viper load ini: ", host)

对应配置文件 b.ini

[mysql]
username = 'root'
password = '123456'

[redis]
host = '127.0.0.1'
port = 6379

[mongodb]
user = 'admin'
password = 'admin'

第2步：读取 json 格式配置文件

目的：解析结构化数据广泛使用的 JSON 格式。
入口：Viper 初始化
动作：将类型设为 json，并使用 GetStringMapString 等高级方法提取嵌套数据
参数：SetConfigType("json")
完成状态：成功加载后，可逐层获取或整体映射为 map。

代码实现

config := viper.New()
config.AddConfigPath("./conf/")
config.SetConfigName("c")
config.SetConfigType("json")

if err := config.ReadInConfig(); err != nil {
    if _, ok := err.(viper.ConfigFileNotFoundError); ok {
        fmt.Println("找不到配置文件..")
    } else {
        fmt.Println("配置文件出错..")
    }
}

// 直接获取顶层字段
version := config.GetString("version")
origin := config.GetString("host.origin") // 支持点分隔符访问子字段

fmt.Println(version)
fmt.Println(origin)

// 将 "host" 节点映射为字符串 Map
hostMap := config.GetStringMapString("host")
fmt.Println(hostMap)

// 获取所有配置项为通用 map
allSettings := config.AllSettings()
fmt.Println(allSettings)

对应配置文件 c.json

{
  "version": "2.0",
  "secret": "footmark",
  "host": {
    "origin": "http://www.baidu.com",
    "port": 8080
  }
}

第3步：读取 yaml/yml 格式配置文件

目的：适用于 Kubernetes 及现代微服务架构中常用的 YAML 格式。
入口：Viper 初始化
动作：设置配置类型为 yaml
参数：SetConfigType("yaml")
完成状态：配置文件加载完毕，层级结构自动映射。

代码实现

config := viper.New()
config.AddConfigPath("./conf/")
config.SetConfigName("a")
config.SetConfigType("yaml")

if err := config.ReadInConfig(); err != nil {
    if _, ok := err.(viper.ConfigFileNotFoundError); ok {
        fmt.Println("找不到配置文件..")
    } else {
        fmt.Println("配置文件出错..")
    }
}

// 读取 database 节点的 host
host := config.GetString("database.host")
fmt.Println("viper load yml: ", host)

allSettings := config.AllSettings()
fmt.Println(allSettings)

对应配置文件 a.yaml

database:
  host: 127.0.0.1
  user: root
  dbname: test
  pwd: 123456

Viper 常用取值方法一览

在成功读取配置文件后，可以根据数据类型选择合适的 Get 方法：

• 基础类型：GetString()、GetInt()、GetBool()、GetFloat64()、GetTime()、GetDuration()
• 切片类型：GetStringSlice()、GetIntSlice()
• Map 类型：GetStringMapString()、GetStringMap()、AllSettings()
• 存在性检查：IsSet(key string) 用于判断某键是否存在于当前上下文中。

简要总结

Viper 极大地简化了 Golang 中的配置管理工作。无论是传统的 ini 还是现代的 yaml/json，只需调整 AddConfigPath 和 SetConfigType 的参数，即可无缝切换解析模式。配合其丰富的数据类型获取方法，它能轻松应对各种复杂的项目需求。以上就是 Golang 使用 Viper 读取各种配置文件的详细内容，更多关于 Go 语言配置管理的资料请关注本站其它相关文章！