Viper，一个Go语言配置管理神器！

发布日期: 2024-11-16

文章字数: 1.4k

阅读时长: 5 分钟

阅读次数:

在现代软件开发中，良好的配置管理可以极大地提升应用的灵活性和可维护性。

在 Go 语言中，Viper 是一个功能强大且广泛使用的配置管理库，它支持从多个来源读取配置，包括文件、环境变量、远程配置中心等。本文将详细介绍如何使用 Viper 来管理配置，包括从本地文件和 Consul 远程配置中心读取配置的示例。

为什么选择 Viper？

Viper 提供了丰富的功能，能够帮助开发者轻松管理配置。以下是 Viper 的一些关键特性：

支持多种配置文件格式：包括 JSON、YAML、TOML、HCL 等。
多层次的配置来源：Viper 可以从配置文件、环境变量、命令行参数、远程配置中心、默认值等多个来源读取配置。
支持动态配置：可以监控和热更新远程配置中心的配置。
轻松集成：可以与其他 Go 库和框架（如 Cobra）无缝集成。

Viper 读取配置的优先级

显式调用 Set 方法设置的值
命令行参数（flag）
环境变量
配置文件
key/value 存储（如 etcd、consul）
默认值

从 YAML 文件读取配置

我们首先来看如何从本地的 YAML 文件中读取配置。这是最常见的场景之一。在这个示例中，假设我们有一个 config_demo.yaml 文件，内容如下：

mysql:
  host: "localhost"
  port: 3306
  user: "root"
  password: "password"

通过以下代码，可以轻松读取并使用这个配置：

package viper_demo

import (
	"fmt"

	"github.com/davecgh/go-spew/spew"
	"github.com/spf13/viper"
)

func GetConfig4YamlFile() {
	viper.SetConfigFile("./config_demo.yaml") // 指定配置文件路径

	err := viper.ReadInConfig()
	if err != nil {
		if _, ok := err.(viper.ConfigFileNotFoundError); ok {
			fmt.Printf("Config file not found: %v\n", err)
			return
		} else {
			fmt.Printf("Failed to read config file: %v\n", err)
			return
		}
	}

	// 查看某个配置是否存在
	fmt.Printf("mysql.host exists: %v\n", viper.IsSet("mysql.host"))

	// 设置默认值
	viper.SetDefault("port", 8081)

	// 读取所有的配置信息
	spew.Dump(viper.AllSettings())

	fmt.Printf("port: %v\n", viper.Get("port"))
	fmt.Printf("mysql.password: %v\n", viper.Get("mysql.password"))

	// 覆盖配置文件中的值
	viper.Set("port", 8082)
	fmt.Printf("port after set: %v\n", viper.Get("port"))
}

关键点解析

配置文件路径的设置：使用 viper.SetConfigFile("./config_demo.yaml") 指定配置文件的路径和名称。你也可以使用 viper.SetConfigName("config_demo") 配合 viper.AddConfigPath(".") 来指定配置文件的目录和名称。但是需要注意：比如在同一个配置文件目录下，如果有 config_demo.yaml 和 config_demo.json 两个文件时，其实这两个文件都有可能会读到 。因此，强烈建议：不要在同目录下放置多个同名且不同后缀的文件，如果存在时，则建议直接使用 viper.SetConfigFile() 方法。
读取配置文件：viper.ReadInConfig() 用于读取配置文件，读取失败时应进行错误处理。
检查配置是否存在：viper.IsSet("mysql.host") 可以检查某个配置项是否存在。
设定默认值：viper.SetDefault("port", 8081) 用于设置配置项的默认值。
覆盖配置值：viper.Set("port", 8082) 可以在运行时动态更改配置值。

从 Consul 远程配置中心读取配置

除了从本地文件读取配置外，Viper 还支持从远程配置中心读取配置。这里我们以 Consul 为例，展示如何从远程读取配置。

package viper_demo

import (
	"fmt"

	"github.com/davecgh/go-spew/spew"
	"github.com/spf13/viper"
)

func GetConfig4Consul() {
	err := viper.AddRemoteProvider("consul", "http://127.0.0.1:8500", "/config/local_config")
	if err != nil {
		panic(err)
	}

	viper.SetConfigType("yaml") // 设置配置文件的类型
	err = viper.ReadRemoteConfig()
	if err != nil {
		if _, ok := err.(viper.RemoteConfigError); ok {
			fmt.Println("远程配置信息没有找到")
			return
		} else {
			panic(err)
		}
	}

	spew.Dump(viper.AllSettings())
	fmt.Printf("port: %v\n", viper.Get("port"))
	fmt.Printf("env: %v\n", viper.Get("env"))

	// 解析配置信息到结构体
	type cfg struct {
		Port int    `mapstructure:"port"`
		Env  string `mapstructure:"env"`
	}
	var c cfg
	err = viper.Unmarshal(&c)
	if err != nil {
		panic(err)
	}
	spew.Dump(c)
}

关键点解析

远程配置提供者：通过 viper.AddRemoteProvider("consul", "http://127.0.0.1:8500", "/config/local_config") 添加远程配置提供者。这里的 "/config/local_config" 是存储配置的路径。
配置文件类型：必须使用 viper.SetConfigType("yaml") 明确指定配置文件的类型。需要特别注意的是：这个配置基本上是配合远程配置中心使用的，比如 etcd、consul、zookeeper 等，告诉 viper 当前的数据使用什么格式去解析。
读取远程配置：viper.ReadRemoteConfig() 用于从远程获取配置，获取失败时需处理错误。
解析到结构体：通过 viper.Unmarshal(&c) 将配置解析到自定义的结构体中，使代码更加易于维护和使用。在这里还有一点一定要注意的就是：在结构体中一定要使用 mapstructure 这个 tag，否则无法解析，不管你的配置文件是 yaml 格式，还是 json 格式，如果需要将配置数据解析到结构体中，就必须使用 mapstructure 这个 tag。