メインコンテンツまでスキップ

Unity と .NET サーバーで始める

に最終更新

このガイドでは MagicOnion を使用したシンプルな Unity アプリケーションによるクライアントと .NET サーバーを作成する手順を解説します。ここでは .NET サーバーに実装された2つの数値を加算する API サービスを Unity クライアントから呼び出す、単純な実装を行います。

このガイドではサーバーとクライアントを作成するために下記の環境を想定しています。

  • Windows または macOS
  • .NET 8 SDK またはそれ以降
  • Unity 2022.3 以降または Unity 6 (6000.0.34f1) 以降
注記

Unity 6 の一部バージョンでは Source Generator に関する不具合があるため 6000.0.34f1 以降を使用してください

セットアップ済みテンプレートを使用する (オプション)​

このガイドではプロジェクトの作成やパッケージのインストールといったセットアップの手順を解説しています。これらのセットアップをスキップしてすぐに始めたい方のために、セットアップ完了済みのテンプレートとなる MagicOnion.Template.Unity リポジトリを公開しています。

テンプレートを使用した開発は GitHub からリポジトリをアーカイブファイルとしてダウンロードするか、GitHub のテンプレートからリポジトリーを作成する方法で開始できます。

テンプレートを使用する手順

このテンプレートの Unity プロジェクトは Unity 6000.0.36f1 を使用した "Universal 3D" テンプレートをベースとしています。

使用方法​

GitHub からアーカイブファイルをダウンロードして展開するか、GitHub のテンプレート機能からリポジトリーを作成してください。下記は MyApp ディレクトリーにテンプレートを展開するコマンド例です。

mkdir MyApp
cd MyApp
curl.exe -L -o - https://github.com/Cysharp/MagicOnion.Template.Unity/archive/refs/heads/main.tar.gz | tar xz -C . --strip-component 1

ソースコードを手元に用意した後、リポジトリールートに含まれる init.cmd または init.sh に任意のプロジェクト名 (例 MyApp など) 指定して実行してください。このスクリプトはリポジトリーのプロジェクトやファイルのリネームなどの準備処理を行います。

init.cmd MyApp

実行後は init.sh および init.cmd、準備処理を行う tools/RepoInitializer を削除できます。準備処理を行った後は Unity Hub から src/MyApp.Unity ディレクトリを Unity プロジェクトとして開いてください。

  • サンプル実装は SampleScene に含まれています
  • Unity Editor 起動後にメニューから Assets -> Open C# Project で Visual Studio または Rider でサーバーも含めたプロジェクトを開けます
  • サーバーの起動は Visual Studio または Rider で MyApp.Server を実行してください

テンプレートはこのクイックスタートガイドの内容に準じた構成となっているため、詳細についてはこのガイドを参照してください。

ライセンス​

テンプレートは CC0 - パブリックドメイン で提供されます。

プロジェクトの準備​

まず初めに .NET サーバーと Unity クライアント、そしてそれらでコードを共有するためのプロジェクトを作成します。.NET サーバーは一般的な .NET アプリケーションと同様にソリューション (.sln) とプロジェクト (.csproj) を作成し、Unity クライアントは Unity Hub から Unity プロジェクトとして作成します。

このガイドで作成するプロジェクトのディレクトリ構成は プロジェクト構成 で解説する構成に従い、最終的に下記の通りとなります。

(Repository Root)
├─ MyApp.sln
└─ src
   ├─ MyApp.Server
   │  ├─ MyApp.Server.csproj
   │  └─ ...
   ├─ MyApp.Shared
   │  ├─ MyApp.Shared.csproj
   │  └─ ...
   └─ MyApp.Unity
      ├─ Assembly-CSharp.csproj
      └─ ...

.NET サーバーと共有ライブラリープロジェクトの作成​

初めに .NET のサーバーと共有ライブラリープロジェクトを作成します。ここでは .NET クライアントとサーバーで始めるクイックスタート と同様に ASP.NET Core gRPC サーバーとクラスライブラリーのプロジェクトおよびソリューションを作成します。

