使用typenv管理Golang环境变量

typenv是一个轻量级的类型安全环境变量管理库，它可以帮助开发者以类型安全的方式管理和访问环境变量。下面我将详细介绍typenv的使用方法。

安装

go get github.com/yp05327/typenv

基本用法

1. 定义配置结构体

首先定义一个结构体来表示你的配置，使用结构体标签来指定环境变量名：

type Config struct {
    Port     int    `env:"PORT" default:"8080"`
    Debug    bool   `env:"DEBUG"`
    Database string `env:"DB_URL" required:"true"`
    Timeout  int64  `env:"TIMEOUT" default:"30"`
}

2. 加载环境变量

使用Load函数加载环境变量到配置结构体：

package main

import (
    "fmt"
    "github.com/yp05327/typenv"
)

func main() {
    var cfg Config
    if err := typenv.Load(&cfg); err != nil {
        panic(err)
    }
    
    fmt.Printf("Config: %+v\n", cfg)
}

高级特性

自定义解析器

typenv支持自定义类型解析器。例如，解析时间间隔：

type Duration time.Duration

func (d *Duration) UnmarshalText(text []byte) error {
    dur, err := time.ParseDuration(string(text))
    if err != nil {
        return err
    }
    *d = Duration(dur)
    return nil
}

type Config struct {
    Interval Duration `env:"INTERVAL" default:"1h"`
}

嵌套结构体

typenv支持嵌套结构体：

type DBConfig struct {
    Host string `env:"DB_HOST" default:"localhost"`
    Port int    `env:"DB_PORT" default:"5432"`
}

type Config struct {
    Database DBConfig `envPrefix:"DB_"`
    AppName  string   `env:"APP_NAME"`
}

环境变量前缀

可以为嵌套结构体设置环境变量前缀：

type Config struct {
    Database DBConfig `envPrefix:"DB_"`
    // 对应的环境变量将是 DB_HOST 和 DB_PORT
}

必填字段验证

标记字段为必填：

type Config struct {
    APIKey string `env:"API_KEY" required:"true"`
}

默认值

为字段设置默认值：

type Config struct {
    Workers int `env:"WORKERS" default:"4"`
}

完整示例

package main

import (
    "fmt"
    "time"
    
    "github.com/yp05327/typenv"
)

type Duration time.Duration

func (d *Duration) UnmarshalText(text []byte) error {
    dur, err := time.ParseDuration(string(text))
    if err != nil {
        return err
    }
    *d = Duration(dur)
    return nil
}

type DBConfig struct {
    Host     string `env:"HOST" default:"localhost"`
    Port     int    `env:"PORT" default:"5432"`
    Username string `env:"USERNAME" required:"true"`
    Password string `env:"PASSWORD" required:"true"`
}

type Config struct {
    AppName  string   `env:"APP_NAME" default:"myapp"`
    Debug    bool     `env:"DEBUG"`
    Timeout  Duration `env:"TIMEOUT" default:"30s"`
    Database DBConfig `envPrefix:"DB_"`
}

func main() {
    var cfg Config
    if err := typenv.Load(&cfg); err != nil {
        panic(fmt.Errorf("failed to load config: %w", err))
    }
    
    fmt.Printf("Config: %+v\n", cfg)
    fmt.Printf("DB Host: %s\n", cfg.Database.Host)
    fmt.Printf("Timeout: %v\n", time.Duration(cfg.Timeout))
}

最佳实践

1. 集中管理配置：将所有环境变量配置集中在一个结构体中
2. 使用默认值：为可选参数设置合理的默认值
3. 明确必填项：标记所有必需的配置项
4. 使用嵌套结构体：按功能模块组织配置
5. 添加前缀：避免环境变量名冲突

typenv通过结构体标签和反射提供了类型安全的环境变量管理方式，比直接使用os.Getenv更加健壮和易于维护。它特别适合在微服务架构或需要大量环境变量配置的应用中使用。