go-cfg: Golang统一读取多源配置数据的插件库

go-cfg 是一个用于统一读取多种配置源数据的Golang库，它提供了简洁的API来从不同来源（如文件、环境变量、命令行参数等）加载配置，并支持配置合并和优先级设置。

主要特性

1. 支持多种配置源：JSON、YAML、TOML、环境变量、命令行参数等
2. 配置合并功能，支持设置优先级
3. 支持配置热更新
4. 简单易用的API
5. 支持自定义配置源

安装

go get github.com/go-cfg/cfg

基本使用示例

package main

import (
	"fmt"
	"log"
	
	"github.com/go-cfg/cfg"
)

type Config struct {
	Server struct {
		Host string `json:"host" yaml:"host" env:"SERVER_HOST"`
		Port int    `json:"port" yaml:"port" env:"SERVER_PORT"`
	} `json:"server" yaml:"server"`
	Database struct {
		URL      string `json:"url" yaml:"url" env:"DB_URL"`
		Username string `json:"username" yaml:"username" env:"DB_USER"`
		Password string `json:"password" yaml:"password" env:"DB_PASS"`
	} `json:"database" yaml:"database"`
}

func main() {
	var config Config
	
	// 创建配置加载器
	loader := cfg.New(
		// 从环境变量加载
		cfg.WithEnv(),
		// 从JSON文件加载
		cfg.WithFile("config.json", cfg.JSON),
		// 从YAML文件加载
		cfg.WithFile("config.yaml", cfg.YAML),
	)
	
	// 加载配置
	if err := loader.Load(&config); err != nil {
		log.Fatalf("Failed to load config: %v", err)
	}
	
	// 使用配置
	fmt.Printf("Server: %s:%d\n", config.Server.Host, config.Server.Port)
	fmt.Printf("Database: %s@%s\n", config.Database.Username, config.Database.URL)
}

高级用法

1. 设置配置源优先级

loader := cfg.New(
	// 低优先级 - 首先尝试从JSON文件加载
	cfg.WithFile("config.json", cfg.JSON, cfg.Priority(10)),
	// 高优先级 - 然后从环境变量加载，会覆盖JSON中的配置
	cfg.WithEnv(cfg.Priority(20)),
	// 最高优先级 - 最后从命令行参数加载，会覆盖所有其他配置
	cfg.WithFlag(cfg.Priority(30)),
)

2. 配置热更新

// 创建支持热更新的加载器
loader := cfg.New(
	cfg.WithFile("config.yaml", cfg.YAML, cfg.Watch(true)),
)

var config Config
if err := loader.Load(&config); err != nil {
	log.Fatal(err)
}

// 监听配置变更
ch := loader.Watch()
go func() {
	for {
		select {
		case <-ch:
			// 配置已更新，重新加载
			if err := loader.Load(&config); err != nil {
				log.Printf("Failed to reload config: %v", err)
			} else {
				log.Println("Config reloaded successfully")
			}
		}
	}
}()

3. 自定义配置源

// 实现cfg.Source接口
type MyCustomSource struct {
	data map[string]interface{}
}

func (s *MyCustomSource) Load() (map[string]interface{}, error) {
	return s.data, nil
}

func (s *MyCustomSource) Priority() int {
	return 15
}

// 使用自定义配置源
customSource := &MyCustomSource{
	data: map[string]interface{}{
		"server": map[string]interface{}{
			"host": "custom.host",
			"port": 8080,
		},
	},
}

loader := cfg.New(
	cfg.WithSource(customSource),
)

配置合并规则

go-cfg 按照以下规则合并配置：

1. 按优先级从低到高依次加载配置
2. 高优先级配置会覆盖低优先级配置中的相同字段
3. 对于嵌套结构，会递归合并
4. 数组类型会被完全替换而不是合并

最佳实践

1. 定义清晰的结构体来表示配置
2. 为配置字段添加适当的标签（json、yaml、env等）
3. 合理设置配置源优先级
4. 生产环境中建议使用环境变量或密钥管理服务存储敏感信息
5. 开发环境可以使用配置文件方便修改

总结

go-cfg 是一个功能强大且灵活的配置管理库，它简化了从多种来源加载和合并配置的过程。通过统一的接口，开发者可以轻松管理应用程序的配置，而无需关心底层配置源的细节。无论是小型项目还是大型分布式系统，go-cfg 都能提供良好的配置管理解决方案。