下記のコマンドを実行することでソリューション、サーバープロジェクト、共有ライブラリープロジェクトの作成とMagicOnion 関連のパッケージの参照、プロジェクト間の参照設定を一度に行えます。

Set MO_PROJECT_NAME=MyApp

dotnet new gitignore
dotnet new grpc -o src/%MO_PROJECT_NAME%.Server -n %MO_PROJECT_NAME%.Server
dotnet new classlib -f netstandard2.1 -o src/%MO_PROJECT_NAME%.Shared -n %MO_PROJECT_NAME%.Shared

dotnet new sln -n %MO_PROJECT_NAME%
dotnet sln add src/%MO_PROJECT_NAME%.Server --in-root
dotnet sln add src/%MO_PROJECT_NAME%.Shared --in-root

pushd src\%MO_PROJECT_NAME%.Server
dotnet remove package Grpc.AspNetCore
dotnet add package MagicOnion.Server
dotnet add reference ../%MO_PROJECT_NAME%.Shared
popd

pushd src\%MO_PROJECT_NAME%.Shared
dotnet add package MagicOnion.Abstractions
popd
備考

ここで示した一連のコマンドは下記の操作をまとめたものです。.NET に詳しい場合にはこれらの操作を Visual Studio や Rider などを使用して手動で構成できます。

  • ASP.NET Core gRPC サーバープロジェクトの作成 (MyApp.Server)
  • 共有ライブラリー用クラスライブラリープロジェクトの作成 (MyApp.Shared)
  • ソリューションファイルの作成 (MyApp.sln)
  • MyApp.Server と MyApp.Shared をソリューションに追加
  • MyApp.Server
    • MagicOnion.Server のパッケージの追加
    • MyApp.Shared プロジェクトへの参照追加
  • MyApp.Shared
    • MagicOnion.Abstractions パッケージの追加

Unity プロジェクトの作成​

次に src/MyApp.Unity ディレクトリに Unity プロジェクトを作成します。Unity Hub から Unity プロジェクトを作成します。

この際に使用するテンプレートはお好みのものを選択してください。例えば "Universal 2D" や "Universal 3D" などです。

この時点でディレクトリは下記の通りとなっていることを確認してください。

(Repository Root)
│  MyApp.sln
└─src
    ├─MyApp.Server
    ├─MyApp.Shared
    └─MyApp.Unity

IDE でプロジェクトを開く​

Visual Studio や Rider で MyApp.sln を開くことで、MyApp.Server と MyApp.Shared プロジェクトを開けます。

.NET エコシステムにあまり詳しくない開発者の方向け

.sln ファイルはソリューションと呼ばれ、複数のプロジェクトを束ねる役割を担います。Visual Studio や Rider などの開発環境でソリューションを開くことで、サーバーやクライアント、クラスライブラリーなど複数のプロジェクトを一括で操作、管理できます。

API サービスを定義する​

MagicOnion ではサーバーがクライアントに提供する API サービスはすべて .NET のインターフェースとして定義されます。定義したサービスのインターフェースをクライアントとサーバー間で共有することで、それぞれサーバーの実装やクライアントからの呼び出しに利用します。

サービス定義となるインターフェースをプロジェクト MyApp.Shared に追加します。このプロジェクトはサーバーとクライアントでコードを共有するためのプロジェクトです。

ここでは単純な計算サービス IMyFirstService インターフェースを定義します。インターフェースは x と y の二つの int を受け取り、その合計値を返す SumAsync メソッドを持つものとします。

src/MyApp.Shared/IMyFirstService.cs
using MagicOnion;

namespace MyApp.Shared
{
    public interface IMyFirstService : IService<IMyFirstService>
    {
        UnaryResult<int> SumAsync(int x, int y);
    }
}

一般的な .NET でのインターフェース定義とほとんど同じですが、IService<T> を実装している点と戻り値の型が UnaryResult となっている点に注意してください。

