go-Go Viper：强大的Go语言配置管理库

icy 昨天 15 抢沙发

默认

摘要： Go Viper：强大的Go语言配置管理库概述 Viper 是一个功能强大的 Go 语言配置管理库，由 Steve Francia（spf13）创建并维护。它旨在为 Go 应用程...

Go Viper：强大的Go语言配置管理库

概述

Viper 是一个功能强大的 Go 语言配置管理库，由 Steve Francia（spf13）创建并维护。它旨在为 Go 应用程序提供完整的配置解决方案，支持多种配置格式、环境变量、远程配置等特性，是 Go 生态系统中使用最广泛的配置管理工具之一。

核心特性

1. 多格式支持

Viper 支持多种配置文件格式： - JSON - YAML - TOML - HCL - INI - Java Properties - 环境变量

2. 配置优先级

Viper 按照以下优先级读取配置（从高到低）： 1. 显式调用 Set 设置的值 2. 命令行标志（flag） 3. 环境变量 4. 配置文件 5. 默认值

3. 远程配置支持

支持从 etcd、Consul 等远程配置中心读取配置
支持配置热更新

4. 类型安全

自动类型转换
支持结构体绑定

安装

text

go get github.com/spf13/viper

基本使用示例

示例1：读取配置文件

text

package main

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

func main() {
    // 设置配置文件名（不含扩展名）
    viper.SetConfigName("config")
    
    // 设置配置文件类型
    viper.SetConfigType("yaml")
    
    // 添加配置文件搜索路径
    viper.AddConfigPath(".")
    viper.AddConfigPath("$HOME/.myapp")
    viper.AddConfigPath("/etc/myapp/")
    
    // 读取配置文件
    if err := viper.ReadInConfig(); err != nil {
        panic(fmt.Errorf("Fatal error config file: %w", err))
    }
    
    // 获取配置值
    host := viper.GetString("server.host")
    port := viper.GetInt("server.port")
    
    fmt.Printf("Server: %s:%d\n", host, port)
}

对应的 config.yaml 文件：

text

server:
  host: "localhost"
  port: 8080
  timeout: 30s

database:
  host: "localhost"
  port: 5432
  name: "mydb"
  user: "admin"

示例2：环境变量支持

text

package main

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

func main() {
    // 自动绑定环境变量
    viper.AutomaticEnv()
    
    // 设置环境变量前缀
    viper.SetEnvPrefix("MYAPP")
    
    // 绑定特定键到环境变量
    viper.BindEnv("server.port", "MYAPP_SERVER_PORT")
    
    // 环境变量 MYAPP_SERVER_PORT 将覆盖配置文件中的值
    port := viper.GetInt("server.port")
    fmt.Printf("Server port: %d\n", port)
}

示例3：命令行参数集成

text

package main

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

func main() {
    // 使用 pflag（兼容标准 flag）
    pflag.Int("port", 8080, "server port")
    pflag.Parse()
    
    // 绑定 pflag 到 viper
    viper.BindPFlags(pflag.CommandLine)
    
    // 也可以使用标准 flag
    flag.String("host", "localhost", "server host")
    flag.Parse()
    
    // 绑定标准 flag
    viper.BindPFlags(flag.CommandLine)
    
    host := viper.GetString("host")
    port := viper.GetInt("port")
    
    fmt.Printf("Server: %s:%d\n", host, port)
}

示例4：结构体绑定

text

package main

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

type Config struct {
    Server struct {
        Host string `mapstructure:"host"`
        Port int    `mapstructure:"port"`
    } `mapstructure:"server"`
    
    Database struct {
        Host string `mapstructure:"host"`
        Port int    `mapstructure:"port"`
        Name string `mapstructure:"name"`
    } `mapstructure:"database"`
}

func main() {
    viper.SetConfigName("config")
    viper.SetConfigType("yaml")
    viper.AddConfigPath(".")
    
    if err := viper.ReadInConfig(); err != nil {
        panic(err)
    }
    
    var config Config
    if err := viper.Unmarshal(&config); err != nil {
        panic(err)
    }
    
    fmt.Printf("Server: %s:%d\n", config.Server.Host, config.Server.Port)
    fmt.Printf("Database: %s@%s:%d/%s\n", 
        config.Database.Name, 
        config.Database.Host, 
        config.Database.Port,
        config.Database.Name)
}

示例5：配置监听与热更新

text

package main

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

func main() {
    viper.SetConfigName("config")
    viper.SetConfigType("yaml")
    viper.AddConfigPath(".")
    
    if err := viper.ReadInConfig(); err != nil {
        panic(err)
    }
    
    // 监听配置文件变化
    viper.WatchConfig()
    
    // 注册配置变化回调
    viper.OnConfigChange(func(e fsnotify.Event) {
        fmt.Println("Config file changed:", e.Name)
        fmt.Println("New port:", viper.GetInt("server.port"))
    })
    
    // 保持程序运行以观察变化
    for {
        time.Sleep(1 * time.Second)
    }
}

示例6：设置默认值

text

package main

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

func main() {
    // 设置默认值
    viper.SetDefault("server.host", "localhost")
    viper.SetDefault("server.port", 8080)
    viper.SetDefault("server.timeout", "30s")
    
    // 这些值会在没有配置文件或环境变量时使用
    host := viper.GetString("server.host")
    port := viper.GetInt("server.port")
    timeout := viper.GetDuration("server.timeout")
    
    fmt.Printf("Default config: %s:%d (timeout: %v)\n", host, port, timeout)
}

高级特性

1. 远程配置

text

// 需要额外导入
import _ "github.com/spf13/viper/remote"

// 从 etcd 读取配置
viper.AddRemoteProvider("etcd", "http://127.0.0.1:4001", "/config/myapp.yaml")
viper.SetConfigType("yaml")

err := viper.ReadRemoteConfig()
if err != nil {
    panic(err)
}

2. 多配置文件支持

text

// 读取多个配置文件
viper.SetConfigName("config")
viper.SetConfigType("yaml")
viper.AddConfigPath(".")

// 读取主配置
if err := viper.ReadInConfig(); err != nil {
    panic(err)
}

// 合并覆盖配置
viper.SetConfigName("config.override")
if err := viper.MergeInConfig(); err != nil {
    // 覆盖文件不存在也没关系
    fmt.Println("No override config found")
}