@nqounetです。

シリーズ「Mooで作る簡易テキストエディタ」の最終回です。

前回、私たちはついに対話型インターフェースを持つ簡易テキストエディタを完成させました。

第9回-完成！簡易エディタ - 統合と仕上げ - Mooで作る簡易テキストエディタ

これまで作成したEditor、コマンドクラス、History、MacroCommandを統合し、対話的に操作できるCLIベースの簡易テキストエディタを完成させます。

nqou.net

今回は、シリーズを締めくくるにあたって、ある驚きの事実をお伝えします。

実は…これはデザインパターンだった！

9回にわたってコードを書いてきた皆さん、お気づきでしょうか。

私たちが作ったエディタは、Commandパターンと呼ばれるデザインパターンの実装だったのです。

「デザインパターン」とは、ソフトウェア設計における定石やお約束のことです。将棋や囲碁に定石があるように、プログラミングにも「こういう問題にはこう設計するとうまくいく」というパターンがあります。

1994年に出版された『オブジェクト指向における再利用のためのデザインパターン』（通称：GoF本）で、23のデザインパターンが体系化されました。Commandパターンはその1つです。

オブジェクト指向における再利用のためのデザインパターン amazon.co.jp

Commandパターンとは

GoF本による定義は以下の通りです。

要求をオブジェクトとしてカプセル化することで、さまざまな要求によるクライアントのパラメータ化、要求のキューイングやロギング、取り消し可能な操作のサポートを可能にする。

難しそうに聞こえますが、私たちがやってきたことを振り返れば、自然に理解できます。

「操作をオブジェクトにする」——これがCommandパターンの本質です。

私たちは、「テキストを挿入する」「テキストを削除する」という操作そのものを、InsertCommandやDeleteCommandというオブジェクトにしました。操作をオブジェクトにすることで、以下のことが可能になりました。

• 操作を履歴として保存できる
• 操作を取り消す（Undo）ことができる
• 操作をやり直す（Redo）ことができる
• 複数の操作をまとめて実行できる

Commandパターンの構成要素

Commandパターンは、5つの役割で構成されています。私たちが作ったクラスと対応させてみましょう。

それぞれの役割を詳しく見ていきましょう。

Command（インターフェース）: Command::Role

1
2
3
4
5
6

package Command::Role {
    use Moo::Role;

    requires 'execute';
    requires 'undo';
};

すべてのコマンドが持つべきメソッド（executeとundo）を定義しています。これにより、Historyクラスは具体的なコマンドの種類を知らなくても、統一的に扱えます。

ConcreteCommand（具象コマンド）: InsertCommand, DeleteCommand

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

package InsertCommand {
    use Moo;
    with 'Command::Role';

    has editor   => ( is => 'ro', required => 1 );
    has position => ( is => 'ro', required => 1 );
    has string   => ( is => 'ro', required => 1 );

    sub execute ($self) { ... }
    sub undo ($self) { ... }
};

具体的な操作を実装するクラスです。各コマンドは、自分自身を「実行する」方法と「元に戻す」方法を知っています。

Invoker（呼び出し元）: History

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

package History {
    use Moo;

    has undo_stack => ( is => 'ro', default => sub { [] } );
    has redo_stack => ( is => 'ro', default => sub { [] } );

    sub execute_command ($self, $command) { ... }
    sub undo ($self) { ... }
    sub redo ($self) { ... }
};

コマンドを実行し、履歴を管理します。どのコマンドが実行されたかを記憶し、Undo/Redoを可能にします。

Receiver（受信者）: Editor

1
2
3
4
5

package Editor {
    use Moo;

    has text => ( is => 'rw', default => '' );
};

コマンドによって操作される対象です。コマンド自身がReceiverへの参照を持ち、execute時に操作を行います。

Client（クライアント）: メインスクリプト

1
2
3
4
5
6
7
8
9

my $editor  = Editor->new;
my $history = History->new;

my $cmd = InsertCommand->new(
    editor   => $editor,
    position => 0,
    string   => 'Hello',
);
$history->execute_command($cmd);

コマンドを生成し、必要なパラメータを設定して、Invokerに渡します。

クラス図で見るCommandパターン

Mermaidでクラス図を描いてみましょう。

	classDiagram
    class Client {
        +main()
    }
    class History {
        -undo_stack
        -redo_stack
        +execute_command(cmd)
        +undo()
        +redo()
    }
    class Command_Role {
        <<interface>>
        +execute()
        +undo()
    }
    class InsertCommand {
        -editor
        -position
        -string
        +execute()
        +undo()
    }
    class DeleteCommand {
        -editor
        -position
        -length
        +execute()
        +undo()
    }
    class MacroCommand {
        -commands
        +execute()
        +undo()
        +add_command()
    }
    class Editor {
        -text
    }

    Client --> History : uses
    Client --> InsertCommand : creates
    Client --> DeleteCommand : creates
    History --> Command_Role : manages
    Command_Role <|.. InsertCommand : implements
    Command_Role <|.. DeleteCommand : implements
    Command_Role <|.. MacroCommand : implements
    InsertCommand --> Editor : modifies
    DeleteCommand --> Editor : modifies
    MacroCommand --> Command_Role : contains