IService<T> はこのインターフェースが Unary サービスであることを表すインターフェースです。Unary サービスとは 1 つのリクエストに対して 1 つのレスポンスを返す API サービスのことです。詳しくは Unary の基礎 を参照してください。

戻り値は UnaryResult または UnaryResult<T> 型である必要があります。これは Task や ValueTask と同様に非同期メソッドとして扱われる MagicOnion 固有の特殊な型で、ここでの UnaryResult<int> は int 型の値をサーバーから受け取ることを表します。また API は常に非同期であるため UnaryResult を使う必要があり、メソッド名には Async サフィックスを付けることを推奨します。

ヒント

このプロジェクトにはテンプレートで作成された Class1.cs があらかじめ含まれているので削除してください。

サーバーを実装する​

サービスのインターフェースを定義した後はサーバープロジェクト MyApp.Server でサービスを実装する必要があります。

サーバーの初期構成​

まず初めにテンプレートで作成した際にデフォルトで追加される gRPC のサンプル実装を削除します。サンプル実装は Protos フォルダーと Services フォルダーに含まれているのでフォルダーごと削除します。

次にサーバーの起動構成を設定します。ASP.NET Core アプリケーションは Program.cs でサーバーの機能に関する構成を行っています。

Program.cs 内で builder.Services.AddMagicOnion() と app.MapMagicOnionService() を呼び出すことで MagicOnion のサーバー機能を有効化します。作成時に記述されている using MyApp.Server.Services と builder.Services.AddGrpc(); と app.MapGrpcService<GreeterService>(); は削除してください。

これらを踏まえた Program.cs は下記のようになります。

src/MyApp.Server/Program.cs
var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddMagicOnion();

var app = builder.Build();

// Configure the HTTP request pipeline.
app.MapMagicOnionService();
app.MapGet("/", () => "Communication with gRPC endpoints must be made through a gRPC client. To learn how to create a client, visit: https://go.microsoft.com/fwlink/?linkid=2086909");

app.Run();
注記

MyApp.Server.csproj に Protobuf アイテムが残ってしまう場合があります。残っている場合にはこの項目は不要ですので削除してください。

  <ItemGroup>
    <Protobuf Include="Protos\greet.proto" GrpcServices="Server" />
  </ItemGroup>

API サービスの実装​

次にクライアントからのリクエストを受けて処理を行う API サービスを実装します。

ここではサービスの定義として IMyFirstService インターフェースを定義しているので、API サービス (Unary サービス) の実装クラスは IMyFirstService インターフェースを実装する必要があり、同時に基底のクラスとして ServiceBase<T> を継承する必要もあります。

この二点を踏まえて MyFirstService クラスを作成します。下記はクラスの実装例です。

src/MyApp.Server/Services/MyFirstService.cs
using MagicOnion;
using MagicOnion.Server;
using MyApp.Shared;

namespace MyApp.Server.Services;

// Implements RPC service in the server project.
// The implementation class must inherit `ServiceBase<IMyFirstService>` and `IMyFirstService`
public class MyFirstService : ServiceBase<IMyFirstService>, IMyFirstService
{
    // `UnaryResult<T>` allows the method to be treated as `async` method.
    public async UnaryResult<int> SumAsync(int x, int y)
    {
        Console.WriteLine($"Received:{x}, {y}");
        return x + y;
    }
}

ここでは Services フォルダーを作成して追加していますがフォルダーの構成に特に制約はありません。

備考

UnaryResult は Task や ValueTask などと同様に非同期メソッド (async) として扱えます。

サーバーの起動を確認する​

サーバーの実装は完了したので、サーバーを起動して動作を確認します。サーバーの起動は Visual Studio や Rider などの IDE からデバッグ実行するか、ターミナルから dotnet run コマンドを実行して行います。

ビルドエラーがなく正常に起動できると下記のようなログが出力されて、サーバーが起動します。この時表示される http://... は後程 Unity クライアントから接続する際に使用するためメモしておくことをお勧めします。

info: Microsoft.Hosting.Lifetime[14]
      Now listening on: https://localhost:7071
