DEV Community: じぇしか / Jessica

Unity上でGoogle.ProtobufがSystem.Memoryを参照できなかったときの対応

じぇしか / Jessica — Thu, 20 Aug 2020 04:13:46 +0000

はじめに

こんばんは、じぇしかです。最近、習作としてUnityをベースにしたVRプラットフォームを作ってみたいなーと思っている今日この頃なのですが、HTTP/2ベースでオーバーヘッドの少ないgRPCをリアルタイム通信のプロトコルとして使用したいと思っています。

ということで既存の記事を参考にUnityにgRPCの開発環境を導入していたのですが、Grpc.Core ver.2.23.0以降、下記のエラーが発生してしまうようです。

「最近の記事はどう解決しているんだ？」と思ったのですが、使用するGrpc.Coreのバージョンを下げていたり、偶然にも回避できていたりで、この事象に対して明確に触れている情報はほとんど見つかりませんでした。いろいろ試した結果、明確ではないのですが事象の発生条件と解決策が見えてきたので、記述しておきます。

事象の発生条件

まず、事象が発生する状態を示します。環境整備の手順は他の記事を参照してもらえればよいのですが、導入作業を進めると基本的には下記のようなフォルダ構造になるかと思います。

ここでシーンを再生すると、冒頭の事象が発生します。メッセージを読むと、ざっくり「Google.ProtobufがSystem.Memoryを読み込むことができなかった」というような旨のようです。とはいうものの、依存パッケージとして指定されていることもあり、System.Memoryも同じくダウンロードして配置はしています。

ここで私はドはまりして全く進められなかったのですが、いろいろと調べていくうちに、公式フォーラムのとある記事にたどり着きました。
Editor assembly loading issues - "unloading broken assembly", "could not load signature"

Google.Protobufではないものの、同様にSystem.Memoryの参照が上手くできていないようです。同時に、全てのライブラリ (*.dll) を同じフォルダに入れたところ、エラーが解消されているとも書かれています。やや言い争い状態になっているもののUnityのバグではなく、一部のライブラリにおいて依存関係がハードコードされているようで、フォルダが異なると参照ができないようです。

ちなみにこの事象、System.Memoryがver.4.5.2以下であれば何故か発生しません。実はGoogle.Protobufが依存しているSystem.Memoryのバージョンもver.4.5.2以降ではあるのですが、Grpc.Coreがver.2.23.0-pre以降のバージョンでSystem.Memory ver.4.5.3以降に依存するようになったため、このver.4.5.3が必要になっています。その結果として、Google.ProtobufがSystem.Memory ver.4.5.3を参照できなくなり、本事象が発生するようになったようです。

解決策と対応

さて、明確ではないものの原因らしきものが見えてきたところで、エラーを解決させましょう。結論から言うと、"Google.Protobuf.dll"と"System.Memory.dll"を同じフォルダに入れてあげることで、エラーは解消しました。

上記のように、例えば "Assets/Plugins/Assemblies/lib/net4.5" というような名前のフォルダを作って纏めると管理しやすいかと思います。今回は全部同じフォルダに入れていますが、全てのライブラリが依存関係を解決できていないわけではないので、部分的な対応でも大丈夫です。

