第一部分概述

viper 是Go语言中的一个配置管理库，用于读取、解析和管理应用程序的配置文件。它支持多种格式的配置文件（如JSON、YAML、TOML、ENV等），并提供灵活的方式来读取配置项和管理配置的生命周期。viper 的优势在于它能够简化配置的管理，尤其适用于需要从多个来源（文件、环境变量、命令行标志等）加载配置的场景。

项目地址：https://github.com/spf13/viper

1.1 主要功能和作用

多种配置来源：viper 可以从多种来源加载配置，如本地配置文件（JSON、YAML、TOML等）、环境变量、命令行参数、远程配置服务等，方便将配置集中管理。
动态更新配置：viper 支持动态加载和热更新配置文件，允许程序在运行时重新加载配置而不需要重启。
配置格式支持：支持 JSON、YAML、TOML、HCL、ENV 等多种格式，开发者可以根据项目需求选择合适的格式。
默认值和环境变量支持：viper 允许为每个配置项设置默认值，并支持从环境变量中读取配置值，尤其适用于云环境和容器化部署。
灵活的配置访问：提供了多种方法来访问配置项，包括按路径、按键、按默认值等方式，支持结构化配置数据的映射。
与 cobra 集成：viper 可以与 cobra 集成，管理命令行工具的配置和命令行参数，使得命令行工具更加灵活。
支持配置监控：viper 可以监控配置文件的变化，当文件被修改时，自动加载新配置，适用于需要动态调整配置的应用程序。

1.2 常见使用场景

Web 应用配置管理：在 Web 应用中，通常需要加载数据库连接信息、日志配置、API 密钥等。viper 可以集中管理这些配置，支持从不同来源（如文件、环境变量）读取配置信息。
CLI 工具的配置管理：使用 cobra 构建命令行工具时，viper 可以帮助管理和读取命令行的参数、配置文件等，使得命令行工具更加灵活。
分布式系统中的配置管理：在分布式系统中，viper 可以与远程配置服务（如 Consul、etcd 等）集成，统一管理和同步配置，避免不同节点之间的配置不一致问题。
DevOps 工具和自动化脚本：DevOps 工具通常需要根据不同的环境读取配置，viper 可以帮助动态加载和管理配置文件，使得工具在不同环境下可以灵活运行。

第二部分常用操作

2.1 安装

通过以下命令安装 viper 库：

bash
go get github.com/spf13/viper

2.2 设置默认值

实际使用中，常常会对部分配置项进行默认值的配置，使用 viper 可以轻松的完成这项工作。如果配置文件中没有相应的配置，viper 会使用默认值：

go
package main

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

func main() {
    // 设置默认值
    viper.SetDefault("server.port", 8080)

    // 获取值
    port := viper.GetInt("server.port")
    fmt.Printf("Server will run on port: %d\n", port)
}

上述代码中，viper.SetDefault 用于设置配置项的默认值。

2.3 读取配置文件

viper 可以读取多种格式的配置文件。以下是加载YAML格式配置文件的示例：

go
package main

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

func main() {
    // 设置配置文件路径
    viper.SetConfigName("config") // 文件名（不带扩展名）
    viper.AddConfigPath(".")      // 配置文件所在目录

    // 读取配置文件
    if err := viper.ReadInConfig(); err != nil {
        log.Fatalf("Error reading config file, %s", err)
    }

    // 获取配置项
    port := viper.GetInt("server.port")
    fmt.Printf("Server running on port: %d\n", port)
}

假设配置文件 config.yaml 内容如下：

yaml
  server:
    port: 8080

viper.ReadInConfig() 会从当前目录加载 config.yaml 配置文件，并读取其中的配置项。

2.4 支持多种配置格式

viper 支持多种格式的配置文件，包括JSON、YAML、TOML、ENV 等。只需要根据文件类型调用对应的方法：

go
viper.SetConfigType("yaml") // 设置配置文件格式
viper.ReadInConfig()        // 读取配置

2.5 从环境变量加载配置

viper 支持从环境变量中读取配置项。默认情况下，环境变量名会被转化为大写，并用下划线代替点（.）。例如，配置项 server.port 会对应环境变量 SERVER_PORT：

go
package main

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

func main() {
    // 从环境变量中读取配置
    viper.AutomaticEnv() // 启用自动加载环境变量

    // 获取环境变量值
    port := viper.GetInt("SERVER_PORT")
    fmt.Printf("Server running on port: %d\n", port)
}

如果环境变量 SERVER_PORT 存在，则 viper 会自动读取该值。

2.6 读取命令行标志

viper 可以与 cobra 一起使用，从命令行标志中读取配置：

go
var configFile string

var rootCmd = &cobra.Command{
    Use:   "myapp",
    Short: "My Application",
    Run: func(cmd *cobra.Command, args []string) {
        // 从命令行标志读取配置
        viper.SetConfigFile(configFile)
        err := viper.ReadInConfig()
        if err != nil {
            fmt.Println("Error reading config:", err)
        }
    },
}

func init() {
    rootCmd.PersistentFlags().StringVar(&configFile, "config", "", "config file")
}

上面的代码允许通过命令行传递配置文件路径，例如：

bash
myapp --config ./config.yaml

2.7 动态监控配置文件变化

viper 可以监控配置文件的变化，并在文件发生更改时重新加载配置。可以通过viper.WatchConfig 来实现：

go
package main

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

func main() {
    // 设置配置文件路径
    viper.SetConfigName("config")
    viper.AddConfigPath(".")

    // 读取配置
    if err := viper.ReadInConfig(); err != nil {
        fmt.Println("Error reading config:", err)
    }

    // 监控配置文件的变化
    viper.WatchConfig()
    // 设置配置更改的回调函数
    viper.OnConfigChange(func(e fsnotify.Event) {
        fmt.Println("Config file changed:", e.Name)
    })

    // 获取配置值
    port := viper.GetInt("server.port")
    fmt.Printf("Server running on port: %d\n", port)
    // 等待用户按键，防止程序退出
    fmt.Scanln()
}

在上面的代码中，viper.WatchConfig() 会监控配置文件的变化，并在文件更改时调用回调函数。

2.8 结构体映射

viper 可以将配置文件中的数据映射到 Go 结构体中，便于使用：

go
type Config struct {
   Server struct {
       Port int `mapstructure:"port"`
   }
}

var config Config
viper.SetConfigName("config")
viper.AddConfigPath(".")
viper.ReadInConfig()

// 将配置文件数据映射到结构体
err := viper.Unmarshal(&config)
if err != nil {
   fmt.Println("Error unmarshalling config:", err)
}

fmt.Printf("Server running on port: %d\n", config.Server.Port)

在上面的代码中，viper.Unmarshal 将配置文件中的数据映射到 Config 结构体。

目录

第一部分 概述