ドキュメント

Unity Engine

Unity Engine

Unity のシリアル化の使用方法

Unity でのシリアル化の仕組みに関する詳細。
読み終わるまでの所要時間 14 分最終更新 6日前

保存とロード

Unity はシリアル化を使用して、デバイスのメモリとの間でシーン、アセット、およびアセットバンドルをロードおよび保存します。これには、MonoBehaviour コンポーネントや ScriptableObject などの独自のスクリプティング API オブジェクトに保存されたデータも含まれます。
Unity エディターの機能の多くは、コアのシリアル化システムの上に構築されています。シリアル化で特に注意すべき 2 つの点は、Inspector ウィンドウとホットリロードです。

Inspector ウィンドウ

Inspector ウィンドウには、検査されたオブジェクトのシリアライズされたフィールドの値が表示されます。Inspector で値を変更すると、Inspector はシリアライズされたデータを更新し、検査されたオブジェクトを更新するデシリアライズをトリガーします。
Unity のビルトインオブジェクトと、MonoBehaviour から派生したクラスなどのスクリプトオブジェクトの両方に同じことが当てはまります。
Unity は、Inspector ウィンドウで値を表示または変更しても、C# プロパティの取得と設定をコールません。代わりに、Unity はシリアライズされたバッキング フィールドに直接アクセスします。

ホットリロード

スクリプトコードのホットリロードは、アセットデータベースの更新の一環として実行されます。これは、エディターの実行中に、再起動せずにコード変更を直接再読み込みして適用するプロセスを指します。詳細は、『 アセット データベースの更新とホットリロード 』を参照してください。
注
ホットリロードは特殊なシリアル化のケースです。他のシリアル化の場合とは異なり、Unity は private フィールドが
[SerializeField]
属性を持たない場合でも、リロード時にデフォルトでシリアライズします。
Unity がスクリプトをリロードするとき:
  1. Unity はロードされたすべてのスクリプトのすべての変数をシリアライズして保存します。
  2. Unity はそれらをシリアル化前の元の値に復元します。
    • Unity は、変数に
      [SerializeField]
      属性がなくても、シリアル化の要件を満たすすべての変数 (プライベート変数を含む) を復元します。
    • Unity は静的変数を復元しません。そのため、Unity がスクリプトをリロードした後に保持する必要がある状態には静的変数を使用しないでください。リロード プロセスによってスクリプトが破棄されるためです。

シリアル化とリストアの防止

Unity が private 変数を復元しないようにする必要がある場合があります。例えば、スクリプトからリロードした後にリファレンスを null にする場合などです。この場合は、
[NonSerialized]
属性を使用します。
Unity の復元動作は、C# で自動的に実装されたプロパティの値を格納する Private バッキング フィールドにも適用されます。例えば、以下の自動実装プロパティがあるとします。
public string MyProperty { get; set; }
この場合、C# は不可視の private フィールドをクラスに追加して、
MyProperty
の実際の値を格納します。Unity はホットリロード中にこの値をシリアライズおよび復元します。これを防ぐには、 プロパティで
[field: NonSerialized]
を使用します。
以下の例は、
[NonSerialized]
属性と
[field: NonSerialized]
の両方を使用して、通常のフィールドと自動プロパティ バッキング フィールドのシリアル化と復元をそれぞれ防止する方法を示します。
クラス Test{ // p will not be shown in the Inspector or serialized [System.NonSerialized] public int p = 5; // neverSerializeMe will never be serialized, even during an hot reload. [System.NonSerialized] private int neverSerializeMe; // The backing field for NeverSerializedProperty property will never be serialized, // even during a hot reload フィールドSystem.NonSerialized] public int NeverSerializedProperty { get; set; }}

プレハブ

プレハブは、1 つ以上の GameObjects または Component のシリアル化されたデータです。プレハブインスタンスには、プレハブソースへのリファレンスと、プレハブソースに対する変更のリストの両方が含まれます。修正は、特定のプレハブを作成するために Unity がプレハブソースに対して行う必要があります。
プレハブは、Unity エディターでプロジェクトを編集する間のみ存在します。Unity エディターは、プレハブソースとプレハブの変更の 2 つのシリアル化データからゲームオブジェクトオブジェクトをインスタンス化します。

インスタンス化

プレハブやゲームオブジェクトなど、シーンに存在するものに対して
Instantiate
を
コールする場合
  1. Unity がそれをシリアライズします。これはランタイムとエディターの両方で発生します。Unity は、
    UnityEngine.Object
    から派生するすべてをシリアライズできます。
  2. Unity は新しいゲームオブジェクトを作成し、データを新しいゲームオブジェクトにデシリアライズします。
  3. Unity は、同じシリアル化コードを異なるバリアントで実行し、どの
    UnityEngine.Objects
    を参照するかをレポートします。Unityがインスタンス化するデータの一部であるかどうかを判断するために、すべての参照
    UnityEngine.Objects
    をチェックします。リファレンスがテクスチャなどの外部的なものを指している場合、Unity はそのリファレンスをそのまま維持します。リファレンスが子ゲームオブジェクトなどの内部的なものを指している場合、Unity は対応するコピーへのリファレンスを適用します。

使用されていないアセットのアンロード

EditorUtility.UnloadUnusedAssetsImmediate
はネイティブのUnityガベージ コレクターであり、標準のC#ガベージ コレクターとは異なる目的を持ちます。シーンのロード後に実行され、参照されなくなったオブジェクト (テクスチャなど) を確認し、安全にアンロードします。ネイティブのUnityガベージコレクターは、オブジェクトが外部
UnityEngine.Objects
へのすべての参照を報告するバリエーションでシリアライザーを実行します。これは、あるシーンでテクスチャが使用され、ガベージコレクターが次のシーンでアンロードする方法です。

エディターとランタイムシリアル化の違い

シリアル化のほとんどはエディターで発生し、デシリアライズはランタイムに焦点を当てます。Unity は一部の機能をエディターでのみシリアライズしますが、その他の機能はエディターとランタイムの両方でシリアライズできます。

機能

エディター

ランタイム

バイナリ形式のアセット読み取り/書き込みのサポート読み取りのサポート
YAML 形式のアセット読み取り/書き込みのサポートサポートされていません。
シーン、プレハブ、その他のアセットの保存サポート(再生モードでない限り)サポートされていません。
JsonUtility を使用した個々のオブジェクトのシリアル化JsonUtility による読み取り/書き込みサポート。

EditorJsonUtility による追加のオブジェクトタイプのサポート
JsonUtility による読み取り/書き込みサポート
SerializeReferenceサポート対象サポート対象
ISerializationCallbackReceiverサポート対象サポート対象
FormerlySerializedAsサポート対象サポートされていません。
オブジェクトは、Unity_EDITOR スクリプトシンボル内でフィールドを宣言する場合など、エディターのみがシリアライズする追加のフィールドを持つことができます。
public class SerializeRules : MonoBehaviour{#if UNITY_EDITORpublic int m_intEditorOnly;#endif}
前の例では、
m_intEditorOnly
フィールドはエディタでのみシリアライズされ、ビルドには含まれていません。これにより、エディターでのみ必要なデータをビルドから省いてメモリーを節約できます。そのフィールドを使用するコードも、例えば
#if UNITY_EDITOR
ブロック内で条件付きコンパイルする必要があり、ビルド時にクラスをコンパイルできます。
エディターでは、Unity がランタイムにのみシリアライズするフィールドを持つオブジェクトはサポートされません (例えば、Unity_スタンドアロンディレクティブ内でフィールドを宣言する場合など)。

追加リソース