Viper配置管理笔记

一、什么是 Viper？

Viper 是 Go 语言的一个强大工具，就像一个超级管家，专门负责帮你打理程序的各种配置。它能把配置文件（比如 JSON、YAML、TOML 等格式）里的内容读出来，还能监控配置文件的变化，甚至可以从环境变量、命令行参数、远程配置服务器（比如 etcd、Consul）里拿配置。总之，有了 Viper，配置管理就变得简单又灵活。

二、为什么用 Viper？

1. 支持多种格式：无论是 YAML、JSON 还是其他格式的配置文件，Viper 都能轻松读取。

2. 提供默认值：如果配置文件里没写某些值，Viper 可以用默认值顶上，避免程序出错。

3. 实时监控：配置文件改了，Viper 能立刻发现并更新，不用重启程序。

4. 灵活优先级：Viper 有一套明确的规则，决定哪个配置来源更重要，避免冲突。

三、Viper 的生活化例子

假设你开了一家餐厅，Viper 就像你的大堂经理：

• 支持多种菜单格式：无论是纸质菜单、电子菜单还是黑板菜单，大堂经理都能读懂。

• 提供默认菜品：如果客人没点菜，大堂经理会根据默认菜单给客人上菜。

• 实时监控菜单变化：如果厨房临时换了菜品，大堂经理会立刻通知所有客人。

• 灵活优先级：如果客人点的菜和默认菜单冲突，以客人点的菜为准；如果厨房缺货，再考虑其他替代方案。

四、Viper 的代码示例

示例 1：读取 YAML 配置文件

package main

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

func main() {
	// 设置配置文件信息
	viper.SetConfigName("config")  // 配置文件名（无扩展名）
	viper.SetConfigType("yaml")    // 配置文件类型
	viper.AddConfigPath(".")       // 添加配置文件路径

	// 读取配置文件
	if err := viper.ReadInConfig(); err != nil {
		panic(fmt.Errorf("读取配置文件出错: %s", err))
	}

	// 获取配置值
	port := viper.GetInt("port")
	version := viper.GetString("version")
	mysqlHost := viper.GetString("mysql.host")
	mysqlPort := viper.GetInt("mysql.port")
	mysqlDbname := viper.GetString("mysql.dbname")

	// 打印配置值
	fmt.Printf("服务器端口: %d\n", port)
	fmt.Printf("版本号: %s\n", version)
	fmt.Printf("MySQL 地址: %s:%d\n", mysqlHost, mysqlPort)
	fmt.Printf("MySQL 数据库名: %s\n", mysqlDbname)
}

示例 2：实时监控配置文件变化

package main

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

func main() {
	// 设置配置文件信息
	viper.SetConfigName("config")
	viper.SetConfigType("yaml")
	viper.AddConfigPath(".")

	// 读取配置文件
	if err := viper.ReadInConfig(); err != nil {
		panic(fmt.Errorf("读取配置文件出错: %s", err))
	}

	// 监控配置文件变化
	viper.WatchConfig()
	viper.OnConfigChange(func(e fsnotify.Event) {
		fmt.Println("配置文件有变化：", e.Name)
		// 这里可以添加配置更新后的逻辑
	})

	// 模拟程序运行
	for {
		time.Sleep(1 * time.Second)
		fmt.Println("当前版本：", viper.GetString("version"))
	}
}

五、总结

Viper 是一个功能强大、灵活易用的配置管理工具，它就像是程序配置的超级管家，为开发者提供了全方位的配置解决方案。无论是简单的命令行工具，还是复杂的分布式系统，Viper 都能轻松应对，帮助开发者高效、稳定地管理配置信息，让程序在不同的环境和场景下都能稳定运行，极大地提升了开发效率和程序的质量，是 Go 语言开发中不可或缺的得力助手。