Commandパターン

CoddyのGOジャーニー「オブジェクト指向プログラミング」セクションの一部。レッスン 91/107。

Commandパターンはリクエストをオブジェクトとしてカプセル化し、操作をパラメーター化したり、キューに追加したり、取り消し機能をサポートしたりできるようにします。Strategyがアルゴリズムをカプセル化するのに対し、Commandはパラメーターとともにアクション全体をカプセル化します。

Goでは、Executeメソッドを持つCommandインターフェースを定義し、アクションを実行するために必要なすべての情報を保持する具体的なコマンドを作成します。

type Command interface {
    Execute() string
}

type Light struct {
    IsOn bool
}

type TurnOnCommand struct {
    light *Light
}

func (c *TurnOnCommand) Execute() string {
    c.light.IsOn = true
    return "Light turned on"
}

type TurnOffCommand struct {
    light *Light
}

func (c *TurnOffCommand) Execute() string {
    c.light.IsOn = false
    return "Light turned off"
}

呼び出し側は、コマンドが何をするかを知らずにコマンドを保存して実行します：

type RemoteControl struct {
    command Command
}

func (r *RemoteControl) SetCommand(c Command) {
    r.command = c
}

func (r *RemoteControl) PressButton() string {
    return r.command.Execute()
}

呼び出し元は、受信者（Light）から完全に切り離されています：

light := &Light{}
remote := &RemoteControl{}

remote.SetCommand(&TurnOnCommand{light: light})
fmt.Println(remote.PressButton())  // 照明が点灯した

remote.SetCommand(&TurnOffCommand{light: light})
fmt.Println(remote.PressButton())  // 照明が消灯した

Commandは、操作を保存、遅延、または再実行する必要がある場合に、取り消し／やり直しシステム、タスクキュー、またはマクロ記録を実装するのに最適です。

チャレンジ

簡単

Commandパターンを使って、取り消し機能付きのテキストエディターを作りましょう！テキスト操作をカプセル化するコマンドを作成し、エディターが操作を実行したり元に戻したりできるようにします。コマンドがなぜこれほど強力なのかを示す、古典的なユースケースです。

コードを3つのファイルに分けて整理します。

command.go: コマンドのインターフェースと、具体的なテキスト編集コマンドを定義します。
2つのメソッドを持つCommandインターフェースを作成します。操作を実行するExecute() stringと、元に戻すUndo() stringです。

*TextEditorを操作する2種類のコマンドを実装します。
- InsertCommand: エディターのポインターと挿入するテキストを保持します。Executeはテキストをエディターの内容に追加し、Inserted: [text]を返します。Undoはそのテキストを末尾から削除し、Undone insert: [text]を返します。
- DeleteCommand: エディターのポインターと、末尾から削除する文字数を保持します。Executeは文字を削除し（Undoのために保存しておき）、Deleted: [removed text]を返します。Undoは削除した文字を復元し、Undone delete: [restored text]を返します。
editor.go: テキストエディター（レシーバー）と、コマンド履歴を管理するインボーカーを作成します。
Contentフィールド（string型）を持つTextEditor構造体と、Append(text string)およびDeleteLast(count int) string（削除したテキストを返す）メソッドを作成します。

実行したコマンドのスライスを履歴として保持するEditorInvoker構造体を作成します。以下のメソッドを追加します。
- ExecuteCommand(cmd Command) string: コマンドを実行して履歴に追加し、結果を返します。
- UndoLast() string: 履歴から最後のコマンドを削除し、そのUndoを呼び出して結果を返します。履歴が空の場合はNothing to undoを返します。
main.go: 一連の操作を使って、コマンドシステムを実演します。
操作数を読み取ります。各操作について、操作の種類（insert、delete、またはundo）を読み取ります。insertの場合は、挿入するテキストも読み取ります。deleteの場合は、文字数を読み取ります。インボーカーを通じて各操作を実行し、結果を出力します。すべての操作の後、エディターの最終的な内容をFinal: [content]として出力します。

以下の入力が与えられます。

1行目: 操作数
各操作: 操作の種類。必要に応じて追加データ（insertの場合はテキスト、deleteの場合は文字数）が続きます。

たとえば、次の入力が与えられた場合:

5
insert
Hello
insert
 World
delete
3
undo
undo

出力は次のようになります。

Inserted: Hello
Inserted:  World
Deleted: rld
Undone delete: rld
Undone insert:  World
Final: Hello

また、次の入力が与えられた場合:

4
insert
Go
insert
Lang
undo
insert
!

出力は次のようになります。

Inserted: Go
Inserted: Lang
Undone insert: Lang
Inserted: !
Final: Go!

また、次の入力が与えられた場合:

2
undo
insert
Test

出力は次のようになります。

Nothing to undo
Inserted: Test
Final: Test

各コマンドが、その操作を実行し元に戻すために必要なすべての情報をカプセル化していることに注目してください。インボーカーはコマンドの処理内容を知りません。コマンドを実行し、Undoに備えて履歴を管理するだけです。

自分で試してみよう

package main

import (
	"bufio"
	"fmt"
	"os"
	"strconv"
	"strings"
)

func main() {
	reader := bufio.NewReader(os.Stdin)
	
	// 操作の数を読み込む
	line, _ := reader.ReadString('\n')
	numOps, _ := strconv.Atoi(strings.TrimSpace(line))
	
	// エディタとインボーカーを作成する
	editor := &TextEditor{}
	invoker := &EditorInvoker{}
	
	for i := 0; i < numOps; i++ {
		// 操作の種類を読み込む
		opLine, _ := reader.ReadString('\n')
		opType := strings.TrimSpace(opLine)
		
		var result string
		
		switch opType {
		case "insert":
			// 挿入するテキストを読み込む
			textLine, _ := reader.ReadString('\n')
			text := strings.TrimSuffix(textLine, "\n")
			
			// TODO: InsertCommand を作成し、インボーカーを通じて実行する
			_ = text
			_ = editor
			
		case "delete":
			// 削除する文字数を読み込む
			countLine, _ := reader.ReadString('\n')
			count, _ := strconv.Atoi(strings.TrimSpace(countLine))
			
			// TODO: DeleteCommand を作成し、インボーカーを通じて実行する
			_ = count
			
		case "undo":
			// TODO: インボーカーの UndoLast を呼び出す
			
		}
		
		fmt.Println(result)
	}
	
	// 最終的な内容を出力する
	fmt.Printf("Final: %s\n", editor.Content)
}