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

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

2025-06-16 22:13:29作者:房伟宁

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的过渡。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
117
202
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
504
399
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
62
144
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
296
1.01 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
97
251
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
384
37
MateChatMateChat
前端智能化场景解决方案UI库,轻松构建你的AI应用,我们将持续完善更新,欢迎你的使用与建议。 官网地址:https://matechat.gitcode.com
693
91
RuoYi-Cloud-Vue3RuoYi-Cloud-Vue3
🎉 基于Spring Boot、Spring Cloud & Alibaba、Vue3 & Vite、Element Plus的分布式前后端分离微服务架构权限管理系统
Vue
97
74
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
357
341