Go语言YAML序列化时如何添加换行符提升生成配置文件的可读性

方案1：使用 yaml.v3 自定义序列化逻辑（推荐） #

目前Go生态最常用的YAML处理库 gopkg.in/yaml.v3 支持通过自定义 MarshalYAML 方法控制序列化格式，你可以手动构建YAML映射节点，在字段分组之间插入空行即可实现需求：

首先安装依赖：

go get gopkg.in/yaml.v3

完整实现代码如下：

package main

import (
	"gopkg.in/yaml.v3"
	"os"
)

type Config struct {
	Author      string `yaml:"author"`
	License     string `yaml:"license"`
	Workspace   string `yaml:"workspace"`
	Description string `yaml:"description"`
	Target      string `yaml:"target"`
}

func (c Config) MarshalYAML() (interface{}, error) {
	// 按预期空行位置拆分字段分组
	type group1 struct {
		Author  string `yaml:"author"`
		License string `yaml:"license"`
	}
	type group2 struct {
		Workspace   string `yaml:"workspace"`
		Description string `yaml:"description"`
	}
	type group3 struct {
		Target string `yaml:"target"`
	}

	return &yaml.Node{
		Kind: yaml.MappingNode,
		Content: []*yaml.Node{
			// 第一组字段
			mustMarshalGroup(group1{c.Author, c.License})...,
			// 插入空行
			&yaml.Node{Kind: yaml.ScalarNode, Value: "", HeadComment: "\n"},
			// 第二组字段
			mustMarshalGroup(group2{c.Workspace, c.Description})...,
			// 插入空行
			&yaml.Node{Kind: yaml.ScalarNode, Value: "", HeadComment: "\n"},
			// 第三组字段
			mustMarshalGroup(group3{c.Target})...,
		},
	}, nil
}

// 辅助方法：将分组结构体转为yaml节点列表
func mustMarshalGroup(v interface{}) []*yaml.Node {
	var n yaml.Node
	if err := n.Encode(v); err != nil {
		panic(err)
	}
	return n.Content
}

func main() {
	cfg := Config{
		Author:      "demo",
		License:     "MIT",
		Workspace:   "/opt/workspace",
		Description: "golang cli tool config",
		Target:      "linux/amd64",
	}
	data, err := yaml.Marshal(cfg)
	if err != nil {
		panic(err)
	}
	_ = os.WriteFile("config.yaml", data, 0644)
}

最终序列化输出效果：

author: demo
license: MIT

workspace: /opt/workspace
description: golang cli tool config

target: linux/amd64

方案2：文本替换（简单高效，适合固定结构场景） #

如果你的Config结构体字段不会频繁变更，可以先正常序列化，再对输出的字节做字符串替换实现空行插入，代码更简洁：

import "bytes"

// 正常序列化得到字节流
data, err := yaml.Marshal(cfg)
if err != nil {
	panic(err)
}
// 在指定字段前插入空行
data = bytes.ReplaceAll(data, []byte("workspace:"), []byte("\nworkspace:"))
data = bytes.ReplaceAll(data, []byte("target:"), []byte("\ntarget:"))

_ = os.WriteFile("config.yaml", data, 0644)

只要保证配置值中不会出现和字段名完全一致的内容，该方案就可以稳定运行，满足绝大多数场景需求。

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