本記事は Flutter 大学アドベントカレンダー 22 日目の記事です。

はじめまして cobo といいます。
私はソフトウェアの設計を学ぶことに興味があるため、今回は GoF デザインパターンの中から Command パターンを紹介させていただきます。

本記事のゴール

Command パターンが理解できる
Command パターンを実装してサンプルアプリを作成することができる

説明すること／しないこと

すること

デザインパターンの概要
Command パターンの概要
Command パターンの実装方法

しないこと

デザインパターンの種類とそれらの説明
状態管理の方法(Stateless, Stateful, Riverpod など)
※本記事では StatefulWidget で実装を行います。

それでは本題に入っていきます。

Command パターンとは?

処理の呼び出し（命令）と、処理の内容を分離するデザインパターンのことです。

そもそもデザインパターンとは？

過去のソフトウェア設計者が発見し編み出した設計ノウハウを蓄積し、名前をつけ、再利用しやすいように特定の規約に従ってカタログ化したものです。
ソフトウェア開発における設計カタログだと思っていただければイメージがつきやすいかと思います。
今回説明する Command パターンは数多くある設計カタログ中の 1 種類ということになります。

実装

今回は Command パターンを実装して下記サンプルアプリを作成していきます。

要件

画面上のボックスに対して変更を加えることができる
- Change color command ボタン押下によって、ボックスの色をランダムに変更できる
加えた変更を元に戻すことができる
- Undo ボタン押下によって、ボックスを１つ前の状態に戻すことができる

Command パターンの概要

Command デザインパターンを扱うときの一般的なプログラムの構成を以下に示します。

それぞれのクラスの役割

クラス	役割
Command<interface>	操作を実行するためのインタフェースを宣言
Command	Command<interface> の具象
Receiver	Command の受取手、Command 処理の対象
Invoker	画面上の操作をトリガーとして Command 処理を実行
Client	Command の生成及び Receiver の設定
CommandHistory	実行した Command の履歴管理

Command<interface>

インタフェースとして、抽象的なコマンドを定義します。

command.dart

/// コマンドを抽象的に定義
abstract class Command {
  /// コマンドの実行
  void execute();

  /// コマンド名の取得
  String getTitle();

  /// コマンドの実行を元に戻す
  void undo();
}

Command

抽象として定義した Command を具象として定義します。
Command インタフェースを実装するところがポイントです。

change_color_command.dart

/// 色変更コマンド
///
/// Commandインタフェースを実装して具体的な処理を記述する
class ChangeColorCommand implements Command {
  // 色変更対象のShapeオブジェクト
  Shape shape;
  // 変更前の色
  late Color previousColor;
  final random = math.Random();

  /// コンストラクタ
  ///
  /// 引数にてClientからReceiverを受け取る
  /// そのReceiverに対して変更を加えていくイメージ
  /// 今回の例で言うとReceiverはShapeオブジェクトとなる
  ChangeColorCommand(this.shape) {
    previousColor = shape.color;
  }

  /// コマンド処理の実体
  /// -> shapeにランダムな色を設定する
  @override
  void execute() {
    shape.color = Color.fromRGBO(
      random.nextInt(255),
      random.nextInt(255),
      random.nextInt(255),
      1.0,
    );
  }

  @override
  String getTitle() {
    return 'Change color';
  }

  /// 加えた変更を無かったことにする処理
  @override
  void undo() {
    shape.color = previousColor;
  }
}

Receiver

Command 処理の対象となるオブジェクトを定義します。
上記 Command クラスのコンストラクタに Receiver（Shape）を渡すことで、Receiver に対して様々な変更を加えることが可能になります。

shape.dart

/// Commandの受取手、Command処理の対象オブジェクト
class Shape {
  late Color color;
  late double height;
  late double width;

  Shape.initial() {
    color = Colors.black;
    height = 150.0;
    width = 150.0;
  }
}

Invoker, Client

Invoker

Client(画面)上の操作をトリガーとして Command 処理を呼び出します。
Client から直接呼ばれるメソッドだと思っていただければイメージしやすいかと思います。

Client

Command の生成(インスタンス化)、Receiver の設定、画面上の操作によって Invoker を呼び出します。

command_example_page.dart

一部抜粋

/// Commandを利用する側がClientとなるので、_CommandExamplePageStateがClientになるイメージ
class _CommandExamplePageState extends State<CommandExamplePage> {
  // undoを実現するためのCommand履歴
  final CommandHistory _commandHistory = CommandHistory();
  // Receiver(shape)の初期設定
  final Shape _shape = Shape.initial();

  /// Invoker(色変更ボタン押下時に呼ばれるメソッド)
  void _changeColor() {
    // CommandのReceiverとして_shapeを渡す
    final command = ChangeColorCommand(_shape);
    // 実行したコマンドをコマンド履歴に追加
    _executeCommand(command);
  }

  void _executeCommand(Command command) {
    setState(() {
      command.execute();
      _commandHistory.add(command);
    });
  }

  void _undo() {
    if (_commandHistory.isEmpty) return;
    setState(() {
      _commandHistory.undo();
    });
  }

