ドキュメント

Unity Engine

Unity Engine

シリアル化ベストプラクティス

シリアル化のベストプラクティス。
読み終わるまでの所要時間 7 分最終更新 6日前

以下のコーディング方法と組織の原則を適用して、プロジェクトでエラーを防止し、シリアル化パフォーマンスを最適化します。

スレッドセーフティ

ほとんどの Unity API は、メインスレッドからのみ呼び出すことができます。Unity API は、シリアライズ可能型のコンストラクターとフィールド初期化子からコールしないでください。これらは別の読み込みスレッドで実行されるためです。
開発ビルドでは、読み込みスレッドからメインスレッド API を呼び出そうとすると、Unity はエラーをスローします。リリースビルドでは、コードはエラーなしで実行されますが、アプリケーションにクラッシュやその他の予期しない動作が発生する可能性があります。
ヒント
シリアル化時のエラーのリスクを軽減するために、プロジェクトのステートに影響を与える可能性がある API メソッドや他の Unity オブジェクトを含む API メソッドをコールないようにします。安全にコールできる API には、
Debug.Log
や、数学関数 や
Vector3
などの単純データ型で動作する API があります。

finalizers:

ファイナライザーメソッドからシリアル化を開始しない。ファイナライザーはメインスレッドでは実行されません。ガベージ コレクターは、いつ実行され、状況によってはまったく実行されないかを決定します。
ファイナライザーからデータをシリアライズしようとすると、予期しない動作やクラッシュが発生する可能性があります。詳細については、ファイナライザーに関する Microsoft のドキュメントを参照してください。

データの整理

データを次のように整理して、Unity のシリアル化を最適に使用できます。
  • Unity が最小限のデータをシリアライズすることを目指します。これの目的は、コンピュータのハードドライブのスペースを節約することではなく、以前のバージョンのプロジェクトとの後方互換性を維持することです。シリアライズされたデータの大きなセットを扱う場合、下位互換性は開発の後でより難しくなる可能性があります。
  • 複製データやキャッシュ データを Unity にシリアライズさせないでください。これは、下位互換性にとって重大な問題の原因になります。データが同期しなくなる可能性があるため、エラーが発生するリスクが高くなります。
  • カスタム C# クラスや構造体をリファレンスするフィールドを追加する場合は注意してください。カスタム C# クラスまたは構造体をフィールドでリファレンスする場合、Unity は、リファレンスされるオブジェクトのコンテンツ全体を、リファレンスされるオブジェクトのシリアライズされたデータに埋め込みます。この構造体が複雑になったり、深くネストされたりすると、将来構造体を変更したときにこのデータを移行することが難しくなります。また、オブジェクトのデータは、シリアライズされたデータ内で意図せず複数回簡単に繰り返すことができます。代わりに、MonoBehaviour と ScriptableObject の派生クラス内の構造体を平坦でシンプルなものにしてください。
  • オブジェクト間でデータを共有する方法は、ScriptableObject を使用することです。
    UnityEngine.Object
    から派生したクラス (ScriptableObject から派生したクラスなど) をリファレンスする場合、Unity はリファレンスのみをシリアライズし、オブジェクトグラフ全体をシリアライズしません。そのため、データは ScriptableObject で 1 回だけシリアライズされ、参照する各ポイントではシリアライズされません。同様に、1 つの MonoBehaviour または ScriptableObject 内で同じカスタム C# クラスを複数回リファレンスする場合は、
    [SerializeReference]
    属性を使用できます。詳細については、カスタムクラスのシリアル化 を参照してください。

追加リソース