Go编写Snowfakery YAML文件：空文件与字段排序问题求助

一、先解决struct生成空文件的问题 #

你之前用struct生成空文件，大概率是两个原因：

• struct字段首字母小写：Go的反射只能访问首字母大写的导出字段，yaml包依赖反射完成序列化，所以字段必须以大写开头。
• 未设置正确的yaml标签：如果Snowfakery的YAML字段名和struct字段名不一致（比如YAML是first_name，struct是FirstName），需要通过yaml:"first_name"标签做映射。

示例struct定义：

type SnowfakeryConfig struct {
    Version string `yaml:"version"`
    Tables  []Table `yaml:"tables"`
}

type Table struct {
    Name          string        `yaml:"name"`
    Fields        []Field       `yaml:"fields"`
    Relationships []Relationship `yaml:"relationships"`
}

type Field struct {
    Name string `yaml:"name"`
    Type string `yaml:"type"`
}

按此定义赋值后，用yaml.Marshal就能生成有效内容，且字段顺序与struct定义顺序完全一致。

二、避免字段自动排序的核心：用struct而非map/interface #

Go标准库的yaml.Marshal对map[string]interface{}会按键的字母顺序排序（因为Go原生map本身无序），但struct的序列化顺序严格遵循代码中字段的定义顺序，刚好匹配Snowfakery对字段顺序的要求。

如果你的YAML结构存在动态字段（无法提前定义struct），可以使用gopkg.in/yaml.v3的Node类型手动构建有序结构，示例代码如下：

package main

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

func main() {
    // 构建有序的YAML根节点
    root := &yaml.Node{Kind: yaml.MappingNode}
    
    // 按业务需要的顺序添加键值对
    root.Content = append(root.Content,
        &yaml.Node{Kind: yaml.ScalarNode, Value: "version"},
        &yaml.Node{Kind: yaml.ScalarNode, Value: "1.0"},
        &yaml.Node{Kind: yaml.ScalarNode, Value: "tables"},
        &yaml.Node{Kind: yaml.SequenceNode, Content: []*yaml.Node{
            {Kind: yaml.MappingNode, Content: []*yaml.Node{
                {Kind: yaml.ScalarNode, Value: "name"},
                {Kind: yaml.ScalarNode, Value: "Account"},
                {Kind: yaml.ScalarNode, Value: "fields"},
                {Kind: yaml.SequenceNode, Content: []*yaml.Node{
                    {Kind: yaml.MappingNode, Content: []*yaml.Node{
                        {Kind: yaml.ScalarNode, Value: "name"},
                        {Kind: yaml.ScalarNode, Value: "Name"},
                        {Kind: yaml.ScalarNode, Value: "type"},
                        {Kind: yaml.ScalarNode, Value: "string"},
                    }},
                }},
            }},
        }},
    )
    
    // 序列化到文件
    f, _ := os.Create("snowfakery.yml")
    defer f.Close()
    encoder := yaml.NewEncoder(f)
    encoder.SetIndent(2)
    encoder.Encode(root)
}

这种方式可完全手动控制字段顺序，适合结构动态变化的场景。

总结 #

1. 若YAML结构固定，优先使用带yaml标签的导出struct，既能解决空文件问题，又能严格保持字段顺序。
2. 若结构动态无法提前定义struct，用gopkg.in/yaml.v3的Node类型手动构建有序映射节点，避免使用map导致排序混乱。

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