如何基于环境通过YAML文件配置Golang应用

问题背景 #

已实现单环境YAML配置加载，现在需要根据环境（dev/test/prod等）加载对应配置。采用嵌套YAML定义各环境变量，但无法通过环境参数索引获取对应配置结构体，报错invalid operation: cannot index configFile (variable of type *configFile)。

原代码问题分析 #

当前configFile结构体定义了固定的Dev、Test字段，属于静态结构体，Go语言中不能像map一样用字符串索引访问结构体字段，因此configFile[env]这种写法不合法。

解决方案 #

方案1：使用Map存储多环境配置 #

修改配置结构体为map[string]AppConfig，直接通过环境字符串索引获取对应配置：

配置文件（config.yml，无需修改）

dev:
  database_url: postgres://postgres:@localhost:5432/database_dev
test:
  database_url: postgres://postgres:@localhost:5432/database_test

调整后的config.go

import (
  "fmt"
  "os"
  "gopkg.in/yaml.v2"
)

type AppConfig struct {
  DatabaseUrl string `yaml:"database_url"`
}

func LoadConfig(env string) (*AppConfig, error) {
  envConfigs := make(map[string]AppConfig)
  
  file, err := os.Open("config.yml")
  if err != nil {
    return nil, err
  }
  defer file.Close()

  decoder := yaml.NewDecoder(file)
  if err := decoder.Decode(&envConfigs); err != nil {
    return nil, err
  }

  config, exists := envConfigs[env]
  if !exists {
    return nil, fmt.Errorf("environment %s not found in config", env)
  }

  return &config, nil
}

方案2：使用Switch匹配环境（适合环境数量固定的场景） #

如果环境数量较少且固定，可以保留原结构体，通过switch语句匹配环境参数：

调整后的config.go

import (
  "fmt"
  "os"
  "gopkg.in/yaml.v2"
)

type AppConfig struct {
  DatabaseUrl string `yaml:"database_url"`
}

type configFile struct {
  Dev  AppConfig `yaml:"dev"`
  Test AppConfig `yaml:"test"`
}

func LoadConfig(env string) (*AppConfig, error) {
  configFile := &configFile{}
  
  file, err := os.Open("config.yml")
  if err != nil {
    return nil, err
  }
  defer file.Close()

  decoder := yaml.NewDecoder(file)
  if err := decoder.Decode(configFile); err != nil {
    return nil, err
  }

  switch env {
  case "dev":
    return &configFile.Dev, nil
  case "test":
    return &configFile.Test, nil
  default:
    return nil, fmt.Errorf("unsupported environment: %s", env)
  }
}

额外优化点 #

• 完善错误处理：原代码忽略所有错误，上述方案添加了错误返回逻辑，调用方可处理配置加载失败的情况
• 默认环境设置：可给env参数设置默认值，比如将函数定义为func LoadConfig(env ...string) (*AppConfig, error)，未传入环境时默认使用dev
• 配置路径可配置：将配置文件路径作为参数传入，增强代码灵活性

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