Unity3Dで外部リソースを操作する

はじめに

読者の皆さん、こんにちは。今日はUnity 3d環境で外部リソースを操作することに焦点を当てます。



伝統により、そもそもそれが何であり、なぜそれが必要なのかを決定します。 したがって、これらの外部リソースとは正確には何ですか。 ゲーム開発の一部として、そのようなリソースは、アプリケーションが機能するために必要なものすべてである可能性があり、プロジェクトの最終ビルドには保存しないでください。 外部リソースは、ユーザーのコンピューターのハードディスクと外部Webサーバーの両方に配置できます。 一般的に、そのようなリソースは、すでに実行中のアプリケーションにロードするファイルまたはデータセットです。 Unity 3dのフレームワークで言えば、次のことが可能です。

• テキストファイル
• テクスチャファイル
• 音声ファイル
• バイト配列
• AssetBundle（Unity 3dプロジェクトのアセットを含むアーカイブ）

以下では、Unity 3dに存在するこれらのリソースを操作するための組み込みメカニズムをさらに詳しく調べ、Webサーバーと対話してアプリケーションにリソースをロードするためのシンプルなマネージャーを作成します。



注 ： この記事の残りの部分では、C＃7+を使用するコードを使用し、バージョン2018.3+のUnity3dで使用されるRoslynコンパイラー向けに設計されています。

Unity 3Dの機能

Unity 2017より前は、エンジンに含まれていたサーバーデータと外部リソースを操作するために、1つのメカニズム（自己記述型を除く）が使用されていました。これはWWWクラスです。 このクラスでは、さまざまなhttpコマンド（get、post、putなど）を同期または非同期形式（コルーチン経由）で使用できます。 このクラスでの作業は非常にシンプルで簡単でした。