この図を見ると、各クラスの関係が一目でわかります。

Commandパターンの利点

改めて、Commandパターンがもたらす利点をまとめます。

• Undo/Redoが自然に実装できる: 各コマンドが自分自身のundoを知っている
• 操作の履歴が取れる: 実行したコマンドをスタックに積むだけ
• マクロ機能が簡単: 複数のコマンドを1つにまとめるだけ（Compositeパターンとの組み合わせ）
• 操作のキューイング: コマンドをキューに入れて、後から順番に実行できる
• 操作のログ: コマンドを記録しておけば、何が行われたか追跡できる
• 操作の遅延実行: コマンドを生成しておいて、後から実行できる

Commandパターンの応用例

Commandパターンは、テキストエディタ以外にも多くの場面で活用されています。

CLIツール

コマンドラインツールでは、各サブコマンド（git commit, git pushなど）をCommandパターンで実装できます。

1
2
3

# 概念的なコード
my $command = $commands{$ARGV[0]};  # 'commit' => CommitCommand
$command->execute(@ARGV[1..$#ARGV]);

ジョブキュー

バックグラウンドで処理するジョブをCommandオブジェクトとしてキューに入れ、ワーカーが順番に実行します。

1
2
3
4
5
6
7
8

# 概念的なコード
$queue->enqueue(SendEmailCommand->new(to => 'user@example.com'));
$queue->enqueue(ResizeImageCommand->new(path => 'image.jpg'));

# ワーカー側
while (my $cmd = $queue->dequeue) {
    $cmd->execute;
}

マクロ記録

ユーザーの操作を記録しておき、後から再生する機能もCommandパターンで実現できます。

1
2
3
4
5
6

# 記録モード
push @recorded_commands, $cmd;
$cmd->execute;

# 再生モード
$_->execute for @recorded_commands;

Strategyパターンとの比較

以前のシリーズ「Mooを使ってディスパッチャーを作ってみよう」では、Strategyパターンを学びました。

第12回-これがデザインパターンだ！ - Mooを使ってディスパッチャーを作ってみよう

実は作ってきたものが「Strategy パターン」だったことを明かします。デザインパターンの世界への入口と、次のステップを紹介します。

nqou.net

両者の違いを整理しておきましょう。

どちらも「振る舞いをオブジェクトにする」という点では共通していますが、目的が異なります。

シリーズ全体の振り返り

全10回を通じて、私たちは以下のことを学びました。

最初は「テキストを編集するだけ」のシンプルなクラスから始まり、問題を解決するために自然とクラスを増やしていった結果、GoFのCommandパターンに辿り着いたのです。

次のステップへ

Commandパターンを学んだ今、次に学ぶとよいデザインパターンを紹介します。

• Factory Method: オブジェクトの生成をサブクラスに任せる
• Observer: オブジェクトの状態変化を通知する
• Decorator: オブジェクトに動的に機能を追加する
• Chain of Responsibility: 処理を連鎖させる

また、Mooの機能をさらに深く学びたい方は、「Mooで覚えるオブジェクト指向プログラミング」シリーズもおすすめです。

第1回-Mooで覚えるオブジェクト指向プログラミング

もうかなり前ですが、初心者向けにMooを使ったオブジェクト指向プログラミングの記事を書こうとしていて、下書きが残ったままでした

nqou.net

おわりに

「気がつけばデザインパターンだった」——これが本シリーズの目標でした。

デザインパターンは、暗記するものではありません。問題を解決しようと試行錯誤するうちに、自然と辿り着くものです。

皆さんが次に「操作を履歴に残したい」「Undoを実装したい」という場面に出会ったとき、「ああ、Commandパターンだ！」と気づけるようになっているはずです。

全10回にわたるシリーズをお読みいただき、ありがとうございました。

関連記事

このシリーズの記事

• 第1回〜第9回は「moo-text-editor」タグから参照できます

関連シリーズ

• 「Mooで覚えるオブジェクト指向プログラミング」シリーズ

第1回-Mooで覚えるオブジェクト指向プログラミング

もうかなり前ですが、初心者向けにMooを使ったオブジェクト指向プログラミングの記事を書こうとしていて、下書きが残ったままでした

nqou.net

• 「Mooを使ってディスパッチャーを作ってみよう」シリーズ（Strategyパターン）

第12回-これがデザインパターンだ！ - Mooを使ってディスパッチャーを作ってみよう

実は作ってきたものが「Strategy パターン」だったことを明かします。デザインパターンの世界への入口と、次のステップを紹介します。

nqou.net

参考書籍

オブジェクト指向における再利用のためのデザインパターン amazon.co.jp