Harvester: Golang 配置管理插件详解

Harvester 是一个强大的 Go 语言配置管理库，支持静态和动态配置，并能与 Consul 集成实现配置中心化管理。下面我将详细介绍 Harvester 的使用方法。

1. Harvester 核心特性

• 支持 JSON、YAML、TOML 等多种配置文件格式
• 支持环境变量覆盖配置
• 支持 Consul 作为配置中心
• 支持动态配置重载
• 提供监控配置变更的能力

2. 基本安装

go get github.com/beatlabs/harvester

3. 静态配置使用示例

3.1 定义配置结构

type Config struct {
    Server struct {
        Host string `seed:"localhost" env:"SERVER_HOST" json:"host"`
        Port int    `seed:"8080" env:"SERVER_PORT" json:"port"`
    } `json:"server"`
    LogLevel string `seed:"info" env:"LOG_LEVEL" json:"log_level"`
}

3.2 加载配置文件

func main() {
    cfg := &Config{}
    
    h, err := harvester.New(cfg).
        WithFile("config.json", harvester.JSON).
        Create()
    if err != nil {
        log.Fatalf("failed to create harvester: %v", err)
    }

    if err := h.Harvest(context.Background()); err != nil {
        log.Fatalf("failed to harvest config: %v", err)
    }

    fmt.Printf("Config loaded: %+v\n", cfg)
}

4. 动态配置与 Consul 集成

4.1 初始化 Consul 客户端

import "github.com/hashicorp/consul/api"

func getConsulClient() (*api.Client, error) {
    config := api.DefaultConfig()
    config.Address = "127.0.0.1:8500" // Consul 地址
    return api.NewClient(config)
}

4.2 使用 Harvester 从 Consul 加载配置

func main() {
    consulClient, err := getConsulClient()
    if err != nil {
        log.Fatal(err)
    }

    cfg := &Config{}
    
    h, err := harvester.New(cfg).
        WithConsulSeed("myapp/config", consulClient).
        WithConsulMonitor("myapp/config", consulClient, 5*time.Second).
        Create()
    if err != nil {
        log.Fatal(err)
    }

    if err := h.Harvest(context.Background()); err != nil {
        log.Fatal(err)
    }

    fmt.Printf("Initial config from Consul: %+v\n", cfg)

    // 监听配置变更
    go func() {
        for change := range h.Changes() {
            fmt.Printf("Config changed: %+v\n", change)
        }
    }()

    // 保持程序运行
    select {}
}

5. 高级功能

5.1 多配置源优先级

Harvester 支持多配置源，优先级如下：

1. 环境变量
2. Consul KV
3. 配置文件
4. 结构体中的 seed 值

h, err := harvester.New(cfg).
    WithFile("config.json", harvester.JSON).
    WithConsulSeed("myapp/config", consulClient).
    WithEnvVarPrefix("MYAPP").
    Create()

5.2 自定义配置变更处理器

h, err := harvester.New(cfg).
    WithChangeHandler(func(cfg interface{}) {
        fmt.Println("Configuration was changed:", cfg)
        // 在这里可以执行热更新逻辑
    }).
    Create()

6. 最佳实践

1. 配置验证：在 ChangeHandler 中添加配置验证逻辑
2. 优雅降级：当 Consul 不可用时回退到本地配置
3. 敏感信息：考虑使用 Vault 而非 Consul 存储敏感配置
4. 性能考虑：合理设置监控间隔，避免频繁检查

7. 完整示例

package main

import (
	"context"
	"fmt"
	"log"
	"time"

	"github.com/beatlabs/harvester"
	"github.com/hashicorp/consul/api"
)

type Config struct {
	Server struct {
		Host string `seed:"localhost" env:"SERVER_HOST" consul:"host" json:"host"`
		Port int    `seed:"8080" env:"SERVER_PORT" consul:"port" json:"port"`
	} `json:"server"`
	LogLevel string `seed:"info" env:"LOG_LEVEL" consul:"log_level" json:"log_level"`
}

func main() {
	// 初始化 Consul 客户端
	consulClient, err := api.NewClient(api.DefaultConfig())
	if err != nil {
		log.Fatalf("failed to create consul client: %v", err)
	}

	cfg := &Config{}

	// 创建 Harvester 实例
	h, err := harvester.New(cfg).
		WithFile("config.json", harvester.JSON).          // 本地配置文件
		WithConsulSeed("myapp/config", consulClient).    // 初始从 Consul 加载
		WithConsulMonitor("myapp/config", consulClient, 10*time.Second). // 监控变更
		WithChangeHandler(func(c interface{}) {
			fmt.Println("Configuration changed:", c)
			// 在这里可以执行热更新逻辑
		}).
		Create()
	if err != nil {
		log.Fatalf("failed to create harvester: %v", err)
	}

	// 首次加载配置
	if err := h.Harvest(context.Background()); err != nil {
		log.Fatalf("failed to harvest config: %v", err)
	}

	fmt.Printf("Initial config: %+v\n", cfg)

	// 保持程序运行并监听配置变更
	select {}
}

Harvester 为 Go 应用程序提供了强大而灵活的配置管理能力，特别是与 Consul 的集成使得分布式环境下的配置管理变得更加简单高效。