golang工程组件之配置解决方案viper

在Golang开发中，配置文件是必不可少的一部分，它可以让我们更好地管理应用程序的行为和设置，从而使得应用程序具有更高的灵活性。为了方便管理配置文件，Golang工程组件之配置解决方案viper应运而生，它提供了一个简单而强大的方式来读取、保存和管理程序配置。

一、viper概述 viper是一款独立于配置文件格式的库，可以使用多种格式的配置文件如json、yaml、toml等，并且支持从环境变量、命令行参数和默认值等多个来源读取配置。viper还通过提供灵活的配置覆盖策略来简化配置管理过程，从而让应用程序更加容易扩展和维护。

二、viper安装 在使用viper之前，需要先安装viper库。使用go get命令即可完成安装。

$ go get github.com/spf13/viper

三、viper基础用法 下面是一个简单的示例代码，展示了如何使用viper读取配置文件。

package main

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

func main() {
    // 初始化viper
    viper.SetConfigName("config")  // 指定配置文件名（不带后缀）
    viper.AddConfigPath(".")       // 搜索路径
    err := viper.ReadInConfig()    // 查找并读取配置文件
    if err != nil {                // 处理读取错误
        panic(fmt.Errorf("Fatal error config file: %s \n", err))
    }

    // 从配置文件读取配置项
    host := viper.GetString("database.host")
    port := viper.GetInt("database.port")
    username := viper.GetString("database.username")
    password := viper.GetString("database.password")

    // 打印配置项
    fmt.Printf("host=%s, port=%d, username=%s, password=%s\n", host, port, username, password)
}

在上面的代码中，我们首先使用viper初始化了一个实例，并指定了配置文件名和搜索路径。接下来，通过ReadInConfig方法查找并读取配置文件。最后，使用GetString、GetInt等方法读取了配置项，并打印了这些配置项。

四、viper高级用法

viper不仅仅支持多种格式的配置文件和多个来源读取配置，还提供了很多高级用法。

配置覆盖策略 viper提供了多个配置覆盖策略，可以根据需要选择合适的策略来管理配置。例如，如果需要从环境变量和配置文件中获取配置，可以使用以下代码：

viper.AutomaticEnv()           // 自动从环境变量获取配置
viper.SetConfigName("config")  // 指定配置文件名（不带后缀）
viper.AddConfigPath(".")       // 搜索路径
err := viper.ReadInConfig()    // 查找并读取配置文件
if err != nil {                // 处理读取错误
    panic(fmt.Errorf("Fatal error config file: %s \n", err))
}

// 从环境变量和配置文件中获取配置项
host := viper.GetString("database.host")
port := viper.GetInt("database.port")
username := viper.GetString("database.username")
password := viper.GetString("database.password")

在上面的代码中，我们首先使用AutomaticEnv方法启用了自动从环境变量获取配置。然后，通过SetConfigName、AddConfigPath和ReadInConfig方法查找并读取了配置文件。最后，使用GetString、GetInt等方法从环境变量和配置文件中获取了配置项。

默认值 如果需要为未设置的配置项提供默认值，则可以使用SetDefault方法。例如：

viper.SetDefault("database.host", "localhost")
viper.SetDefault("database.port", 3306)
viper.SetDefault("database.username", "root")
viper.SetDefault("database.password", "")

在上面的代码中，我们使用SetDefault方法为未设置的配置项提供了默认值。

监控配置文件变化 如果需要监控配置文件的变化，并在变化时重新加载配置文件，则可以使用viper.WatchConfig方法。例如：

viper.SetConfigFile("./config.toml") // 指定配置文件
viper.WatchConfig()                  // 监控配置文件变化
for {
    // 在循环中获取配置项
    fmt.Println(viper.Get("name"))
    time.Sleep(time.Second * 5)
}

在上面的代码中，我们首先使用SetConfigFile方法指定了配置文件。然后，通过WatchConfig方法来监控配置文件变化，并在循环中不断获取配置项。

四、总结 viper是一款非常实用的Golang库，它提供了多种格式的配置文件支持，可以从多个来源读取配置，在提供默认值和灵活的配置覆盖策略等方面也做得非常好。如果在开发中需要管理各种复杂的配置，那么使用viper将能够大大提高开发效率，减少出错概率。

​最后，更多Golang文档资料，面试资料，往期课件资料、学习路线图+Q群：793221798

Golang公开课学习地址：https://ke.qq.com/course/422970?flowToken=1044587(免费订阅，永久学习)