MagicOnion客户端源码生成器中MessagePack格式化器映射问题解析

问题背景

MagicOnion是一个基于gRPC的RPC框架，它使用MessagePack作为默认的序列化协议。在客户端源码生成过程中，系统需要为各种类型生成对应的MessagePack格式化器代码。然而，当前版本中存在一个已知问题：MessagePack格式化器映射表中的泛型类型列表已经过时，导致某些集合类型（如HashSet）无法正确生成格式化器代码。

问题详情

在MagicOnion.Client.SourceGenerator项目的SerializationFormatterNameMapper.cs文件中，定义了一个MessagePackWellKnownSerializationTypes类，其中包含了一个预定义的泛型类型与对应MessagePack格式化器的映射表。这个映射表目前缺少对HashSet等现代集合类型的支持。

当服务方法返回类似UnaryTask<HashSet<int>>这样的类型时，源码生成器会错误地生成格式化器代码：

// 错误生成的代码
case 6: return new global::MessagePack.Formatters.System.Collections.Generic.HashSetFormatter<global::System.UInt32>();

// 正确的代码应该是
case 6: return new global::MessagePack.Formatters.HashSetFormatter<global::System.UInt32>();

技术分析

MessagePack格式化器映射机制的工作原理如下：

1. 源码生成器首先检查类型是否为MagicOnion特有的DynamicArgumentTuple
2. 如果不是，则检查类型是否在预定义的GenericFormattersMap中
3. 如果仍未找到，则尝试使用用户自定义的格式化器

当前问题出在第二步，因为GenericFormattersMap没有包含HashSet<>的条目，导致系统无法正确识别和生成对应的格式化器代码。

解决方案

官方修复方案

最彻底的解决方案是更新MessagePackWellKnownSerializationTypes类中的GenericFormattersMap字典，添加缺失的泛型类型映射。需要添加的条目包括但不限于：

{"global::System.Collections.Generic.HashSet<>", "global::MessagePack.Formatters.HashSetFormatter" },
{"global::System.Collections.Generic.ISet<>", "global::MessagePack.Formatters.InterfaceSetFormatter" },
// 其他可能缺失的集合类型

临时解决方案

在等待官方修复的同时，开发者可以采用以下临时解决方案：

1. 自定义格式化器：在项目中手动实现缺失的格式化器类。例如，为HashSet创建自定义格式化器：

namespace MessagePack.Formatters.System.Collections.Generic
{
    public sealed class HashSetFormatter<T> : CollectionFormatterBase<T, HashSet<T>, HashSet<T>.Enumerator, HashSet<T>>
    {
        protected override int? GetCount(HashSet<T> sequence) => sequence.Count;

        protected override void Add(HashSet<T> collection, int index, T value, MessagePackSerializerOptions options)
            => collection.Add(value);

        protected override HashSet<T> Complete(HashSet<T> intermediateCollection)
            => intermediateCollection;

        protected override HashSet<T> Create(int count, MessagePackSerializerOptions options)
            => new HashSet<T>(options.Security.GetEqualityComparer<T>());

        protected override HashSet<T>.Enumerator GetSourceEnumerator(HashSet<T> source)
            => source.GetEnumerator();
    }
}

2. 类型替换：在服务契约中使用List等已支持的集合类型替代HashSet。

最佳实践建议

1. 定期检查类型支持：在使用MagicOnion时，应定期检查项目中使用的集合类型是否在支持的列表中。

2. 自定义格式化器管理：对于项目中频繁使用的特殊类型，考虑创建专门的项目来管理这些自定义格式化器。

3. 版本兼容性检查：升级MagicOnion或MessagePack库时，注意检查格式化器映射表是否有更新。

总结

MagicOnion客户端源码生成器中的MessagePack格式化器映射问题主要源于预定义的泛型类型列表过时。这个问题虽然可以通过自定义格式化器临时解决，但长期来看需要官方更新映射表以支持更多现代集合类型。开发者在使用过程中应当注意类型兼容性，并在必要时实现自定义解决方案。