Golang处理YAML：保留键顺序与序列化空行的方案问询

要同时实现保留键的插入顺序和序列化时保留键之间的空行，yaml.v2的MapSlice和viper都无法满足需求，可以通过gopkg.in/yaml.v3的yaml.Node类型来实现，它原生支持保留YAML文档的结构细节（包括键顺序、空行、重复键等）。

核心思路 #

yaml.v3的yaml.Node会完整解析YAML文档的所有结构信息，包括映射节点的键值对顺序、节点之间的空行分隔。解析后可以直接修改节点内容，序列化时能还原原有的格式风格。

代码实现 #

首先安装yaml.v3依赖：

go get gopkg.in/yaml.v3

示例代码：

package main

import (
	"bytes"
	"fmt"
	"log"

	"gopkg.in/yaml.v3"
)

func main() {
	// 示例YAML内容
	yamlContent := []byte(`D: 20

B: 6

A: 30

D: 1
`)

	// 解析到yaml.Node，完整保留原文档结构
	var root yaml.Node
	if err := yaml.Unmarshal(yamlContent, &root); err != nil {
		log.Fatalf("解析YAML失败: %v", err)
	}

	// 验证键的顺序（可选）
	if root.Kind == yaml.MappingNode {
		fmt.Println("解析后的键顺序:")
		for i := 0; i < len(root.Content); i += 2 {
			key := root.Content[i].Value
			val := root.Content[i+1].Value
			fmt.Printf("- %s: %s\n", key, val)
		}
	}

	// 修改指定键的值（示例：修改第一个D的值为25）
	if root.Kind == yaml.MappingNode {
		for i := 0; i < len(root.Content); i += 2 {
			if root.Content[i].Value == "D" {
				root.Content[i+1].Value = "25"
				break // 仅修改第一个匹配的键
			}
		}
	}

	// 序列化回YAML，保留空行和键顺序
	var buf bytes.Buffer
	encoder := yaml.NewEncoder(&buf)
	encoder.SetIndent(2) // 保持与原文档一致的缩进
	if err := encoder.Encode(&root); err != nil {
		log.Fatalf("序列化YAML失败: %v", err)
	}
	encoder.Close()

	fmt.Println("\n序列化后的YAML:")
	fmt.Print(buf.String())
}

关键说明 #

1. 保留键顺序：yaml.v3的MappingNode的Content切片按解析顺序存储键值对（键在偶数索引，对应值在奇数索引），完全保留原文档的键顺序。
2. 保留空行：yaml.Node在解析时会记录文档的结构分隔信息，序列化时会自动还原键之间的空行。
3. 支持重复键：默认解析模式下会保留所有重复键（如示例中的两个D），无需额外配置。

对比其他方案 #

• yaml.v2 MapSlice：仅能保留键顺序，但序列化时会丢失空行，因为它只存储键值对数据，不记录格式信息。
• viper：底层使用无序的map存储数据，无法保留键的原始顺序。

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