念の為、テスト用のスクリプトを作成し、今回導入したパッケージを参照できるか確認しておきましょう。エディターのオートコンプリートで表示されるようであれば、適切に参照できていると判断できます。ひとつ注意事項ですが、プロジェクトの読込みができていない状態だとオートコンプリートも出てこないので、Unity上部のメニュー[Assets] > [Open C# Project]でスクリプトを開くようにしてください。

おわりに

以上、Unity上でgRPC環境を構築するときに私がドはまりした事象について、説明しました。成り行きでGrpc.Coreのバージョンを下げたり、Google.Protobufだけ差し替えてみたりと、この事象に触れている記事がほとんど見つからずとても苦労しました。同じような地雷を踏んでしまったときに、助け船として参照してもらえればと思います。

gRPCのUnity開発環境 (for .NET Framework 4.5) を整える

じぇしか / Jessica — Wed, 19 Aug 2020 16:19:58 +0000

はじめに

こんにちは、今年に入ってUnityエンジニアとして活動を始めました、じぇしかです。最近VRコンテンツのバックエンドに興味が湧いており、プロトコルを主軸にいろいろと調べていたりします。その中でもHTTP/2をベースとしたgRPCが個人的にアツい技術だと感じ始めており、VRコンテンツの通信においても、将来的にデファクトスタンダードになるんじゃないかと思っています。

まずはUnityクライアントとして動作する環境を構築しよう、ということで調べながら構築してみたのですが、2020/08/20時点、導入方法の記事はいくつかあるものの、最近のバージョンだと下記のようなエラーを引いてしまいます。

いろいろと調べてもこの話題はあまり見つからなかったのですが、この事象の原因と解決方法をどうにか見つけられたので、それも踏まえてgRPC環境の構築手順を記載します。なお、ここでは公式で提供されている開発中の最新版ライブラリを使用します。安定版を使用したい、もしくは.NET Standard 2.0に準拠する必要がある場合は、NuGetを使用した方法で対応できますので、別の記事として改めて紹介します。

手順

環境

今回検証している環境を記載します。
OS: Windows10
Unity: 2019.4.8f1 (.NET Framework 4.*)

Api Compatibility Levelの変更

タイトルの通り、公式で提供している最新版が.NET Framework 4.5をターゲットにしているため、それに合わせましょう。Unityにて[Edit] > [Project Settings...]タブを順に選び、開きます。その中の[Player]セクション、さらに[Other Settings]の中に[Api Compatibility Level] の項目があるので、それを".NET 4.x"に設定してください。これで、ターゲットのフレームワークが.NET Framework 4.xとなります。

gRPC関連ライブラリのダウンロードとインポート

次に、gRPCが公式で配布しているパッケージを取得します。下記リンク先から最新のビルド (一番上にあるBuild ID) を選択します。
https://packages.grpc.io/

ページ移動したら、C#カテゴリの一番上、"grpc_unity_package...*-dev.zip"というパッケージがあるので、それをダウンロード、展開しましょう。今回の場合は、"grpc_unity_package.2.32.0-dev.zip"でした。

ダウンロードしたパッケージを展開すると、直下にPluginsフォルダがあります。これをUnityプロジェクトの"Assets"フォルダ配下に配置してください。Pluginsフォルダの中には、Grpcに必要なパッケージ群が収められています。

gRPC関連ライブラリの引っ越し

さて、ここまでは調べると出てくるような既存の記事と同様の手順です。しかし、ここであまり触れられていないエラーが発生します。依存ライブラリとしてSystem.Memoryもインストールされているのですが、シーンを再生すると冒頭に出てきたSystem.Memoryを参照できないというエラーが出力されます。

詳細はわからないのですが、どうやら下記の不具合 (仕様？)に引っかかっているようで、DLLがお互いに上手く参照ができていないためと思われます。そこで、これらのライブラリをすべて同じフォルダに移動させる対応を行います。
Editor assembly loading issues - "unloading broken assembly", "could not load signature"

それでは、ライブラリを移動させるフォルダを作成します。特に制限はないのですが、今回は"Assets/Plugins/Assemblies/Grpc/lib/net4.5"としました。このフォルダ直下に、各ライブラリの"lib/net4.5"フォルダ直下にあるファイルを配置していきます。移動させたらフォルダを削除して構いませんが、Grpc.Coreについてはruntimesフォルダを含んでいるので、そのまま残しておきます。移動が完了すると、以下のような状態になるかと思います。

この時点で参照が解決され、再度シーンを実行すると冒頭のエラーが出力されなくなります。念の為にテスト用のスクリプトを作成し、今回導入したパッケージを参照できるか確認しておきましょう。エディターのオートコンプリートなどで確認するとよいかと思います。

おわりに

以上の手順で、Unity上にgRPCの開発環境をざっくり構築できました。手順自体は単純なのですが、冒頭のエラーは言及されている情報が見つかりにくく、ドはまりポイントだったりします。この記事が、少しでも手助けになればと思います。

また今回ダウンロードしたライブラリ群ですが、安定版はNuGet Galleryにて配布されています。というか、実際に使用する場合はそちらからライブラリを集めて導入すべきなのではないか、と思っていたりします。とはいえ、一方でUnityにDLLを導入する手順も意外と見つかりません。後日に別の記事として、NuGetを使用した導入方法もご紹介いたします。

参考

【Unity】NuGetからパッケージをダウンロード～Unityに導入までの流れをまとめてみた - はなちるのマイノート
 gRPCとProtocol Buffersによるアプリケーション間通信 / Unity｜npaka｜note
UnityでgRPCを動かす