インターフェースを利用したコマンドパターンの実装例 - i-school

インターフェースの機能と定義

　インターフェースは、クラスに対して特定のメソッドやプロパティを実装することを要求することができるものです。
これにより、複数のクラスで同じ動作をすることを強制することができます。

参考サイト

++C++; // 未確認飛行 C 様
インターフェース

　実装の方法は、インターフェースを定義するための「interface」キーワードを使用します。例えば、次のようなインターフェースを定義できます。

<= クリックすると開きます。

public interface IMoveable
{
    void Move();
}

　このインターフェースを実装するクラスは、「IMoveable」を実装して、「Move」メソッドを実装することが必要になります。

<= クリックすると開きます。

public class Player : IMoveable　//　<=　インターフェースを実装する
{
    public void Move()　　//　<=　IMoveable インターフェース内に定義されているメソッドを実装する
    {
        // Move the player.
    }
}

　インターフェースで定義したメソッドは、明記しなくても public 扱いになります。

　インターフェースの利点としては、次のようなものがあります。

　・複数のクラスで同じ動作を強制することができる。
　・インターフェースを継承したクラスに対して同じように操作することができる。
　・コードの保守性を高めることができる。
　・仮想メソッドよりも軽量である。

　これらの利点により、インターフェースを利用した設計を行うことでよりスマートなコードを書くことができます。

コマンドパターン

　コマンドパターンは、命令をオブジェクトとして扱うことで、再利用性を向上させ、管理しやすくすることができる設計パターンです。
プログラムにおけるデザインパターンの１つであり、この設計パターンにおいてはインターフェースが活用されています。

　下記に実装例を示します。

１．命令用のインターフェースを定義する

　まず、コマンド用の ICommand インターフェースを定義します。
今回はサンプルのためファイルを分けていますが、１つのファイルにインターフェースとクラスとを一緒に書いても問題ありません。

<= クリックすると開きます。

public interface ICommand
{
    void Execute();
}

２．命令用のクラスを定義する

　次に、各命令を表すクラスを実装します。
命令ごとのに１つのクラスを定義するようにします。

　今回は２つのクラスを定義しています。

＜移動用の命令クラス＞

<= クリックすると開きます。

using UnityEngine;

public class MoveCommand : ICommand
{
    private GameObject gameObject;
    private Vector3 direction;

    public MoveCommand(GameObject gameObject, Vector3 direction)
    {
        this.gameObject = gameObject;
        this.direction = direction;
    }

    public void Execute()
    {
        gameObject.transform.position += direction;
    }
}

＜ジャンプ用の命令クラス＞

<= クリックすると開きます。

using UnityEngine;

public class JumpCommand : ICommand
{
    private GameObject gameObject;

    public JumpCommand(GameObject gameObject)
    {
        this.gameObject = gameObject;
    }

    public void Execute()
    {
        gameObject.GetComponent<Rigidbody>().AddForce(Vector3.up * 10, ForceMode.Impulse);
    }
}

　どちらのクラスにも ICommand インターフェースが実装され、クラス内に Execute メソッドの実装が強制されていることが分かります。
ただし、それぞれの Execute メソッドの実装(中身)が異なるため、同名のメソッドではあるものの処理の内容が変わっています。

３．命令管理クラスを定義する

　最後に、命令を管理するクラスを作成します。

<= クリックすると開きます。

using System.Collections.Generic;

public class CommandManager
{
    private List<ICommand> commands = new List<ICommand>();

    public void AddCommand(ICommand command)
    {
        commands.Add(command);
    }

    public void ExecuteCommands()
    {
        foreach (var command in commands)
        {
            command.Execute();
        }
    }
}

　AddCommnad メソッドを利用し、ICommnad インターフェースを実装しているオブジェクトを commands リストに登録しています。
ポイントとしては、ICommnad インターフェースのリストであるため、クラスに関わらず、ICommnad インターフェースを実装していればリストに登録できる点です。
そのため、MoveCommnad クラス、JumpCommnad クラスのどちらであっても commands リストに登録できます。

