MagicOnion Unity快速入门指南：构建gRPC通信的Unity客户端

孔振冶Harry

于 2025-06-10 09:02:11 发布

阅读量408

点赞数 3

CC 4.0 BY-SA版权

本文链接：https://blog.youkuaiyun.com/gitblog_01173/article/details/148549105

MagicOnion Unity快速入门指南：构建gRPC通信的Unity客户端

MagicOnion Unified Realtime/API framework for .NET platform and Unity. 项目地址: https://gitcode.com/gh_mirrors/ma/MagicOnion

前言

MagicOnion是一个基于gRPC的.NET通信框架，它简化了服务器与客户端之间的RPC通信实现。本教程将指导您如何在Unity项目中快速集成MagicOnion，实现Unity客户端与.NET服务器之间的通信。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

操作系统：Windows或macOS
.NET SDK：8.0或更高版本
Unity版本：2022.3或更高版本，或Unity 6（6000.0.34f1或更高）

注意：Unity 6的某些早期版本存在Source Generator问题，建议使用6000.0.34f1或更高版本。

项目结构规划

我们将创建以下项目结构：

项目根目录/
├─ 解决方案文件.sln
└─ src/
   ├─ 服务器项目/
   │  ├─ 项目文件.csproj
   │  └─ ...
   ├─ 共享库项目/
   │  ├─ 项目文件.csproj
   │  └─ ...
   └─ Unity项目/
      ├─ Unity项目文件
      └─ ...

创建基础项目

1. 创建服务器和共享库项目

使用以下命令创建基础项目结构：

# 设置项目名称变量
PROJECT_NAME=MyApp

# 创建基础项目结构
dotnet new gitignore
dotnet new grpc -o src/$PROJECT_NAME.Server -n $PROJECT_NAME.Server
dotnet new classlib -f netstandard2.1 -o src/$PROJECT_NAME.Shared -n $PROJECT_NAME.Shared

# 创建解决方案并添加项目
dotnet new sln -n $PROJECT_NAME
dotnet sln add src/$PROJECT_NAME.Server --in-root
dotnet sln add src/$PROJECT_NAME.Shared --in-root

# 配置服务器项目
pushd src/$PROJECT_NAME.Server
dotnet remove package Grpc.AspNetCore
dotnet add package MagicOnion.Server
dotnet add reference ../$PROJECT_NAME.Shared
popd

# 配置共享库项目
pushd src/$PROJECT_NAME.Shared
dotnet add package MagicOnion.Abstractions
popd

2. 创建Unity项目

通过Unity Hub创建一个新的Unity项目，选择"Universal 3D"或其他适合的模板，将其放置在src/项目名称.Unity目录下。

定义服务接口

在共享库项目中定义服务接口，这是服务器和客户端通信的契约：

// 文件路径：src/MyApp.Shared/IMyFirstService.cs
using MagicOnion;

namespace MyApp.Shared
{
    // 服务接口必须继承IService<T>
    public interface IMyFirstService : IService<IMyFirstService>
    {
        // UnaryResult表示这是一个异步方法
        UnaryResult<int> SumAsync(int x, int y);
    }
}

实现服务器端

1. 配置服务器启动

修改服务器项目的Program.cs文件：

var builder = WebApplication.CreateBuilder(args);

// 添加MagicOnion服务
builder.Services.AddMagicOnion();

var app = builder.Build();

// 映射MagicOnion服务
app.MapMagicOnionService();

app.Run();

2. 实现服务逻辑

创建服务实现类：

// 文件路径：src/MyApp.Server/Services/MyFirstService.cs
using MagicOnion;
using MagicOnion.Server;
using MyApp.Shared;

namespace MyApp.Server.Services;

public class MyFirstService : ServiceBase<IMyFirstService>, IMyFirstService
{
    public async UnaryResult<int> SumAsync(int x, int y)
    {
        Console.WriteLine($"收到参数:{x}, {y}");
        return x + y;
    }
}

3. 启动服务器

运行服务器项目，确保控制台输出监听地址（如http://localhost:5210），Unity客户端将使用此地址连接。

配置Unity客户端

1. 安装必要包

Unity项目需要安装以下包：

NuGetForUnity：通过Unity Package Manager安装，URL：

https://github.com/GlitchEnzo/NuGetForUnity.git?path=/src/NuGetForUnity

MagicOnion.Client：

通过NuGetForUnity安装MagicOnion.Client

通过Package Manager安装Unity扩展：

https://github.com/Cysharp/MagicOnion.git?path=src/MagicOnion.Client.Unity/Assets/Scripts/MagicOnion.Client.Unity#7.0.2

YetAnotherHttpHandler：
- 先安装System.IO.Pipelines（通过NuGetForUnity）
- 然后安装主包：
```
https://github.com/Cysharp/YetAnotherHttpHandler.git?path=src/YetAnotherHttpHandler#1.10.0
```

2. 引用共享库

将共享库项目中的IMyFirstService.cs文件复制到Unity项目的Assets/Scripts目录下。

3. 创建客户端连接脚本

// 文件路径：Assets/Scripts/MagicOnionClient.cs
using MagicOnion;
using MagicOnion.Client;
using MyApp.Shared;
using UnityEngine;
using Grpc.Core;
using Grpc.Net.Client;

public class MagicOnionClient : MonoBehaviour
{
    async void Start()
    {
        // 创建通道（替换为你的服务器地址）
        var channel = GrpcChannel.ForAddress("http://localhost:5210");
        
        // 创建服务客户端
        var client = MagicOnionClient.Create<IMyFirstService>(channel);
        
        try
        {
            // 调用服务方法
            var result = await client.SumAsync(10, 20);
            Debug.Log($"计算结果: {result}");
        }
        catch (RpcException ex)
        {
            Debug.LogError($"RPC错误: {ex.Status.Detail}");
        }
    }
}