Go读取YML配置时如何解析带默认值的环境变量

问题原因 #

标准库os.ExpandEnv仅支持解析$VAR或${VAR}格式的环境变量占位符，不会识别${VAR:DEFAULT}中的默认值语法，因此环境变量不存在时会直接将占位符替换为空字符串，无法自动 fallback 到配置里写的默认值。

解决方案 #

方案1：自定义实现占位符解析逻辑（无第三方依赖） #

自己实现替换函数，解析带冒号默认值的占位符即可，代码如下：

package main

import (
	"os"
	"strings"

	"gopkg.in/yaml.v2"
)

type SysConfig struct {
	Db struct {
		Name string `yaml:"name"`
		Host string `yaml:"host"`
	} `yaml:"db"`
}

// 自定义环境变量展开函数，支持${VAR:DEFAULT}默认值语法
func expandEnvWithDefault(s string) string {
	return os.Expand(s, func(key string) string {
		// 拆分环境变量名和默认值
		parts := strings.SplitN(key, ":", 2)
		envVal := os.Getenv(parts[0])
		if envVal != "" {
			return envVal
		}
		// 环境变量为空且存在默认值时返回默认值
		if len(parts) == 2 {
			return parts[1]
		}
		return ""
	})
}

func main() {
	confContent, err := os.ReadFile("config.yml")
	if err != nil {
		panic(err)
	}
	// 替换为自定义的展开函数
	confContent = []byte(expandEnvWithDefault(string(confContent)))
	conf := &SysConfig{}
	if err := yaml.Unmarshal(confContent, conf); err != nil {
		panic(err)
	}
	// 测试：未设置DB_NAME时输出qm，设置后输出环境变量对应值
	println(conf.Db.Name)
}

方案2：使用成熟配置库（适合复杂项目） #

如果项目允许引入第三方依赖，直接用viper这类通用配置库，原生支持带默认值的环境变量替换、多配置源合并等能力，无需手写解析逻辑。

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