info: Microsoft.Hosting.Lifetime[14]
      Now listening on: http://localhost:5210
info: Microsoft.Hosting.Lifetime[0]
      Application started. Press Ctrl+C to shut down.
info: Microsoft.Hosting.Lifetime[0]
      Hosting environment: Development
info: Microsoft.Hosting.Lifetime[0]
      Content root path: D:\repo\src\MyApp.Server

ここまででディレクトリーとファイルは下記のような構成となっているはずです。これでサーバーに関する作業は完了です。

(Repository Root)
├─ MyApp.sln
└─ src
   ├─ MyApp.Server
   │  ├─ MyApp.Server.csproj
   │  ├─ Program.cs
   │  └─ Services
   │     └─ MyFirstService.cs
   └─ MyApp.Shared
      ├─ MyApp.Shared.csproj
      └─ IMyFirstService.cs

Unity クライアントを実装する​

次にサーバーを呼び出す Unity クライアントを実装します。Unity プロジェクト MyApp.Unity を Unity Editor で開きます。

MagicOnion と関連するパッケージのインストール​

初めに Unity プロジェクトから MagicOnion を使用するためにいくつかのパッケージをインストールする必要があります。大きく分けて下記の 3 つのパッケージをインストールします。

  • NuGetForUnity
  • MagicOnion.Client + Unity 向け拡張
  • YetAnotherHttpHandler

NuGetForUnity のインストール​

MagicOnion は NuGet パッケージで提供されているため、Unity で NuGet パッケージをインストールするための拡張である NuGetForUnity をインストールする必要があります。

NuGetForUnity をインストールするには Package Manager の Add package from git URL... に下記の URL を指定します。詳しくは NuGetForUnity の README を参照してください。

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

MagicOnion.Client + Unity 向け拡張のインストール​

MagicOnion のクライアントライブラリーである MagicOnion.Client パッケージは NuGet パッケージで提供されているので、NuGetForUnity を使用してインストールします。

メニューから NuGet → Manage NuGet Packages を選択し、NuGetForUnity のウィンドウで MagicOnion.Client を検索してインストールします。

次に Unity 向けの拡張が含まれる Unity パッケージをインストールします。Unity Package Manager の Add package from git URL... に下記の URL を指定してください。

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

備考

7.0.2 の部分はインストールバージョンとなり、リリースされているバージョンによってはより新しいものを利用できる場合があります。

YetAnotherHttpHandler のインストール​

最後に Unity で gRPC (HTTP/2) 通信を行うための通信ライブラリーである YetAnotherHttpHandler をインストールします。YetAnotherHttpHandler のインストールは動作に必要な NuGet パッケージと YetAnotherHttpHandler 本体の2つのインストール手順が必要となります。

はじめに動作に必要な NuGet パッケージをインストールします。これは NuGetForUnity から System.IO.Pipelines を検索し、インストールします。

次に YetAnotherHttpHandler を Unity Package Manager でインストールします。Package Manager の Add package from git URL... に下記の URL を指定してください。

https://github.com/Cysharp/YetAnotherHttpHandler.git?path=src/YetAnotherHttpHandler#1.10.0
備考

1.10.0 の部分はインストールバージョンとなり、リリースされているバージョンによってはより新しいものを利用できる場合があります。

より詳しいインストール手順については YetAnotherHttpHandler の README を参照してください。

ここまでのインストールを行うと Unity プロジェクトのパッケージ(NuGet および UPM)一覧は下記のようになります。

共有されたサービス定義を Unity プロジェクトから参照できるようにする​

Unity クライアントから API を呼び出すためにサービス定義を参照する必要があります。サービス定義は MyApp.Shared プロジェクトに定義していますがこれは .NET のプロジェクトであり Unity プロジェクトから直接参照することはできません。

ここでは .NET サーバー側と Unity プロジェクトでサービス定義に関するソースコードを共有するための手法を2通り説明します。

手法1: ファイルをコピーして共有する​

