MagicOnion项目迁移至Source Generator模式的技术指南

MagicOnion作为一款基于gRPC的C#通信框架，近期从传统的moc.exe代码生成工具迁移到了Source Generator模式。这一变化带来了更现代化的开发体验，但也让部分用户在迁移过程中遇到了困惑。本文将详细介绍如何从旧版MagicOnion迁移到新版Source Generator架构。

项目结构重构

在旧版MagicOnion中，典型的项目结构包含三个部分：Server、Client和Shared。Shared项目存放服务接口定义和DTO对象，通过moc.exe工具生成客户端代理代码。

新版架构中，Shared项目的角色依然重要，但配置方式发生了变化：

1. 创建一个独立的类库项目作为Shared项目
2. 在该项目中定义服务接口和DTO
3. 确保所有项目都引用了MagicOnion.Client.SourceGenerator包

依赖配置

迁移过程中需要特别注意NuGet包的引用：

• 服务端项目：引用MagicOnion.AspNetCore和MessagePack
• 客户端项目：引用MagicOnion.Client和MessagePack
• Shared项目：引用MagicOnion.Abstractions和MessagePack

服务接口定义

服务接口定义方式基本保持不变，但不再需要moc.exe工具生成代码。例如：

using MagicOnion;
using MessagePack;

public interface IHealthCheck : IService<IHealthCheck>
{
    UnaryResult<bool> IsHealthy();
}

Source Generator配置

新版MagicOnion使用Source Generator自动生成客户端代码，无需手动运行工具。只需在客户端项目中：

1. 添加MagicOnion.Client.SourceGenerator包引用
2. 在需要生成客户端代码的地方添加[MagicOnionClientGeneration]特性

[MagicOnionClientGeneration(typeof(IHealthCheck))]
public partial class MagicOnionGeneratedClient {}

Unity项目集成

对于Unity项目，需要特别注意：

1. 确保Unity支持C# 9.0或更高版本
2. 将MagicOnion.Client.SourceGenerator.dll放入Assets/Plugins目录
3. 在Unity中创建Shared程序集定义，包含服务接口

常见问题解决

1. MagicOnionClientGeneration未找到：确保正确引用了MagicOnion.Client.SourceGenerator包
2. 代码未生成：检查项目是否启用了Roslyn分析器
3. 序列化问题：确保DTO类都添加了[MessagePackObject]特性

性能优化建议

Source Generator模式相比旧版有以下优势：

1. 编译时生成代码，无需额外构建步骤
2. 更好的IDE集成和代码导航
3. 更快的开发迭代速度

迁移完成后，开发者将获得更流畅的开发体验，同时保持原有的高性能通信能力。通过合理规划项目结构和正确配置依赖，可以顺利完成从传统代码生成工具到Source Generator的过渡。