IEnumerator LoadFromServer(string url) { var www = new WWW(url); yield return www; Debug.Log(www.text); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

同様に、テキストデータだけでなく、他のデータも取得できます。

• バイト配列-www.bytes
• テクスチャ-www.texture
• オーディオ-www.GetAudioClip （）
• 資産-www.assetBundle

ただし、バージョン2017以降、UnityにはUnityWebRequestクラスによって導入された新しいサーバーシステムがあり、これはNetworking名前空間にあります。 Unity 2018まではWWWとともに存在していましたが、 WWWエンジンの最新バージョンでは推奨されなくなり、将来的には完全に削除されます。 したがって、さらにUnityWebRequest （以降UWR）のみに焦点を当てます。



UWR全体を操作することは、中核はWWWに似ていますが、違いがあります。これについては後で説明します。 以下は、テキストをロードする同様の例です。

 IEnumerator LoadFromServer(string url) { var request = new UnityWebRequest(url); yield return request.SendWebRequest(); Debug.Log(request.downloadHandler.text); request.Dispose(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

新しいUWRシステムで導入された主な変更（内部での動作原理の変更に加えて）は、サーバー自体からデータをアップロードおよびダウンロードするハンドラーを割り当てる機能です 。詳細については、こちらを参照してください。 デフォルトでは、これらはクラスUploadHandlerおよびDownloadHandlerです。 Unity自体は、オーディオ、テクスチャ、アセットなどのさまざまなデータを操作するために、これらのクラスの拡張セットを提供します。 それらについてさらに詳しく検討してみましょう。

リソースを操作する

テキスト

テキストの操作は、最も簡単なオプションの1つです。 それをダウンロードする方法はすでに上で説明されています。 直接http Getリクエストを作成することで少し書き直します。

 IEnumerator LoadTextFromServer(string url, Action<string> response) { var request = UnityWebRequest.Get(url); yield return request.SendWebRequest(); if (!request.isHttpError && !request.isNetworkError) { response(uwr.downloadHandler.text); } else { Debug.LogErrorFormat("error request [{0}, {1}]", url, request.error); response(null); } request.Dispose(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コードからわかるように、デフォルトのDownloadHandlerがここで使用されます。 textプロパティは、バイト配列をUTF8エンコードされたテキストに変換するゲッターです。 サーバーからテキストをロードする主な用途は、jsonファイル（テキスト形式のデータのシリアル化された表現）を受信することです。 Unity JsonUtilityクラスを使用してこのデータを取得できます。

 var data = JsonUtility.FromJson<T>(value); // T  ,    .
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

音声

オーディオを操作するには、 UnityWebRequestMultimedia.GetAudioClipリクエストを作成する特別な方法を使用する必要があり、Unityでの作業に必要な形式でデータ表現を取得するには、 DownloadHandlerAudioClipを使用する必要があります。 さらに、リクエストを作成する場合、 AudioType列挙で表されるオーディオデータのタイプを指定する必要があります。これにより、形式（wav、aiff、oggvorbisなど）が設定されます。

 IEnumerator LoadAudioFromServer(string url, AudioType audioType, Action<AudioClip> response) { var request = UnityWebRequestMultimedia.GetAudioClip(url, audioType); yield return request.SendWebRequest(); if (!request.isHttpError && !request.isNetworkError) { response(DownloadHandlerAudioClip.GetContent(request)); } else { Debug.LogErrorFormat("error request [{0}, {1}]", url, request.error); response(null); } request.Dispose(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

テクスチャー

テクスチャのダウンロードは、オーディオファイルの場合と同様です。 リクエストはUnityWebRequestTexture.GetTextureを使用して作成されます。 Unityに必要な形式でデータを取得するには、 DownloadHandlerTextureが使用されます。

 IEnumerator LoadTextureFromServer(string url, Action<Texture2D> response) { var request = UnityWebRequestTexture.GetTexture(url); yield return request.SendWebRequest(); if (!request.isHttpError && !request.isNetworkError) { response(DownloadHandlerTexture.GetContent(request)); } else { Debug.LogErrorFormat("error request [{0}, {1}]", url, request.error); response(null); } request.Dispose(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

アセットバンドル

前述のように、実際には、バンドルは、すでに実行中のゲームで使用できるUnityリソースを含むアーカイブです。 これらのリソースは、シーンを含む任意のプロジェクトアセットにすることができます。 例外はC＃スクリプトであり、渡すことはできません。 AssetBundleをロードするには、 UnityWebRequestAssetBundle.GetAssetBundleを使用して作成されたクエリが使用されます。 Unityに必要な形式でデータを取得するには、 DownloadHandlerAssetBundleが使用されます。

 IEnumerator LoadBundleFromServer(string url, Action<AssetBundle> response) { var request = UnityWebRequestAssetBundle.GetAssetBundle(url); yield return request.SendWebRequest(); if (!request.isHttpError && !request.isNetworkError) { response(DownloadHandlerAssetBundle.GetContent(request)); } else { Debug.LogErrorFormat("error request [{0}, {1}]", url, request.error); response(null); } request.Dispose(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

Webサーバーと外部データを扱う際の主な問題と解決策

さまざまなリソースのロードに関するアプリケーションとサーバー間の対話の簡単な方法は上記で説明されています。 ただし、実際には、物事ははるかに複雑です。 開発者に付随する主な問題を検討し、それらを解決する方法について説明します。

十分な空き領域がありません

サーバーからデータをダウンロードする際の最初の問題の1つは、デバイスの空き容量が不足している可能性があることです。 ユーザーがゲーム用に古いデバイス（特にAndroid）を使用し、ダウンロードしたファイル自体のサイズが非常に大きくなることがよくあります（hello PC）。 いずれにせよ、この状況を正しく処理する必要があり、プレーヤーに十分なスペースがないこととその量を事前に通知する必要があります。 どうやってやるの？ 最初に知っておくべきことは、ダウンロードしたファイルのサイズです。これは、 UnityWebRequest.Head（）リクエストによって行われます。 以下は、サイズを取得するコードです。

 IEnumerator GetConntentLength(string url, Action<int> response) { var request = UnityWebRequest.Head(url); yield return request.SendWebRequest(); if (!request.isHttpError && !request.isNetworkError) { var contentLength = request.GetResponseHeader("Content-Length"); if (int.TryParse(contentLength, out int returnValue)) { response(returnValue); } else { response(-1); } } else { Debug.LogErrorFormat("error request [{0}, {1}]", url, request.error); response(-1); } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで1つ注意することが重要です。リクエストが正しく機能するには、サーバーがコンテンツのサイズを返す必要があります。そうでない場合（実際には進行状況を表示するため）、間違った値が返されます。



ダウンロードしたデータのサイズを取得したら、空きディスク容量のサイズと比較できます。 後者を取得するには、Asset Storeから無料のプラグインを使用します 。



注 ： Unity3dでCacheクラスを使用できます。キャッシュ内の空きスペースと占有スペースを表示できます。 ただし、これらのデータは相対的であるという点を考慮する価値があります。 キャッシュ自体のサイズに基づいて計算されます。デフォルトでは4GBです。 ユーザーがキャッシュのサイズよりも多くの空きスペースを持っている場合、問題はありませんが、そうでない場合、値は実際の状況に対して不適切な値をとることがあります。

インターネットアクセスチェック

非常に多くの場合、サーバーから何かをダウンロードする前に、インターネットにアクセスできないという状況に対処する必要があります。 これを行うには、いくつかの方法があります：アドレスへのpingから、google.ruへのGETリクエストまで。 ただし、私の意見では、最も正確で高速かつ安定した結果は、ご使用のサーバーから小さなファイルをダウンロードすることです（ファイルがダウンロードされる場所と同じ）。 これを行う方法は、上記のテキストの操作に関するセクションで説明されています。

プレーヤーがモバイルトラフィックで数百メガバイトをダウンロードする可能性は低いため、インターネットアクセスの事実を確認することに加えて、そのタイプ（モバイルまたはWiFi）も決定する必要があります。 これは、 Application.internetReachabilityプロパティを介して実行できます。

キャッシング

次の、そして最も重要な問題の1つは、ダウンロードしたファイルのキャッシュです。 このキャッシュは何のためのものですか？

1. トラフィックを保存します（ダウンロード済みのデータをダウンロードしないでください）
2. インターネットがない場合の作業の保証（キャッシュからデータを表示できます）。

何をキャッシュする必要がありますか？ この質問に対する答えはすべてです。ダウンロードするすべてのファイルはキャッシュする必要があります。 これを行う方法、以下を検討し、簡単なテキストファイルから始めます。

残念ながら、Unityには、テキストやテクスチャ、オーディオファイルをキャッシュするための組み込みメカニズムがありません。 したがって、これらのリソースについては、プロジェクトのニーズに応じて、システムを記述するか、記述しないことが必要です。 最も単純なバージョンでは、ファイルをキャッシュに書き込むだけで、インターネットがない場合はファイルをキャッシュから取得します。 もう少し複雑なバージョン（プロジェクトで使用します）では、サーバーにリクエストを送信し、サーバーに保存されているファイルのバージョンを示すjsonを返します。 キャッシュへのファイルの書き込みと読み取りは、 FileクラスのC＃クラス、またはチームが便利で受け入れているその他のメソッドを使用して実行できます。

 private void CacheText(string fileName, string data) { var cacheFilePath = Path.Combine("CachePath", "{0}.text".Fmt(fileName)); File.WriteAllText(cacheFilePath, data); } private void CacheTexture(string fileName, byte[] data) { var cacheFilePath = Path.Combine("CachePath", "{0}.texture".Fmt(fileName)); File.WriteAllBytes(cacheFilePath, data); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

同様に、キャッシュからデータを取得します。

 private string GetTextFromCache(string fileName) { var cacheFilePath = Path.Combine(Utils.Path.Cache, "{0}.text".Fmt(fileName)); if (File.Exists(cacheFilePath)) { return File.ReadAllText(cacheFilePath); } return null; } private Texture2D GetTextureFromCache(string fileName) { var cacheFilePath = Path.Combine(Utils.Path.Cache, "{0}.texture".Fmt(fileName)); Texture2D texture = null; if (File.Exists(cacheFilePath)) { var data = File.ReadAllBytes(cacheFilePath); texture = new Texture2D(1, 1); texture.LoadImage(data, true); } return texture; }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

注 ： 同じUWRがフォームファイルのURLを持つ理由：//テクスチャの読み込みには使用されません。 現時点では、これには問題があり、ファイルは単にロードされないため、回避策を見つける必要がありました。



注 ： プロジェクトではAudioClipの直接読み込みは使用せず、そのようなデータはすべてAssetBundleに保存します。 ただし、必要に応じて、これはAudioClipクラスのGetDataおよびSetDataの関数を使用して簡単に実行できます。



AssetBundleの Unityのシンプルなリソースには、 Unityに組み込みのキャッシュメカニズムがあります。 もっと詳しく考えてみましょう。



基本的に、このメカニズムは2つのアプローチを使用できます。

1. CRCとバージョン番号を使用する
2. ハッシュ値の使用

原則として、あなたはそれらのいずれかを使用できますが、私は独自のバージョンシステムを持ち、 AssetBundleバージョンだけでなくアプリケーションのバージョンも考慮するため、多くの場合バンドルはバージョンと互換性がない可能性があるため、Hashが最も受け入れられると決めました店頭で発表。



それで、キャッシングはどのように行われますか：

1. マニフェストサーバーにバンドルファイルを要求します（このファイルは作成時に自動的に作成され、含まれるアセットの説明、ハッシュ、crc、サイズなどが含まれます）。 ファイルには、バンドルと同じ名前に拡張子.manifestが付いています。
2. マニフェストからhash128値を取得する
3. サーバーへのリクエストを作成してAssetBundleを取得します。URLに加えて、受信したhash128値を指定します

上記の例では、Unityはサーバーへの要求に応じて、指定されたhash128値を持つファイルがキャッシュにあるかどうかを最初に確認し、存在する場合は返されます。存在しない場合は、更新されたファイルがダウンロードされます。 Unityですべてのキャッシュファイルを管理するために、 キャッシュクラスがあります。このクラスを使用して、キャッシュにファイルがあるかどうかを確認し、すべてのキャッシュバージョンを取得し、不要なものを削除するか、完全にクリアします。



注 ： なぜハッシュ値を取得するこのような奇妙な方法ですか？ これは、ドキュメントで説明されている方法でhash128を取得するには、バンドル全体をロードし、そこからAssetBundleManifestアセットを取得し、そこから既にハッシュ値を取得する必要があるためです。 このアプローチの欠点は、AssetBundle全体が揺れ動くということですが、そうではないことが必要です。 したがって、まずサーバーからマニフェストファイルのみをダウンロードし、そこからhash128を取得します。その後、バンドルファイルをダウンロードする必要がある場合にのみ、行の解釈を通じてhash128値を取得する必要があります。

エディターモードでリソースを操作する

最後の問題、つまりデバッグと開発の利便性の問題は、エディターモードでダウンロード可能なリソースを操作することです。通常のファイルに問題がない場合、バンドルでは事態はそれほど単純ではありません。 もちろん、毎回ビルドし、サーバーにアップロードしてUnityエディターでアプリケーションを起動し、すべてがどのように機能するかを見ることができますが、この説明でさえ「松葉杖」のように聞こえます。 これで何かをする必要があり、そのためにAssetDatabaseクラスが役立ちます。



バンドルとの作業を統一するために、特別なラッパーを作成しました。

 public class AssetBundleWrapper { private readonly AssetBundle _assetBundle; public AssetBundleWrapper(AssetBundle assetBundle) { _assetBundle = assetBundle; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ここで、エディターを使用するかビルドを使用するかに応じて、アセットを操作する2つのモードを追加する必要があります。 ビルドでは、 AssetBundleクラスの関数のラッパーを使用し、エディターでは上記のAssetDatabaseクラスを使用します。





注 ：コードではTaskManagerクラスを使用します。以下で簡単に説明しますが、これはCoroutineを操作するためのラッパーです。



上記に加えて、開発プロセス中にダウンロードしたものと現在キャッシュにあるものを確認することも役立ちます。 この目的のために、キャッシュに使用される独自のフォルダーを設定する機能を利用できます（ダウンロードしたテキストと他のファイルを同じフォルダーに書き込むこともできます）。

 #if UNITY_EDITOR var path = Path.Combine(Directory.GetParent(Application.dataPath).FullName, "_EditorCache"); #else var path = Path.Combine(Application.persistentDataPath, "_AppCache"); #endif Caching.currentCacheForWriting = Caching.AddCache(path);
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ネットワークリクエストマネージャーを作成するか、Webサーバーで作業します

上記では、Unityで外部リソースを操作する主な側面を検討しました。次に、上記のすべてを一般化および統合するAPIの実装について詳しく説明します。 最初に、ネットワーククエリマネージャーについて説明します。



注 ： 以降、 TaskManagerクラスの形式でCoroutineのラッパーを使用します。 このラッパーについては別の記事で書きました 。



対応するクラスを取得しましょう：

 public class Network { public enum NetworkTypeEnum { None, Mobile, WiFi } public static NetworkTypeEnum NetworkType; private readonly TaskManager _taskManager = new TaskManager(); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

アプリケーションがインターネット接続のタイプに関する情報を受信するには、 NetworkType静的フィールドが必要です。 原則として、この値はどこにでも保存できるため、 Networkクラスの場所であると判断しました。





コードからわかるように、リクエストの完了を処理する方法は、前のセクションのコードと比較して変更されています。 これは、データのロードの進行状況を表示するためのものです。 また、送信されたすべてのリクエストはリストに保存されるため、必要に応じてキャンセルできます。





同様に、テクスチャ、オーディオ、テキスト、バイト配列用の関数が作成されます。



次に、サーバーがPostコマンドを介してデータを送信することを確認する必要があります。 多くの場合、サーバーに何かを渡す必要があり、その内容に応じて答えを取得します。 適切な機能を追加します。









同様に、テクスチャ、オーディオファイル、テキストなどのメソッドが追加されます。





これで、ネットワーク要求を処理するためのマネージャーが完了しました。 必要に応じて、サーバーの操作を必要とするゲームの各サブシステムは、クラスの独自のインスタンスを作成できます。

外部リソースの読み込みマネージャーを作成します

上記のクラスに加えて、外部データを完全に操作するには、データをダウンロードするだけでなく、ダウンロードの開始、完了、進行、空き領域の不足、およびキャッシュの問題も処理することをアプリケーションに通知する別のマネージャーが必要です。





ご覧のとおり、デザイナーがエディターにいるかどうかに応じて、デザイナーがキャッシュ用のフォルダーを設定します。また、前に説明したNetworkクラスのインスタンスにプライベートフィールドを設定します。



ここで、キャッシュを操作するための補助関数を追加し、ダウンロードしたファイルのサイズを決定し、その空き容量を確認します。さらに以下では、AssetBundleを使用した例のコードを示します。残りのリソースについては、すべてが類推によって行われます。







この関数で何が起こるか：

• プリコンパイルディレクティブDONT_USE_SERVER_IN_EDITORは、サーバーからのバンドルの実際のロードを無効にするために使用されます。
• 最初のステップは、バンドルのマニフェストファイルを取得するためにサーバーにリクエストを行うことです
• - , , - ( _externalResourcesStorage ) , , ( , ), , null
• , Caching , , ( )
• , , , , - ( ). , ( )

注：ハッシュ値が個別に保存される理由を理解することが重要です。これは、インターネットがない場合、接続が不安定な場合、または何らかのネットワークエラーが発生し、サーバーからバンドルをダウンロードできなかった場合に必要です。この場合、キャッシュが存在する場合、キャッシュからバンドルをダウンロードすることが保証されます。



上記のメソッドと同様に、マネージャーでは、データを操作するための他の関数GetJson、GetTexture、GetText、GetAudioなどを取得する必要があります。





ここでは、ネットワーク要求マネージャーで使用されるTaskManagerの特性を理解する価値があります。これはデフォルトで機能し、すべてのタスクを順番に実行します。したがって、ファイルのダウンロードはそれに応じて発生します。



注：Coroutineが気に入らない人のために、すべてを簡単にasync / awaitに変換できますが、この場合、この記事では、初心者にはより理解しやすいオプションを使用することにしました（私には思えます）。

おわりに

この記事では、ゲームアプリケーションの外部リソースをできるだけコンパクトに操作することを説明しようとしました。このアプローチとコードは、私が参加してリリースされ、開発されているプロジェクトで使用されています。サーバーとの絶え間ない通信（MMOおよびその他の複雑なf2pゲーム）がない単純なゲームでは非常にシンプルで適用可能ですが、追加の資料、言語をダウンロードし、購入やその他のデータのサーバー側検証を実装する必要がある場合、作業が大幅に促進されます一度だけ、またはアプリケーションであまり頻繁に使用されません。



記事で提供されているリンク：

assetstore.unity.com/packages/tools/simple-disk-utils-59382

habr.com/post/352296

habr.com/post/282524