Go库环境变量管理方案咨询：寻求简洁清晰的优化实现方式

针对你提到的痛点，这里提供几种符合Go语言最佳实践的配置实现方案，既避免重复读取环境变量，又不用到处传递结构体，也无需依赖不推荐的多init()函数：

方案1：包级配置结构体+显式初始化（基础版） #

定义一个包级的配置结构体，通过显式初始化函数在程序启动时一次性加载所有配置（从环境变量、配置文件等），内部代码直接使用这个包级变量即可，无需传参。

// config.go
package mylib

import (
    "os"
    "strconv"
    "sync"
)

type Config struct {
    APIKey     string
    Timeout    int
    MaxRetries int
}

var cfg Config
var once sync.Once // 确保配置只初始化一次

// InitConfig 需在程序启动阶段调用，完成配置加载
func InitConfig() {
    once.Do(func() {
        // 从环境变量读取，带默认值
        cfg.APIKey = getEnv("MYLIB_API_KEY", "")
        cfg.Timeout = getEnvInt("MYLIB_TIMEOUT", 30)
        cfg.MaxRetries = getEnvInt("MYLIB_MAX_RETRIES", 3)
    })
}

// 辅助函数：读取字符串环境变量，无值时返回默认值
func getEnv(key, defaultValue string) string {
    if val := os.Getenv(key); val != "" {
        return val
    }
    return defaultValue
}

// 辅助函数：读取整数环境变量，解析失败时返回默认值
func getEnvInt(key string, defaultValue int) int {
    val := os.Getenv(key)
    if val == "" {
        return defaultValue
    }
    num, err := strconv.Atoi(val)
    if err != nil {
        return defaultValue
    }
    return num
}

优势 #

• 仅加载一次配置，避免重复调用os.Getenv()的冗余操作；
• 内部代码直接访问cfg即可，无需到处传递结构体；
• 显式初始化比init()更可控，你可以决定在启动流程的哪个阶段加载配置（比如先完成日志初始化再加载配置）；
• sync.Once保证即使多次调用InitConfig()，配置也只会初始化一次，线程安全。

方案2：函数选项模式（支持用户自定义配置） #

如果你的库需要允许用户传入自定义配置（覆盖环境变量的默认值），可以用函数选项模式，兼顾默认配置和自定义需求。

// config.go
package mylib

import (
    "os"
    "strconv"
    "sync"
)

type Config struct {
    APIKey     string
    Timeout    int
    MaxRetries int
}

var cfg Config
var once sync.Once

// Option 配置选项函数，用于自定义配置
type Option func(*Config)

// WithAPIKey 自定义API Key
func WithAPIKey(key string) Option {
    return func(c *Config) {
        c.APIKey = key
    }
}

// WithTimeout 自定义超时时间
func WithTimeout(timeout int) Option {
    return func(c *Config) {
        c.Timeout = timeout
    }
}

// InitConfig 初始化配置，可传入选项覆盖默认值
func InitConfig(opts ...Option) {
    once.Do(func() {
        // 先加载环境变量作为默认值
        cfg.APIKey = getEnv("MYLIB_API_KEY", "")
        cfg.Timeout = getEnvInt("MYLIB_TIMEOUT", 30)
        cfg.MaxRetries = getEnvInt("MYLIB_MAX_RETRIES", 3)

        // 应用用户传入的自定义选项
        for _, opt := range opts {
            opt(&cfg)
        }
    })
}

// 辅助函数同方案1...

用法示例 #

用户可以在启动时自定义配置：

mylib.InitConfig(
    mylib.WithAPIKey("my-custom-key"),
    mylib.WithTimeout(60),
)

优势 #

• 兼容环境变量默认值和用户自定义配置；
• 初始化逻辑集中，内部使用无需传参；
• 扩展灵活，后续新增配置项只需添加对应的WithXXX函数即可。

方案3：私有配置+公开访问器（高封装性） #

如果希望完全避免内部代码意外修改配置，可以将配置结构体设为私有，仅提供公开的读取函数，确保配置的不可变性。

// config.go
package mylib

import (
    "os"
    "strconv"
    "sync"
)

// 私有配置结构体，内部字段不可外部修改
type config struct {
    apiKey     string
    timeout    int
    maxRetries int
}

var cfg config
var once sync.Once

func InitConfig() {
    once.Do(func() {
        cfg.apiKey = getEnv("MYLIB_API_KEY", "")
        cfg.timeout = getEnvInt("MYLIB_TIMEOUT", 30)
        cfg.maxRetries = getEnvInt("MYLIB_MAX_RETRIES", 3)
    })
}

// GetAPIKey 获取API Key
func GetAPIKey() string {
    return cfg.apiKey
}

// GetTimeout 获取超时时间
func GetTimeout() int {
    return cfg.timeout
}

// GetMaxRetries 获取最大重试次数
func GetMaxRetries() int {
    return cfg.maxRetries
}

// 辅助函数同方案1...

优势 #

• 配置字段完全私有，避免内部代码误修改；
• 提供明确的访问函数，语义清晰，便于维护；
• 同样保证只初始化一次，无重复读取问题。

内容的提问来源于stack exchange，提问作者uzumas