使用joshbetz/config实现Golang环境变量与JSON配置自动解析重载

joshbetz/config 是一个实用的Go配置管理库，它支持从环境变量、JSON文件等多种来源加载配置，并支持配置变更时的自动重载。下面我将详细介绍它的使用方法。

安装

go get github.com/joshbetz/config

基本使用

1. 定义配置结构

首先定义一个结构体来表示你的配置：

type AppConfig struct {
    Port     int    `json:"port" env:"APP_PORT"`
    LogLevel string `json:"log_level" env:"LOG_LEVEL"`
    Database struct {
        Host     string `json:"host" env:"DB_HOST"`
        Username string `json:"username" env:"DB_USER"`
        Password string `json:"password" env:"DB_PASS"`
    } `json:"database"`
}

2. 初始化配置

package main

import (
	"fmt"
	"log"
	"time"

	"github.com/joshbetz/config"
)

func main() {
	var cfg AppConfig

	// 初始化配置，从config.json和环境变量加载
	c, err := config.New("config.json", &cfg)
	if err != nil {
		log.Fatalf("Failed to load config: %v", err)
	}

	// 打印初始配置
	fmt.Printf("Initial config: %+v\n", cfg)

	// 设置自动重载间隔为5秒
	c.AutoRefresh(5 * time.Second)

	// 添加配置变更回调
	c.OnChange(func(newConfig interface{}) {
		fmt.Println("Config changed!")
		updated := newConfig.(*AppConfig)
		fmt.Printf("New config: %+v\n", *updated)
	})

	// 保持程序运行以观察配置变更
	select {}
}

3. 配置文件示例 (config.json)

{
  "port": 8080,
  "log_level": "info",
  "database": {
    "host": "localhost",
    "username": "admin",
    "password": "secret"
  }
}

高级特性

1. 环境变量覆盖

环境变量的优先级高于JSON文件中的配置。例如：

export APP_PORT=9090
export DB_HOST=production.db.example.com

程序启动时会优先使用这些环境变量的值。

2. 多配置文件支持

可以指定多个配置文件，后面的文件会覆盖前面的配置：

c, err := config.New("config.default.json", "config.json", &cfg)

3. 自定义加载器

你可以实现自己的配置加载器：

type CustomLoader struct{}

func (l *CustomLoader) Load(cfg interface{}) error {
    // 自定义加载逻辑
    return nil
}

c.AddLoader(&CustomLoader{})

4. 手动刷新配置

if err := c.Refresh(); err != nil {
    log.Printf("Failed to refresh config: %v", err)
}

实际应用示例

package main

import (
	"fmt"
	"log"
	"net/http"
	"time"

	"github.com/joshbetz/config"
)

type ServerConfig struct {
	Port        int           `json:"port" env:"PORT"`
	Timeout     time.Duration `json:"timeout" env:"TIMEOUT"`
	FeatureFlag bool          `json:"feature_flag" env:"FEATURE_FLAG"`
}

func main() {
	var cfg ServerConfig

	// 初始化配置
	c, err := config.New("config.json", &cfg)
	if err != nil {
		log.Fatal(err)
	}

	// 设置自动重载
	c.AutoRefresh(10 * time.Second)

	// 启动HTTP服务器
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		if cfg.FeatureFlag {
			fmt.Fprintf(w, "New feature is enabled! Timeout: %v", cfg.Timeout)
		} else {
			fmt.Fprintf(w, "Standard response. Port: %d", cfg.Port)
		}
	})

	log.Printf("Starting server on :%d", cfg.Port)
	log.Fatal(http.ListenAndServe(fmt.Sprintf(":%d", cfg.Port), nil)
}

注意事项

1. 配置结构体字段必须是可导出的(首字母大写)
2. 环境变量名称默认是全大写的结构体字段名，可以通过env标签自定义
3. 自动重载会定期检查文件修改时间，可能不适合高性能场景
4. 对于敏感信息，建议使用环境变量而非配置文件

joshbetz/config 提供了一种简单灵活的方式来管理应用程序配置，特别适合需要动态重载配置的场景。通过合理使用环境变量和配置文件，可以实现开发、测试和生产环境之间的无缝切换。