ほとんどの統一開発者は、たとえばコンポーネントの取得など、パフォーマンスに負荷がかかる操作を乱用しないでください。 これを行うには、 キャッシングを使用します。 しかし、このような単純な最適化には、いくつかの異なるアプローチがあります。

この記事では、さまざまなキャッシュオプション、それらの非自明な機能およびパフォーマンスについて説明します。









主に「内部」キャッシング、つまり、内部のニーズに応じて現在のオブジェクト上にあるコンポーネントを取得することについて説明することに注意してください。 そもそも、インスペクターでの依存関係の直接割り当てを拒否します。これは使用するには不便であり、スクリプトの設定を詰まらせ、エディターがクラッシュしたときにリンクが壊れる可能性があります。 したがって、GetComponent（）を使用します。







初期キャッシュは、.transform、.renderなど、GameObjectが提供するデフォルトプロパティにも関連しています。 それらにアクセスするには、明示的なキャッシュがさらに高速になります（Unity 5のほとんどは非推奨としてマークされているため、使用を拒否することをお勧めします）。



最も明白なキャッシング方法（コンポーネントの直接受信）は、一般的な場合に最初は最も生産的であり、他のオプションはそれを使用するだけで、コンポーネントへのアクセスを容易にするため、毎回同じタイプのコードを記述したり、要求に応じてコンポーネントを受信したりする必要がありません。







説明したすべてのキャッシュオプションのパフォーマンスがピボットチャートに表示されます。

基本

GetComponentメソッドには、テンプレートGetComponent（）と、追加のキャストが必要な通常のGetComponent（type）（compとしてT）の2つの用途があります。 パフォーマンス概要チャートでは、これらのオプションの両方が考慮されますが、テンプレートメソッドの方が使いやすいことを考慮する価値があります。 同様のオプションを持つGetComponentsコンポーネントのリストを取得するオプションもあり、それらもチェックされます。 図では、各プラットフォームでのGetComponentの実行時間は、機器の機能を平準化するために100％とみなされています。また、より便利なインタラクティブバージョンもあります。

プロパティを使用する

キャッシュにプロパティを使用できます。 このメソッドの利点は、プロパティを有効にしたときにのみキャッシュが発生し、このプロパティが使用されたときにキャッシュが発生しないことです。 欠点は、この場合、同じ種類のコードをより多く記述していることです。



