MessagePack-CSharp 中自定义序列化器的递归序列化问题解析

问题背景

在使用 MessagePack-CSharp 进行数据序列化时，开发者经常会遇到需要自定义序列化逻辑的场景。本文通过一个实际案例，分析在实现递归自定义序列化时遇到的典型问题及其解决方案。

案例场景

假设我们有以下数据结构需要序列化：

1. DataWrapper 是一个包装类，包含一个 ID 和一个实现了 IChildType 接口的值对象
2. Parent 类包含一个 DataWrapper 类型的子对象
3. FooChild 和 BarChild 是 IChildType 的具体实现

开发者希望实现以下序列化效果：

• DataWrapper 的 ID 使用自定义扩展格式(Extension Format)序列化
• DataWrapper 的值对象使用标准 MessagePack 格式序列化

初始实现方案

最初尝试的方案是为 DataWrapper 实现一个自定义的 IMessagePackFormatter：

public class DataFormatter : IMessagePackFormatter<DataWrapper> {
  public void Serialize(ref MessagePackWriter writer, DataWrapper value, MessagePackSerializerOptions options) {
    if (value.Value == null) {
      return;
    }

    byte[] messageBytes = MessagePackSerializer.Serialize(value.Value.GetType(), value.Value);
    writer.WriteArrayHeader(2);
    writer.WriteExtensionFormat(new ExtensionResult(88, BitConverter.GetBytes(value.Id)));
    writer.WriteRaw(messageBytes);
  }
  // 省略反序列化代码
}

遇到的问题

当嵌套使用 DataWrapper 时，序列化结果仅包含最内层的对象，外层对象被丢弃。例如：

{
  "name":"Parent",
  "child":[
    [88,"AQAAAA=="],
    {"name":"Bar"}
  ]
}

期望的结果是包含完整嵌套结构的 JSON，但实际输出中缺少了中间的 FooChild 对象。

问题分析

问题的根源在于序列化方法中使用了 MessagePackSerializer.Serialize 生成了独立的字节数组，然后通过 WriteRaw 写入。这种方式会导致：

1. 每次调用 Serialize 都会创建一个新的序列化上下文
2. 嵌套对象的序列化过程与主序列化流程分离
3. 序列化状态无法正确传递和保持

解决方案

正确的做法是使用接受 MessagePackWriter 引用的 Serialize 重载方法，确保所有序列化操作共享同一个写入上下文：

public void Serialize(ref MessagePackWriter writer, DataWrapper value, MessagePackSerializerOptions options) {
  if (value.Value == null) {
    return;
  }

  writer.WriteArrayHeader(2);
  writer.WriteExtensionFormat(new ExtensionResult(88, BitConverter.GetBytes(value.Id)));
  MessagePackSerializer.Serialize(value.Value.GetType(), ref writer, value.Value, options);
}

关键点总结

1. 序列化上下文一致性：在递归序列化场景中，必须保持序列化上下文的一致性，使用 ref MessagePackWriter 的重载方法可以确保这一点。

2. 性能考虑：避免不必要的字节数组分配和拷贝，直接使用 writer 接口效率更高。

3. 类型处理：当处理多态类型（如接口 IChildType）时，需要确保所有可能的实现类型都已正确注册到解析器中。

扩展思考

在实际开发中，处理复杂对象的序列化时还需要考虑：

1. 循环引用的处理
2. 版本兼容性
3. 性能优化（特别是对于大型对象图）
4. 自定义解析器的注册和使用

通过这个案例，我们可以更好地理解 MessagePack-CSharp 序列化机制的工作原理，以及在实现自定义序列化逻辑时需要注意的关键点。