一つ目の共有方法は単純にソースコードファイルをコピーして共有する方法です。これは単純に MyApp.Shared の IMyFirstService.cs ファイルを Unity プロジェクトにコピーします。

この手法のメリットはファイルコピーで済むことから試すことがとても簡単であることです。デメリットはファイルのコピーが手動で行われるため、ファイルの変更があった場合に手動でコピーする必要があります。

手法2: ローカルパッケージとして共有する​

2つ目の共有方法は MyApp.Shared プロジェクトを Unity のパッケージとして取り扱えるようにする方法です。これは1つ目の方法と異なり実体が同じファイルを指すことになるのでファイルの変更があった場合に同期をとる必要がありません。MagicOnion の開発ではこの手法を推奨しているため、このガイドではこの手法による共有を採用します。

.NET クラスライブラリープロジェクトを Unity のローカルパッケージとして扱うためにはいくつかの追加の手順が必要です。

初めに MyApp.Shared プロジェクトに package.json を追加します。これは Unity からパッケージとして認識できるようにするためのファイルです。下記の JSON ファイルを MyApp.Shared 配下に package.json として作成します。

src/MyApp.Shared/package.json
{
  "name": "com.cysharp.magiconion.samples.myapp.shared.unity",
  "version": "1.0.0",
  "displayName": "MyApp.Shared.Unity",
  "description": "MyApp.Shared.Unity"
}

また、Unity 上で個別のアセンブリーとなるように Assembly Definition ファイルも追加します。Assembly Definition ファイルは MyApp.Shared に MyApp.Shared.Unity.asmdef という名前で下記の内容で作成します。

src/MyApp.Shared/MyApp.Shared.Unity.asmdef
{
    "name": "MyApp.Shared.Unity"
}
注記

Assembly Definition ファイルのファイル名は Unity から IDE を開く際のプロジェクト名として使用されます。そのためサーバー向けの MyApp.Shared と区別がつくよう .Unity サフィックスを付けることを推奨します。

最後に MyApp.Shared プロジェクトに Directory.Build.props と Directory.Build.targets を追加します。これは .NET プロジェクトで bin, obj フォルダーを出力しないように構成(代わりに .artifacts に出力)し、Unity 向けの .meta などのファイルを IDE 上から非表示にします。

src/MyApp.Shared/Directory.Build.props
<Project>
  <PropertyGroup>
    <!-- https://learn.microsoft.com/en-us/dotnet/core/sdk/artifacts-output -->
    <ArtifactsPath>$(MSBuildThisFileDirectory).artifacts</ArtifactsPath>
  </PropertyGroup>
</Project>
src/MyApp.Shared/Directory.Build.targets
<Project>
  <!-- Hide Unity-specific files from Visual Studio and .NET SDK -->
  <ItemGroup>
    <None Remove="**\*.meta" />
  </ItemGroup>

  <!-- Hide build artifacts from Visual Studio and .NET SDK -->
  <ItemGroup>
    <None Remove=".artifacts\**\**.*" />
    <None Remove="obj\**\*.*;bin\**\*.*" />
    <Compile Remove=".artifacts\**\**.*" />
    <Compile Remove="bin\**\*.*;obj\**\*.*" />
    <EmbeddedResource Remove=".artifacts\**\**.*" />
    <EmbeddedResource Remove="bin\**\*.*;obj\**\*.*" />
  </ItemGroup>
</Project>
警告

これらのファイルを追加した後、プロジェクトをビルドして bin および obj フォルダーが残っている場合は必ず削除してください。ファイルが残り続けていると Unity から認識されて問題を引き起こす可能性があります。

警告

macOS の Finder ではデフォルトで . から始まるファイルを非表示にする設定がされているため、.artifacts フォルダーが表示されない場合があります。Finder で表示するには Command + Shift + . を押すか、defaults コマンドで設定を変更する必要があります。

ここまでの手順で MyApp.Shared プロジェクトは下記のようなファイル構成となります。

