如何在 Golang 中把任意结构体转换为具有排版缩进的美观 YAML 字符串-Golang-PHP中文网

yaml.marshalindent 可生成带缩进的 yaml，需传入前缀和缩进字符串（如 "", " "），且结构体字段须导出并合理使用 yaml tag 控制 key 名、omitempty 等行为；时间等类型需自定义 marshalyaml 实现格式控制，map 无序性导致键顺序不可控，推荐用 struct 替代 map 保证顺序。

如何在 golang 中把任意结构体转换为具有排版缩进的美观 yaml 字符串

用 `yaml.MarshalIndent` 生成带缩进的 YAML 字符串

Go 标准库不支持 YAML，必须用第三方库（如 gopkg.in/yaml.v3）。直接调用 yaml.Marshal 会输出无缩进的紧凑格式，要美观排版，必须用 yaml.MarshalIndent。

它比 yaml.Marshal 多两个参数：缩进空格数、嵌套时每级额外缩进空格数。常见用法是传 2 和 2，对应 2 空格缩进风格：

data := struct{ Name string; Age int }{"Alice", 30}
yamlBytes, err := yaml.MarshalIndent(data, "", "  ") // 注意：第二个参数是前缀，通常为空字符串
if err != nil {
    log.Fatal(err)
}
fmt.Println(string(yamlBytes))

输出为：

Age: 30
Name: Alice

注意：yaml.MarshalIndent 的第二个参数是每行开头的「前缀」，不是缩进字符；第三个参数才是实际用于缩进的字符串（推荐用空格，不用 \t，否则部分解析器可能报错）。

结构体字段必须可导出且有 YAML tag

YAML 库只能序列化导出字段（首字母大写），且默认使用字段名小写形式作为 key。若想控制 key 名、忽略空值或指定别名，得加 yaml tag：

yaml:"name" → 输出 key 为 name
yaml:"name,omitempty" → 该字段为空值（零值）时不输出
yaml:"-" → 完全忽略该字段
yaml:",omitempty,string" → 同时启用 omitempty 和 string 转换（比如把 int 当字符串输出）

例如：

type User struct {
    ID    int    `yaml:"id"`
    Name  string `yaml:"name,omitempty"`
    Email string `yaml:"email"`
}

若 Name 为空字符串，就不会出现在 YAML 中。

Golang Naming

Go（Golang）命名规范 — 包括包、构造函数、结构体、接口、常量、枚举、错误、布尔值、接收器、getter/setter、函数等。

下载

时间类型和自定义类型容易被转成非预期格式

time.Time 默认序列化为 RFC3339 字符串（如 2024-05-20T14:23:11Z），看起来正常，但如果你希望用更短的 2024-05-20 格式，不能靠配置选项解决——gopkg.in/yaml.v3 不提供全局时间格式钩子。

可行做法只有两个：

字段类型改用 string，手动赋值格式化后的时间
为结构体实现 MarshalYAML() 方法，接管该字段序列化逻辑

后者更干净，但要注意：一旦实现了 MarshalYAML，整个结构体都由你控制输出，不能再依赖默认行为。例如：

func (u User) MarshalYAML() (interface{}, error) {
    type Alias User // 防止无限递归
    return struct {
        Alias
        Birthday string `yaml:"birthday"`
    }{
        Alias:    (Alias)(u),
        Birthday: u.Birthday.Format("2006-01-02"),
    }, nil
}