MessagePack-CSharp 中无Setter属性的序列化问题解析

背景介绍

MessagePack-CSharp 是一个高效的二进制序列化库，在.NET生态中被广泛使用。近期版本(v2.3+)中，对于没有setter的属性序列化行为发生了变化，这引发了一些开发者的困惑。

问题现象

在MessagePack v2.2及更早版本中，可以正常序列化只有getter的属性。例如以下Player类：

[MessagePackObject]
public class Player
{
    [Key("name")]
    public string Name { get; }

    [IgnoreMember]
    public List<int> Scores { get; } = new();

    [Key("totalScore")]
    public int TotalScore => Scores.Sum();

    public Player(string name)
    {
        Name = name;
    }
}

但在v2.3+版本中，尝试序列化时会抛出"No set accessor"异常。

技术分析

设计原理变更

MessagePack-CSharp的动态对象解析器(DynamicObjectResolver)在v2.3+版本中加强了类型安全验证。现在它会同时检查序列化和反序列化的可行性，即使当前操作只需要序列化功能。

这种设计基于以下考虑：

1. 动态生成的格式化器需要同时处理序列化和反序列化
2. 确保类型定义的一致性，避免运行时错误
3. 防止开发者意外创建无法完整序列化/反序列化的类型

具体限制

以下情况会导致序列化失败：

1. 标记为[Key]的属性没有setter
2. 类有自定义构造函数但未标记[SerializationConstructor]
3. 计算属性(如TotalScore)依赖被忽略的字段

解决方案

推荐方案

1. 添加虚拟setter：

[Key("totalScore")]
public int TotalScore
{
    get => Scores.Sum();
    set => throw new NotImplementedException();
}

2. 使用init-only属性：

[Key("name")]
public required string Name { get; init; }

替代方案

1. 添加空构造函数：

[SerializationConstructor]
private Player() { }

2. 自定义格式化器： 为特定类型实现IMessagePackFormatter接口

最佳实践

1. 对于DTO类型，建议使用完整的get/set属性
2. 计算属性应标记为[IgnoreMember]
3. 需要自定义构造逻辑时，明确标记[SerializationConstructor]
4. 考虑将纯数据传输与业务逻辑分离

未来展望

虽然当前版本强制要求双向序列化能力，但社区已认识到单向序列化的需求。未来版本可能会引入：

1. 显式的单向序列化标记
2. 更精细的序列化能力控制
3. 更友好的错误提示

总结

MessagePack-CSharp在v2.3+版本中对类型安全的要求更加严格，这虽然带来了一些迁移成本，但有助于构建更健壮的序列化系统。开发者可以通过添加虚拟setter或调整类型设计来适应这一变化。理解这一变更背后的设计理念，有助于我们更好地设计可序列化类型。