(Repository Root)
└─ src
   └─ MyApp.Shared
      ├─ Directory.Build.props
      ├─ Directory.Build.targets
      ├─ IMyFirstService.cs
      ├─ MyApp.Shared.Unity.asmdef
      ├─ MyApp.Shared.csproj
      └─ package.json

共有プロジェクトのローカルパッケージを参照する​

MyApp.Shared をローカルパッケージとして共有できるようにしたので Unity プロジェクトでローカルパッケージの参照を追加する必要があります。

ローカルパッケージの参照を追加するには MyApp.Unity/Packages/manifest.json にパッケージへのパスを追加します。ここでは file:../../MyApp.Shared として相対パスで追加します。

src/MyApp.Unity/Packages/manifest.json
{
  "dependencies": {
    "com.cysharp.magiconion.client.unity": "https://github.com/Cysharp/MagicOnion.git?path=src/MagicOnion.Client.Unity/Assets/Scripts/MagicOnion.Client.Unity#7.0.1",
    "com.cysharp.magiconion.samples.myapp.shared.unity": "file:../../MyApp.Shared",
    "com.cysharp.yetanotherhttphandler": "https://github.com/Cysharp/YetAnotherHttpHandler.git?path=src/YetAnotherHttpHandler#1.10.0",
    "com.github-glitchenzo.nugetforunity": "https://github.com/GlitchEnzo/NuGetForUnity.git?path=/src/NuGetForUnity",
    "com.unity.collab-proxy": "2.6.0",
    "com.unity.feature.2d": "2.0.1",
    ...
}
注記

Unity Editor の Package Manager の Install package from disk... を使用してインストールすると manifest.json に絶対パスで保存されるため注意してください。

MagicOnion クライアントを構成する​

Unity プロジェクトから MagicOnion を使用するためには gRPC の接続を管理するプロバイダーホストと呼ばれる仕組みの初期化が必要です。

MyApp.Unity プロジェクトに下記のソースコードを含む MagicOnionInitializer クラスを追加してください。

src/MyApp.Unity/Assets/Scripts/MagicOnionInitializer.cs
using Cysharp.Net.Http;
using Grpc.Net.Client;
using MagicOnion.Unity;
using UnityEngine;

public class MagicOnionInitializer
{
    [RuntimeInitializeOnLoadMethod(RuntimeInitializeLoadType.BeforeSceneLoad)]
    public static void OnRuntimeInitialize()
    {
        // Initialize gRPC channel provider when the application is loaded.
        GrpcChannelProviderHost.Initialize(new DefaultGrpcChannelProvider(() => new GrpcChannelOptions()
        {
            HttpHandler = new YetAnotherHttpHandler()
            {
                Http2Only = true,
            },
            DisposeHttpClient = true,
        }));
    }
}

Unity との統合について詳しくは Unity との統合 を参照してください。

サーバーに接続して API を呼び出す​

ここまでで MagicOnion を使用するための準備が整ったので、Unity クライアントからサーバーに接続して API を呼び出す処理を実装します。ここでは説明を簡単にするため、MonoBehaviour の Start メソッドでサーバーに接続して API を呼び出して、デバッグログとして出力するといった実装を行います。

初めにサーバーに接続するのに必要な gRPC のチャンネルを作成します。MagicOnion では GrpcChannelx クラスを使用してチャンネルを作成できます。ここでは GrpcChannelx.ForAddress メソッドを使用して指定したアドレスに接続するチャンネルを作成します。指定するアドレスはサーバーを実装するセクションで起動した際に表示された http://... を使用します。

var channel = GrpcChannelx.ForAddress("http://localhost:5210");

作成したチャンネルを使用して MagicOnion のクライアントを作成します。これは MagicOnionClient クラスの Create メソッドで行います。Create メソッドには作成したチャンネルと API サービスのインターフェースを指定します。これによって IMyFirstService インターフェースを実装したクライアントが作成されます。

var client = MagicOnionClient.Create<IMyFirstService>(channel);

最後に作成されたクライアントを使用してメソッドを呼び出します。これは通常のインターフェースのメソッド呼び出しと同様に行えます。メソッドは非同期メソッドなので呼び出し結果の UnaryResult を await で待機する必要があります。

var result = await client.SumAsync(100, 200);

ここまでの手順をまとめ、MonoBehaviour に実装すると下記のようになります。ここでは SampleScene で使用する MonoBehaviour として SampleScene クラスを作成しています。

src/MyApp.Unity/Assets/Scripts/SampleScene.cs
using System;
using MagicOnion;
using MagicOnion.Client;
using MyApp.Shared;
using UnityEngine;

public class SampleScene : MonoBehaviour
{
    // Start is called once before the first execution of Update after the MonoBehaviour is created
    async void Start()
    {
        try
        {
            var channel = GrpcChannelx.ForAddress("http://localhost:5210");
            var client = MagicOnionClient.Create<IMyFirstService>(channel);

            var result = await client.SumAsync(100, 200);
            Debug.Log($"100 + 200 = {result}");
        }
        catch (Exception e)
        {
            Debug.LogException(e);
        }
    }

    // Update is called once per frame
    void Update()
    {

    }
}
ヒント

async void の使用については Start のようなイベントなど一部を除いて使用を避けることをお勧めします。また UniTask を導入している場合には async void の代わりに async UniTaskVoid を使用することをお勧めします。

最後にシーンに GameObject を追加し、その GameObject に SampleScene スクリプトをアタッチします。これで Unity クライアントからサーバーに接続して API を呼び出す準備が整いました。

Unity Editor で Play モードに入ることで Start メソッドが呼び出され、サーバーに接続して API を呼び出す処理が実行されます。Console ログに 100 + 200 = 300 と表示されれば正常にサーバーに接続できて API を呼び出すことができています。

トラブルシューティング​

  • IOException: client error (Connect): tcp connect error: No connection could be made because the target machine actively refused it. (os error 10061)
    • サーバーに接続できない状態です。サーバーが起動しているか、ポート番号が正しい確認してください
  • IOException: client error (Connect): invalid peer certificate: UnknownIssuer
    • https:// に接続しようとしてる場合に発生するエラーです。開発向け証明書を認識できないため発生します。http://... で接続してください(その際ポート番号には注意してください)。

Unity と .NET サーバーのソリューションを統合する​

Unity Editor から C# コードやプロジェクトを Visual Studio や Rider など開発環境で開くと、Unity Editor の生成したソリューションが開かれます (例:MyApp.Unity.sln)。

しかし Unity Editor の生成されたソリューションには .NET サーバーのプロジェクトが含まれていないため、サーバーの開発やデバッグ実行を行うためには別途ソリューション (例:MyApp.sln)を開く必要があります。 SlnMerge エディター拡張を使用すると Unity と .NET サーバーのソリューションを統合し、シームレスな開発が行えるようになります。

SlnMerge のインストール​

SlnMerge をインストールするには Package Manager の Add package from git URL... に下記の URL を指定します。

https://github.com/Cysharp/SlnMerge.git?path=src

SlnMerge の設定​

SlnMerge をインストールした後、ソリューションの統合について SlnMerge の設定を作成する必要があります。 SlnMerge の設定は Unity Editor の生成するソリューションファイル名の .mergesettings を付けた名前のファイルを作成します。

これは例えば MyApp.Unity プロジェクトであれば MyApp.Unity.sln が生成されるので、MyApp.Unity.sln.mergesettings という名前で設定ファイルを作成します。

src/MyApp.Unity/MyApp.Unity.sln.mergesettings
<SlnMergeSettings>
    <MergeTargetSolution>..\..\MyApp.sln</MergeTargetSolution>
</SlnMergeSettings>

ソリューションを開く​

ソリューションを開くには Unity Editor から C# ファイルを選択してダブルクリックで開くか、メニューの Assets → Open C# Project を選択してください。

次のステップ​

このガイドでは MagicOnion を使用して API サービスを構築し、疎通するところまでを説明しました。次のステップとして以下のリンク先のドキュメントを参照してください。