Golang Viper配置读取：优先取服务内部字段，再取外部字段

需求 #

读取配置时优先获取服务内部字段的值，当内部字段不存在时再读取外部全局字段。

现有YAML配置 #

auth_service:
  log_level: debug
  port: 9999
mail_service:
  log_level: debug
  port: 9998
smtp:
  host: localhost
  port: 1025
  username: ""
  password: ""
  email_from: "mailservice@test.test"
  retries_count: 5
log_level: test

问题场景 #

尝试通过viper.RegisterAlias("log_level", "auth_service.log_level")实现优先级读取，但该方式是单向映射，读取log_level时只会返回服务内部字段值，无法 fallback 到全局的log_level字段。现有配置读取代码如下：

type Config struct  {
    LogLevel string `mapstructure:"log_level"`
    Port int `mapstructure:"port"`
    SMTP SMTPConfig `mapstructure:"smtp"`
}

type SMTPConfig struct {
    Host         string     `mapstructure:"host"`
    Port         int        `mapstructure:"port"`
    Username     string     `mapstructure:"username"`
    Password     string     `mapstructure:"password"`
    EmailFrom    string     `mapstructure:"email_from"`
    RetriesCount int        `mapstructure:"retries_count"`
}

func LoadConfig(path string) (*Config, error) {
    type ServiceConfig struct {
        Cfg Config `mapstructure:"auth_service"`
    }
    viper.RegisterAlias("log_level","auth_service.log_level")
    viper.AutomaticEnv()
    if path != "" {
        dir := p.Dir(path)
        file := p.Base(path)
        fileParts := strings.Split(file, ".")
        if len(fileParts) != 2 {
            return nil, fmt.Errorf("incorrect config file: %s", file)
        }
        viper.AddConfigPath(dir)
        viper.SetConfigName(fileParts[0])
        viper.SetConfigType(fileParts[1])
        err := viper.ReadInConfig()
        if err != nil {
            return nil, err
        }
    }
    fmt.Println(viper.AllKeys())
    var config ServiceConfig
    err := viper.Unmarshal(&config)
    if err != nil {
        return nil, err
    }
    return &config.Cfg, nil
}

注：使用ServiceConfig是因为mapstructure:"service_name.field"无法直接生效。

解决方案 #

Viper的别名机制不支持双向 fallback，需要手动控制字段读取优先级：

修改后的加载函数 #

func LoadConfig(path string) (*Config, error) {
    viper.AutomaticEnv()
    if path != "" {
        dir := p.Dir(path)
        file := p.Base(path)
        fileParts := strings.Split(file, ".")
        if len(fileParts) != 2 {
            return nil, fmt.Errorf("incorrect config file: %s", file)
        }
        viper.AddConfigPath(dir)
        viper.SetConfigName(fileParts[0])
        viper.SetConfigType(fileParts[1])
        err := viper.ReadInConfig()
        if err != nil {
            return nil, err
        }
    }

    // 先读取服务内部配置
    var config Config
    if err := viper.UnmarshalKey("auth_service", &config); err != nil {
        return nil, err
    }

    // 内部字段为空时，读取全局字段
    if config.LogLevel == "" {
        config.LogLevel = viper.GetString("log_level")
    }

    // 读取全局SMTP配置
    if err := viper.UnmarshalKey("smtp", &config.SMTP); err != nil {
        return nil, err
    }

    return &config, nil
}

逻辑说明 #

1. 先通过viper.UnmarshalKey加载服务内部的配置字段到结构体
2. 单独检查LogLevel字段，若内部无值则读取全局的log_level
3. 全局共享的SMTP配置直接从根节点读取

通用化优化（支持多服务） #

如果需要适配多个服务（如auth_service、mail_service），可将服务名作为参数传入：

func LoadConfig(path string, serviceName string) (*Config, error) {
    viper.AutomaticEnv()
    if path != "" {
        dir := p.Dir(path)
        file := p.Base(path)
        fileParts := strings.Split(file, ".")
        if len(fileParts) != 2 {
            return nil, fmt.Errorf("incorrect config file: %s", file)
        }
        viper.AddConfigPath(dir)
        viper.SetConfigName(fileParts[0])
        viper.SetConfigType(fileParts[1])
        err := viper.ReadInConfig()
        if err != nil {
            return nil, err
        }
    }

    var config Config
    // 根据服务名读取内部配置
    if err := viper.UnmarshalKey(serviceName, &config); err != nil {
        return nil, err
    }

    if config.LogLevel == "" {
        config.LogLevel = viper.GetString("log_level")
    }

    if err := viper.UnmarshalKey("smtp", &config.SMTP); err != nil {
        return nil, err
    }

    return &config, nil
}

// 调用示例
// cfg, err := LoadConfig("config.yaml", "auth_service")

内容的提问来源于stack exchange，提问作者Евгений