Viper写入YAML时mapstructure标签未生效，如何使其生效？

问题根源 #

mapstructure标签仅用于Viper将配置文件内容解析到Go结构体的场景，而Viper写入配置时，默认通过反射处理结构体字段，只会把驼峰命名转成小写（比如EnforcedProvider转成enforcedprovider），不会识别mapstructure标签定义的连字符格式。

解决方法 #

给结构体字段同时添加yaml标签，标签内容与mapstructure保持一致，利用yaml库的序列化能力生成正确的字段名，再通过Viper写入文件。

步骤1：修改结构体，添加yaml标签

import "gopkg.in/yaml.v3"

type config struct {
    Contexts       map[string]Context `mapstructure:"contexts" yaml:"contexts"`
    CurrentContext string             `mapstructure:"current-context" yaml:"current-context"`
    Tokens         []Token            `mapstructure:"tokens" yaml:"tokens"`
}

type Context struct {
    Endpoint         string   `mapstructure:"endpoint,omitempty" yaml:"endpoint,omitempty"`
    Token            string   `mapstructure:"token,omitempty" yaml:"token,omitempty"`
    Platform         string   `mapstructure:"platform" yaml:"platform"`
    Components       []string `mapstructure:"components,omitempty" yaml:"components,omitempty"`
    Channel          string   `mapstructure:"channel,omitempty" yaml:"channel,omitempty"`
    Version          string   `mapstructure:"version,omitempty" yaml:"version,omitempty"`
    EnforcedProvider string   `mapstructure:"enforced-provider,omitempty" yaml:"enforced-provider,omitempty"`
}

步骤2：序列化结构体并写入配置

不再使用viper.Set逐个赋值，而是先将整个配置结构体序列化为YAML字节，再读取到Viper后写入文件：

import "bytes"

// 更新上下文配置
configObj.Contexts[contextName] = context

// 将配置结构体序列化为YAML字节
yamlBytes, err := yaml.Marshal(configObj)
if err != nil {
    return err
}

// 将YAML字节加载到Viper
err = viper.ReadConfig(bytes.NewBuffer(yamlBytes))
if err != nil {
    return err
}

// 写入配置文件
err = viper.WriteConfig()
if err != nil {
    return err
}

替代方案（无需添加yaml标签） #

如果不想修改结构体标签，可以手动将结构体转换为带有正确键名的map[string]interface{}，再通过viper.MergeConfigMap合并后写入。这种方式需要逐个处理字段，适合简单结构体：

// 转换Context为指定键名的map
func contextToMap(ctx Context) map[string]interface{} {
    m := make(map[string]interface{})
    m["endpoint"] = ctx.Endpoint
    m["token"] = ctx.Token
    m["platform"] = ctx.Platform
    m["components"] = ctx.Components
    m["channel"] = ctx.Channel
    m["version"] = ctx.Version
    m["enforced-provider"] = ctx.EnforcedProvider
    return m
}

// 构建整个配置map
configMap := map[string]interface{}{
    "contexts":        map[string]interface{}{contextName: contextToMap(context)},
    "current-context": configObj.CurrentContext,
    "tokens":          configObj.Tokens,
}

// 合并到Viper
err = viper.MergeConfigMap(configMap)
if err != nil {
    return err
}

// 写入文件
err = viper.WriteConfig()
if err != nil {
    return err
}

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