　ExecuteCommands メソッドでは ICommnad のリストである commands リストを foreach 文を利用してループ処理し、
リスト内に格納されている ICommnad インターフェースを実装しているクラスの各 Execute メソッドを実行します。
Execute メソッドは MoveCommand クラスと JumpCommnad クラスではメソッド内の処理が異なるため、同じメソッドを実行していますが、処理の振る舞いが変わります。

４．利用方法

　命令を実行するためには、「CommandManager」クラスに「ICommand」を実装した「MoveCommand」や「JumpCommand」などを追加して行います。
それらを追加したあとに、実際に処理を行う Execute メソッドを実行するには「ExecuteCommands」メソッドを呼び出します。

　「CommandManager」クラスから「MoveCommand」を命令を実行するためのサンプルは以下のようになります。

<= クリックすると開きます。

using UnityEngine;

public class Example : MonoBehaviour
{
    private CommandManager commandManager = new CommandManager();
    private GameObject gameObject;
    private Vector3 direction = Vector3.right;

    private void Start()
    {
        gameObject = GameObject.Find("Player");

        // MoveCommandを追加
        commandManager.AddCommand(new MoveCommand(gameObject, direction));
    }

    private void Update()
    {
        if (Input.GetKeyDown(KeyCode.Space))
        {
            // MoveCommandを実行
            commandManager.ExecuteCommands();
        }
    }
}

　このサンプルでは、「Start」メソッド内では「CommandManager」に「MoveCommand」を追加しています。
その後、「Update」メソッド内でスペースキーが押された時に「CommandManager」の「ExecuteCommands」メソッドを呼び出して「MoveCommand」を実行しています。

DI コンテナ(VContainer)を利用したケースでの実装例

　VContainer を利用することで「CommandManager」クラスをDI（Dependency Injection）コンテナとして活用することができます。
以下は、「CommandManager」クラスを「VContainer」を利用して活用する例です。

１．インターフェースの定義

　VContainer の機能を利用するための ICommandManager インターフェースを作成します。

<= クリックすると開きます。

using VContainer;

public interface ICommandManager
{
    void AddCommand(ICommand command);
    void ExecuteCommands();
}

２．命令管理用のクラスの定義

　先ほど作成した CommnadManager とは異なり、ICommnadManager インターフェースを実装して命令管理用のクラスを作成します。

<= クリックすると開きます。

using System.Collections.Generic;

[Inject(typeof(ICommandManager))]
public class CommandManager : ICommandManager
{
    private List<ICommand> commands = new List<ICommand>();

    public void AddCommand(ICommand command)
    {
        commands.Add(command);
    }

    public void ExecuteCommands()
    {
        foreach (var command in commands)
        {
            command.Execute();
        }
    }
}

　「CommandManager」クラスは「ICommandManager」インターフェースを実装し、「Inject」属性を付けています。
これにより、「VContainer」に「CommandManager」クラスが「ICommandManager」として登録されます。

３．Example クラスを定義して活用する例

　MoveCommnad クラスなどをそのまま利用し、同じ処理を作成します。

<= クリックすると開きます。

using UnityEngine;

public class Example : MonoBehaviour
{
    [Inject]
    private ICommandManager commandManager;

    private GameObject gameObject;
    private Vector3 direction = Vector3.right;

    private void Start()
    {
        gameObject = GameObject.Find("Player");
        this.Inject();

        // MoveCommandを追加
        commandManager.AddCommand(new MoveCommand(gameObject, direction));
    }

    private void Update()
    {
　　　　// デバッグ用。スペースボタンを押したら
        if (Input.GetKeyDown(KeyCode.Space))
        {
            // MoveCommandを実行
            commandManager.ExecuteCommands();
        }
    }
}

　「Example」クラスは「ICommandManager」をインジェクトするために「Inject」属性を付けています。
「Start」メソッド内では「Inject」メソッドを呼び出すことで「ICommandManager」のインスタンスが生成されます。

　DI コンテナの機能を利用することにより、処理の抽象度をさらに増し、汎用性のある処理に作り変えることが可能です。