  @override
  Widget build(BuildContext context) {
    return Scaffold(
      appBar: AppBar(
        title: Text(
          'Command Design Pattern',
          style: TextStyle(color: Colors.grey[700]),
        ),
      ),
      body: SingleChildScrollView(
        padding: const EdgeInsets.symmetric(
          horizontal: 10,
        ),
        child: Column(
          children: <Widget>[
            SizedBox(
              height: 160.0,
              child: Center(
                child: AnimatedContainer(
                  duration: const Duration(milliseconds: 500),
                  height: _shape.height,
                  width: _shape.width,
                  decoration: BoxDecoration(
                    color: _shape.color,
                    borderRadius: BorderRadius.circular(10.0),
                  ),
                  child: const Icon(
                    Icons.star,
                    color: Colors.white,
                  ),
                ),
              ),
            ),
            const SizedBox(height: 15),
            ElevatedButton(
              onPressed: _changeColor,
              child: const Text('Change color command'),
            ),
            const Divider(),
            ElevatedButton(
              onPressed: _undo,
              child: const Text('Undo'),
            ),
            const SizedBox(height: 15),
            CommandHistoryColumn(
              commandList: _commandHistory.commandHistoryList,
            ),
          ],
        ),
      ),
    );
  }
}

CommandHistory

実行した Command を履歴管理するためのオブジェクトを定義します。
これにより、undo/redo などの機能が実現可能となります。

command_history.dart

/// 実行したCommandを履歴管理するためのオブジェクト
class CommandHistory {
  final List<Command> _commandList = <Command>[];

  bool get isEmpty => _commandList.isEmpty;

  /// 実行したコマンド名を文字列のリストで返却
  List<String> get commandHistoryList =>
      _commandList.map((c) => c.getTitle()).toList();

  void add(Command command) {
    _commandList.add(command);
  }

  /// Command履歴リストの末尾要素を削除
  /// Command履歴リストの末尾要素のundo処理を実行して一つ前の状態に戻す
  void undo() {
    if (_commandList.isNotEmpty) {
      final command = _commandList.removeLast();
      command.undo();
    }
  }
}

新たに機能を追加してみる

現時点でのサンプルアプリの機能は

色変更

のみの操作となっており、この操作が Command として定義されています。
これに対してさらにアイコン変更Command を追加してみることにします。

Shape オブジェクトに新規プロパティの追加

アイコンを変更したいので、まずは Shape オブジェクトに icon プロパティを新たに定義します。

shape.dart

/// Commandの受取手、Command処理の対象オブジェクト
class Shape {
  late Color color;
  late double height;
  late double width;
  late IconData icon;   // 追加

  Shape.initial() {
    color = Colors.black;
    height = 150.0;
    width = 150.0;
    icon = Icons.star;  // 追加、デフォルトは星アイコン
  }
}

アイコン変更 Command を新規追加

色変更コマンド同様に Command インタフェースを実装したアイコン変更コマンドを新たに定義します。

change_icon_command.dart

/// アイコン変更コマンド
class ChangeIconCommand implements Command {
  // アイコン変更対象のShapeオブジェクト
  Shape shape;
  // 変更前のアイコン
  late IconData previousIcon;

  ChangeIconCommand(this.shape) {
    previousIcon = shape.icon;
  }

  @override
  void execute() {
    shape.icon = Icons.star_border;
  }

  @override
  String getTitle() {
    return 'Change icon';
  }

  @override
  void undo() {
    shape.icon = previousIcon;
  }
}

アイコン変更 CommandInvoker を新規追加

こちらも色変更コマンドの Invoker と同様に新たにアイコン変更 CommandInvoker を定義します。

command_example_page.dart

一部抜粋
  /// Invoker(アイコン変更ボタン押下時に呼ばれるメソッド)
  void _changeIcon() {
    // CommandのReceiverとして_shapeを渡す
    final command = ChangeIconCommand(_shape);
    // 実行したコマンドをコマンド履歴に追加
    _executeCommand(command);
  }

画面のアイコン変更ボタンにより Invoker を呼び出す

ユーザの新規操作としてアイコン変更を実現するために、新たにアイコン変更ボタンを定義します。

command_example_page.dart

一部抜粋
            ElevatedButton(
              onPressed: _changeColor,
              child: const Text('Change color command'),
            ),
            // 追加 ここから
            const SizedBox(height: 5),
            ElevatedButton(
              onPressed: _changeIcon,
              child: const Text('Change icon command'),
            ),
            // 追加 ここまで
            const Divider(),
            ElevatedButton(
              onPressed: _undo,
              child: const Text('Undo'),
            ),

完成

これで色変更コマンド & アイコン変更コマンドを実装したサンプルアプリが出来上がりました。
お疲れ様でした！

本サンプルの全ソースはこちら

Flutter で Command パターンを実装してみての感想

今回の記事で初めて GoF デザインパターンの Command パターンを Flutter で実装しました。
ユーザ操作を Command として定義することで、

操作履歴を管理することが容易になる
新たなユーザ操作を新規 Command として定義することで、既存処理の影響少なくしたままコードを書くことができる

といった点が魅力的で、コードを書いていてとても楽しかったです。

普段、デザインパターンを直接活用する機会はあまりないとは思いますが、デザインパターンを少しでも理解しておくだけで、言語に依存しない設計知識を身につけることができるので、どの言語にでもこれらの概念を適用することができます。
その点が興味深いところだなと感じでいます。
今後も定期的にデザインパターンを学習、紹介していきたいと思いました。

参考

Discussion