最も簡単なオプション：

 Transform _transform = null; public Transform CachedTransform { get { if( !_transform ) { _transform = GetComponent<Transform>(); } return _transform; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このオプションは、コンポーネントがないことを確認するため、パフォーマンスの問題があります。







この問題には2つの解決策があります。

キャッシングが行われたかどうかを示す追加のフラグを使用します。

 Transform _transform = null; bool _transformCached = false; public Transform CachedTransform { get { if( !_transformCached ) { _transformCached = true; _transform = GetComponent<Transform>(); } return _transform; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

コンポーネントをオブジェクトに明示的にキャストします。

 Transform _transform = null; public Transform CachedTransform { get { if( (object)_transform == null ) { _transform = GetComponent<Transform>(); } return _transform; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ただし、このオプションは、オブジェクトのコンポーネントが削除されない場合にのみ安全であることに注意してください（通常はまれに発生します）。

継承

タスクを簡素化するために、最も使用されるプロパティをキャッシュするコンポーネントからクラスを継承できますが、このオプションは普遍的ではなく（必要なすべてのプロパティの作成と変更が必要です）、必要に応じて他のコンポーネントからの継承を許可しません（C＃では多重継承はありません）。



最初の問題はテンプレートを使用して解決できます。

 public class InnerCache : MonoBehaviour { Dictionary<Type, Component> cache = new Dictionary<Type, Component>(); public T Get<T>() where T : Component { var type = typeof(T); Component item = null; if (!cache.TryGetValue(type, out item)) { item = GetComponent<T>(); cache.Add(type, item); } return item as T; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

2番目の問題は、キャッシング用の個別のコンポーネントを作成し、スクリプトへのリンクを使用することで回避できます。

静的キャッシュ

拡張機能などのC＃機能を使用するオプションがあります。 メソッドを変更および継承することなく、既存のクラスにメソッドを追加できます。 これは次のように行われます。

 public static class ExternalCache { static Dictionary<GameObject, TestComponent> test = new Dictionary<GameObject, TestComponent>(); public static TestComponent GetCachedTestComponent(this GameObject owner) { TestComponent item = null; if (!test.TryGetValue(owner, out item)) { item = owner.GetComponent<TestComponent>(); test.Add(owner, item); } return item; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その後、任意のスクリプトで、このコンポーネントを取得できます。

 gameObject.GetCachedTestComponent();
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

ただし、このオプションでは、必要なすべてのコンポーネントを事前に設定する必要があります。 テンプレートを使用してこれを解決できます。

 public static class ExternalCache { static Dictionary<GameObject, Dictionary<Type, Component>> cache = new Dictionary<GameObject, Dictionary<Type, Component>>(); public static T GetCachedComponent<T>(this GameObject owner) where T : Component { var type = typeof(T); Dictionary<Type, Component> container = null; if (!cache.TryGetValue(owner, out container)) { container = new Dictionary<Type, Component>(); cache.Add(owner, container); } Component item = null; if (!container.TryGetValue(type, out item)) { item = owner.GetComponent<T>(); container.Add(type, item); } return item as T; } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

これらのオプションの欠点は、デッドリンクを追跡することです。 キャッシュをクリアしない場合（たとえば、シーンをロードするとき）、そのボリュームは成長し、既に破壊されたオブジェクトへのリンクでメモリを詰まらせます。

性能比較

インタラクティブオプション



ご覧のとおり、特効薬はなく、最も最適なキャッシュオプションは、初期化中にコンポーネントを直接取得することです。 追加のコードを記述する必要があるプロパティを除き、回避策は最適ではありません。

属性を使用する

属性を使用すると、クラスメンバなどのコード要素のメタ情報を追加できます。 属性自体は満たされていないため、リフレクションを使用して使用する必要がありますが、これはかなり高価な操作です。



キャッシング用に独自の属性を宣言できます。

 [AttributeUsage(AttributeTargets.Field)] public class CachedAttribute : Attribute { }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

そして、それをクラスのフィールドに使用します：

 [Cached] public TestComponent Test;
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

しかし、これまでのところ、これは何も提供しません。この情報は決して使用されません。

継承

この属性を持つクラスのメンバーを受け取り、初期化中に明示的に受け取る独自のクラスを作成できます。

 public class AttributeCacheInherit : MonoBehaviour { protected virtual void Awake () { CacheAll(); } void CacheAll() { var type = GetType(); CacheFields(GetFieldsToCache(type)); } List<FieldInfo> GetFieldsToCache(Type type) { var fields = new List<FieldInfo>(); foreach (var field in type.GetFields()) { foreach (var a in field.GetCustomAttributes(false)) { if (a is CachedAttribute) { fields.Add(field); } } } return fields; } void CacheFields(List<FieldInfo> fields) { var iter = fields.GetEnumerator(); while (iter.MoveNext()) { var type = iter.Current.FieldType; iter.Current.SetValue(this, GetComponent(type)); } } }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

このコンポーネントの継承者を作成する場合、そのメンバーを[Cached]属性でマークできるため、明示的なキャッシュを心配する必要はありません。

ただし、パフォーマンスの問題と継承の必要性により、このメソッドの利便性が向上します。

静的型キャッシュ

クラスメンバーのリストは、コードの実行時に変更されないため、高価なリフレクションにほとんど頼ることなく、一度取得してこのタイプ用に保存し、将来使用することができます。 これを行うには、型分析の結果を保存する静的クラスが必要です。







そして今、スクリプトでキャッシュするために、それへの呼び出しを使用します：

 void Awake() { CacheHelper.CacheAll(this); }
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

その後、[Cached]でマークされたすべてのクラスメンバーがGetComponentを使用して取得されます。

属性キャッシュのパフォーマンス

1つまたは5つのキャッシュコンポーネントがあるオプションのパフォーマンスを比較します。





インタラクティブオプション





インタラクティブオプション



ご覧のとおり、この方法はコンポーネントの直接生産に比べてパフォーマンスが劣ります（コンポーネントの数が増えるとギャップがわずかに減少します）が、多くの機能があります。

• クラスの最初のインスタンスを初期化するときにのみ、重大なパフォーマンスの低下が発生します
• このクラスの後続のインスタンスの初期化ははるかに高速ですが、直接キャッシュほど高速ではありません
• 初期化後のコンポーネントの取得のパフォーマンスは、クラスのメンバーの取得と同じであり、GetComponentおよびプロパティを持つさまざまなオプションのメンバーの取得よりも高いです。
• しかし同時に、将来使用されるかどうかに関係なく、クラスのすべてのメンバーが初期化されます

戻るか、エディターを使用する

私がこの記事を終えたとき、彼らは私にキャッシュのための興味深いソリューションを促しました。 この場合、アプリケーションの実行状態でコンポーネントを保存する必要が本当にありますか？ インスタンスごとに1回だけこれを行うため、機能的には、アプリケーションを起動する前にエディターでインスタンスを割り当てるのと同じです。 そして、エディターでできることはすべて自動化できます。



そのため、メニューの別のオプションを使用してスクリプトの依存関係をキャッシュし、さらに使用するためにシーン上のインスタンスを準備するというアイデアが生まれました。







このメソッドには独自の特性があります。

• 明示的な初期化にリソースは必要ありません。
• オブジェクトは明示的に準備されます（コードの再コンパイルでは不十分です）
• 準備中のオブジェクトはステージ上にある必要があります
• 準備は、プロジェクトのプレハブ（シーンから明示的に保存しない限り）および他のシーンのオブジェクトには影響しません

現在の制限は将来削除される可能性があります。

おわりに

この記事では、コンポーネントをキャッシュするためのさまざまな方法の評価を見ました。また、属性の有用な使用法の1つについても学びました。 原則として、Unity3Dでプロジェクトを作成するときに、その機能を考慮して、リフレクションに基づくメソッドを使用できます。 それらの1つを使用すると、同じタイプのコードをより少なく書くことができますが、ソリューションの「正面」よりも生産性が少し低下します。 現時点で2番目のものはもう少し注意が必要ですが、最終的なパフォーマンスには影響しません。



属性を使用したテストおよび概念実証のキャッシュ用のスクリプトソースコードを含むプロジェクトは、 GitHubで入手できます （最終バージョンはこちら ）。 改善のための提案があるかもしれません。



ご清聴ありがとうございました。有益なコメントをお待ちしております。 確かにこの問題は多くの人によって検討されており、これについて何か言いたいことがあります。



更新

利用可能な最新バージョン（0.32）には、2つの新しい機能が追加されました。

1. キャッシングプロパティの個別のクラス （）
2. 「エディターで」モードを使用する場合、シーンを組み立てる前に、必要なコンポーネントがキャッシュされ、メニュー項目を使用して事前に何かがキャッシュされていない場合は警告が表示されます（残念ながら、OnPostProcessSceneでシーンを保存することはできません）。