为何YamlDotNet不序列化类的私有字段？技术疑问求解

嘿，这个问题问到点子上了！你看到的“私有字段永远不会被序列化”其实是默认行为，而非绝对规则——这背后是YamlDotNet遵循的面向对象设计理念，咱们一步步拆解：

一、默认不序列化私有字段的核心原因：封装原则 #

私有字段是类的内部实现细节，面向对象设计的核心就是把这些细节隐藏起来，只通过公共成员（比如属性、方法）对外暴露契约。如果序列化框架默认就把私有字段也序列化了，会带来两个大问题：

• 破坏封装：外部代码（包括序列化器）直接依赖类的内部状态，一旦你修改了私有字段的名字、类型甚至逻辑，旧的序列化数据就可能无法反序列化，兼容性大打折扣。
• 违背设计意图：类的作者通常希望通过公共属性来控制状态的读写，私有字段的变化不应该影响外部的序列化逻辑。

所以YamlDotNet默认只处理公共成员，这是对封装原则的尊重，也是为了让你的代码更健壮、更易维护。

二、那类的状态怎么完整序列化还原？ #

你担心的“私有成员不序列化就无法还原类的状态”是合理的，但解决思路不是打破封装，而是用更合适的方式处理：

1. 通过公共属性暴露状态 #

最推荐的方式是把私有字段的状态通过公共属性暴露出来，序列化器会自动处理这些属性，反序列化时通过属性的setter（或者构造函数）来恢复状态。比如：

public class Order
{
    private decimal _totalAmount;
    
    // 公共属性暴露私有字段的状态
    public decimal TotalAmount
    {
        get => _totalAmount;
        set => _totalAmount = value;
    }

    // 或者用只读属性+构造函数初始化
    public Order(decimal total)
    {
        _totalAmount = total;
    }
}

这样序列化时只需要处理TotalAmount属性，反序列化时通过构造函数或setter就能正确恢复_totalAmount的状态，完全不需要直接序列化私有字段。

2. 强制序列化特定私有字段（如果必须） #

如果确实有特殊需求（比如遗留代码、性能优化），YamlDotNet完全支持序列化私有字段，只需要给私有字段标记[YamlMember]特性：

public class User
{
    // 标记这个私有字段需要被序列化
    [YamlMember(Alias = "user_secret_key")]
    private string _secretKey;

    public User(string secret)
    {
        _secretKey = secret;
    }

    public bool ValidateKey(string input) => input == _secretKey;
}

这样序列化时_secretKey会被序列化为user_secret_key字段，反序列化时也能正确赋值。

3. 自定义序列化逻辑（完全掌控） #

如果需要更复杂的控制（比如部分私有字段序列化、加密私有数据等），可以实现IYamlSerializable接口，手动编写序列化和反序列化的逻辑：

public class CustomData : IYamlSerializable
{
    private int _internalCounter;
    private string _hiddenData;

    public void ReadYaml(IParser parser, Type expectedType, ObjectDeserializer nestedObjectDeserializer)
    {
        // 手动读取YAML节点，给私有字段赋值
        parser.Consume<MappingStart>();
        _internalCounter = (int)nestedObjectDeserializer(typeof(int));
        _hiddenData = (string)nestedObjectDeserializer(typeof(string));
        parser.Consume<MappingEnd>();
    }

    public void WriteYaml(IEmitter emitter, ObjectSerializer nestedObjectSerializer)
    {
        // 手动写入私有字段到YAML
        emitter.Emit(new MappingStart());
        nestedObjectSerializer(_internalCounter);
        nestedObjectSerializer(_hiddenData);
        emitter.Emit(new MappingEnd());
    }
}

总结 #

YamlDotNet默认不序列化私有字段是有意的设计选择，目的是维护封装和代码的健壮性，但它并没有完全禁止私有字段的序列化——你可以根据需求选择合适的方式来处理类的内部状态。

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