当前位置：首页 > 文章列表 > Golang > Go教程 > Golang用Viper读取YAML和JSON配置方法

Golang用Viper读取YAML和JSON配置方法

2025-07-28 15:07:31 0浏览收藏

在Golang项目中，处理配置文件是常见需求，Viper作为流行的Go配置管理库，简化了YAML和JSON等格式配置文件的读取。本文将详细介绍如何使用Viper读取YAML/JSON配置文件，包括安装Viper并初始化，设置配置文件名、类型和查找路径，定义与配置结构匹配的结构体，并通过`viper.ReadInConfig`加载配置文件，再用`viper.Unmarshal`解析到结构体。此外，本文还探讨了如何通过设置不同的配置文件名或直接指定完整文件名来实现多环境配置，以及如何利用`viper.WatchConfig`配合`viper.OnConfigChange`监听配置变化并热更新，实现配置修改时自动重载，提升应用的灵活性和便捷性。掌握这些技巧，能有效提升Golang项目的配置管理效率。

使用Viper读取YAML或JSON配置文件的步骤如下：1. 安装并初始化Viper，设置配置文件名、类型和查找路径；2. 定义与配置结构匹配的结构体，并通过viper.ReadInConfig加载配置文件，再用viper.Unmarshal解析到结构体；3. 支持多环境配置可通过设置不同的配置文件名或直接指定完整文件名实现；4. 可监听配置变化并热更新，通过viper.WatchConfig配合viper.OnConfigChange实现在配置修改时自动重载。

如何用Golang处理配置文件使用viper读取yaml/json配置

处理配置文件是很多 Golang 项目中常见的需求，尤其是使用 YAML 或 JSON 格式来保存配置信息。Viper 是一个非常流行的 Go 配置管理库，它支持多种格式的配置文件读取，包括 YAML 和 JSON，而且用起来也比较简单。

下面我们就来看看怎么用 Viper 来读取 YAML 或 JSON 的配置文件。

初始化 Viper 并设置基本参数

首先你需要安装 viper 包：

go get github.com/spf13/viper

然后在代码中导入并初始化：

import (
    "fmt"
    "github.com/spf13/viper"
)

func main() {
    viper.SetConfigName("config") // 配置文件名（不带后缀）
    viper.SetConfigType("yaml")   // 可以是 yaml 或 json
    viper.AddConfigPath(".")       // 查找配置文件的路径，这里设为当前目录
}

这样就设置了要加载的配置文件名称、类型和查找路径。比如上面的设置会去找当前目录下的 config.yaml 或 config.json 文件。

加载配置文件并解析到结构体

写好配置文件之后，下一步就是把它加载进来，并映射到你定义好的结构体里。这是实际开发中最常用的方式。

假设你的 config.yaml 内容如下：

app:
  name: myapp
  port: 8080
database:
  host: localhost
  port: 5432
  user: postgres

你可以定义一个对应的结构体：

type Config struct {
    App      AppConfig
    Database DBConfig
}

type AppConfig struct {
    Name string
    Port int
}

type DBConfig struct {
    Host string
    Port int
    User string
}

然后用 Viper 把配置文件解析进这个结构体：

var cfg Config
if err := viper.ReadInConfig(); err != nil {
    panic(fmt.Errorf("fatal error config file: %w", err))
}

if err := viper.Unmarshal(&cfg); err != nil {
    panic(fmt.Errorf("unable to decode into struct: %v", err))
}

这样你就把配置文件的内容读进了 cfg 这个变量里，之后就可以通过 cfg.App.Name、cfg.Database.Host 等方式访问了。

支持多个环境配置（如 dev、test、prod）

有时候你会有多个环境配置，比如 config.dev.yaml、config.prod.yaml，这时候可以结合命令行 flag 或者环境变量来切换配置文件。

例如：

viper.SetConfigName("config." + env) // env 可以是 dev / prod
viper.SetConfigType("yaml")
viper.AddConfigPath(".")

或者你也可以直接指定完整文件名：

viper.SetConfigFile("config.dev.yaml")

这种方式可以让你的程序根据运行环境自动加载不同的配置，提高灵活性。

小技巧：监听配置变化并热更新

如果你希望在程序运行时修改配置文件后能自动重新加载，可以用 Viper 提供的 Watch 功能：

viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
    fmt.Println("Config file changed:", e.Name)
    viper.Unmarshal(&cfg) // 重新解析到结构体
})

这在某些长期运行的服务中很有用，比如后台服务不需要重启就能应用新配置。

不过要注意的是，这个功能默认不会阻塞主 goroutine，如果主函数退出了整个程序也会结束，所以需要配合 select {} 或其他方式保持运行。

基本上就这些。用 Viper 读取 YAML 或 JSON 配置并不复杂，但有几个关键点需要注意：