【Unity-C#】Interfaceの利点を学ぶ

ありがとうIndie Live Expo

ブログの閲覧数がやたら増えているなぁと不思議に思っていたらIndie Live Expoで紹介されたお陰だと気づいた皆さんこんにちは。6時間近く放送された番組の中で15秒ちょっと映っただけなんですがね、紹介されたところで誰も気に掛けないだろう、とやさぐれていた自分が恥ずかしいです。どうも有難うございます。Twitterのフォロワーもちょくちょく増えてほんとビックリ。

Interface

さて、UnityのスクリプトはC#が標準なのでInterfaceを定義して使う事ができます。
InterfaceとはC#の参考書などによれば「クラス外部からみた規約だけを定めるもの」とうたわれており、それがピンとこない場合は「実装がないメソッド定義をアチコチで使い回すもの」とでも思えば良いです。

例えばゲーム内に敵A、敵Bがおり、それぞれに独自の制御用クラス(EnemyA_Control,EnemyB_Control)が実装されているケースを考えてみます。

Manager的なクラスが敵A,Bにゲーム内のイベント(ゲーム開始や終了等)に応じた処理を依頼する場合、ManagerクラスはEnemyA_Control,EnemyB_Controlそれぞれのクラスを意識して「EnemyA_Controlのゲーム開始時処理」「EnemyB_Controlのゲーム開始時処理」をコールする必要があります。

 敵が二種類しかいない場合はそれでも構いませんが、敵の数が増えていくと面倒くさいことこの上ない。
処理を依頼するタイミングは同じなのだから(クラスは違えど)コールするメソッドも同じにすることができればコーディングの量も減って以後の作業も楽になります。
なので、そういった要望を実現するためにInterfaceは使用されます。

定義と使い方

インターフェースを定義するには「interface」を使用します。interface内のメソッドやプロパティなどはすべてpublicとして扱われます。

    interface (インターフェース名){
        メソッド名(引数);
        メンバー変数;
        ...
    }

実装側はクラスの継承定義を同じようにインターフェース名を設定します。

    public class クラス名 : (継承クラス名), (インターフェース名)
    {
        メソッド名(引数);
        メンバー変数;
        ...
    }

ここで実装側はInterfaceが持つメソッド、プロパティなどをすべて実装する必要があることに注意が必要です。
(定義のみで中身は空でもよい)

具体的に、先ほどの敵A、Bにゲーム開始時処理のInterfaceを実装したい場合

    // インターフェース定義
    interface IEnemyInterface {
        void StageStartProc();    // ゲーム開始時処理
    }

上記のインターフェース定義を行った後に、各制御用クラスにインターフェース定義を追加します。

    // 敵A側
    public class EnemyA_Control : MonoBehaviour, IEnemyInterface {
        
        void StageStartProc() {
            // 敵Aのゲーム開始時処理
            
        }
    }

    // 敵B側
    public class EnemyB_Control : MonoBehaviour, IEnemyInterface {
        
        void StageStartProc() {
            // 敵Bのゲーム開始時処理
            
        }
    }

マネージャークラス側はGetComponentでクラス名でなくインターフェイス名を指定してコンポーネントを取得、ゲーム開始時処理をコールします。

    public List<GameObject> EnemyList;    // 敵A,Bが格納されたリスト
    
    // ゲーム開始時処理
    void StageStart()
    {
        foreach(GameObject obj in EnemyList)
        {
            // インターフェイス名を指定してコンポーネントを取得
            IEnemyInterface objIF = obj.GetComponent(typeof(IEnemyInterface)) as IEnemyInterface;
            
            // ゲーム開始時処理をコール
            objIF.StageStartProc();
        }
    }

Interfaceを利用するとクラス間の疎結合も可能なので色々と利点が多いと思います。