Golang环境变量管理助手插件envh的使用

Envh简介

Envh是一个Golang环境变量管理库，由两部分组成：

1. Env对象：将环境变量封装在对象中并提供便捷的辅助方法
2. Env树对象：通过树结构管理环境变量，可以像YAML文件那样分层存储配置

安装

go get github.com/antham/envh

使用示例

下面是一个完整的示例，展示如何使用envh将环境变量映射到结构体：

package main

import (
	"encoding/json"
	"fmt"
	"os"
	"strings"
	"github.com/antham/envh"
)

type CONFIG2 struct {
	DB struct {
		USERNAME   string
		PASSWORD   string
		HOST       string
		NAME       string
		PORT       int
		URL        string
		USAGELIMIT float32
	}
	MAILER struct {
		HOST     string
		USERNAME string
		PASSWORD string
		ENABLED  bool
	}
	MAP map[string]string
}

// Walk方法实现自定义字段设置
func (c *CONFIG2) Walk(tree *envh.EnvTree, keyChain []string) (bool, error) {
	if setter, ok := map[string]func(*envh.EnvTree, []string) error{
		"CONFIG2_DB_URL": c.setURL,
		"CONFIG2_MAP":    c.setMap,
	}[strings.Join(keyChain, "_")]; ok {
		return true, setter(tree, keyChain)
	}

	return false, nil
}

// 设置MAP字段
func (c *CONFIG2) setMap(tree *envh.EnvTree, keyChain []string) error {
	datas := map[string]string{}

	keys, err := tree.FindChildrenKeys(keyChain...)

	if err != nil {
		return err
	}

	for _, key := range keys {
		value, err := tree.FindString(append(keyChain, key)...)

		if err != nil {
			return err
		}

		datas[key] = value
	}

	c.MAP = datas

	return nil
}

// 设置DB.URL字段
func (c *CONFIG2) setURL(tree *envh.EnvTree, keyChain []string) error {
	datas := map[string]string{}

	for _, key := range []string{"USERNAME", "PASSWORD", "HOST", "NAME"} {
		value, err := tree.FindString("CONFIG2", "DB", key)

		if err != nil {
			return err
		}

		datas[key] = value
	}

	port, err := tree.FindInt("CONFIG2", "DB", "PORT")

	if err != nil {
		return err
	}

	c.DB.URL = fmt.Sprintf("jdbc:mysql://%s:%d/%s?user=%s&password=%s", 
		datas["HOST"], port, datas["NAME"], datas["USERNAME"], datas["PASSWORD"])

	return nil
}

func main() {
	// 清空并设置环境变量
	os.Clearenv()
	setEnv("CONFIG2_DB_USERNAME", "foo")
	setEnv("CONFIG2_DB_PASSWORD", "bar")
	setEnv("CONFIG2_DB_HOST", "localhost")
	setEnv("CONFIG2_DB_NAME", "my-db")
	setEnv("CONFIG2_DB_PORT", "3306")
	setEnv("CONFIG2_DB_USAGELIMIT", "95.6")
	setEnv("CONFIG2_MAILER_HOST", "127.0.0.1")
	setEnv("CONFIG2_MAILER_USERNAME", "foo")
	setEnv("CONFIG2_MAILER_PASSWORD", "bar")
	setEnv("CONFIG2_MAILER_ENABLED", "true")
	setEnv("CONFIG2_MAP_KEY1", "value1")
	setEnv("CONFIG2_MAP_KEY2", "value2")
	setEnv("CONFIG2_MAP_KEY3", "value3")

	// 创建EnvTree实例
	env, err := envh.NewEnvTree("^CONFIG2", "_")

	if err != nil {
		panic(err)
	}

	// 创建配置结构体
	s := CONFIG2{}

	// 将环境变量填充到结构体
	err = env.PopulateStruct(&s)

	if err != nil {
		panic(err)
	}

	// 输出JSON格式的配置
	b, err := json.Marshal(s)
	if err != nil {
		panic(err)
	}

	fmt.Println(string(b))
}

// 辅助函数：设置环境变量
func setEnv(key, value string) {
	if err := os.Setenv(key, value); err != nil {
		panic(err)
	}
}

输出结果：

{
  "DB": {
    "USERNAME": "foo",
    "PASSWORD": "bar",
    "HOST": "localhost",
    "NAME": "my-db",
    "PORT": 3306,
    "URL": "jdbc:mysql://localhost:3306/my-db?user=foo&password=bar",
    "USAGELIMIT": 95.6
  },
  "MAILER": {
    "HOST": "127.0.0.1",
    "USERNAME": "foo",
    "PASSWORD": "bar",
    "ENABLED": true
  },
  "MAP": {
    "KEY1": "value1",
    "KEY2": "value2",
    "KEY3": "value3"
  }
}

功能说明

1. 通过NewEnvTree创建环境变量树，第一个参数是前缀正则表达式，第二个参数是分隔符
2. 实现Walk方法可以自定义某些字段的设置逻辑
3. PopulateStruct方法将环境变量自动填充到结构体中
4. 支持基本数据类型(string, int, bool, float32等)和map类型的自动转换

这个示例展示了如何使用envh库将环境变量映射到结构体，包括自定义字段设置和自动类型转换等功能。