Memento ～スナップショットを取る
 絶版に伴い、校正前の原稿テキストを公開したものです。基本的に原稿そのままをHTML形式に変換したものですので、誤字/脱字、説明不足の箇所もあるかも知れませんがご了承ください。初出：「PHPによるデザインパターン入門」（下岡秀幸/畑勝也/道端良 著, 秀和システム, ISBN4-7980-1516-4, 2006年11月23日発売)
GoF本における分類
振る舞い＋オブジェクト
はじめに
ここではMementoパターンについて説明します。
「memento」とは聞き慣れない単語と思いますが、「記念品」「形見」「記憶」「思い出」といった意味があります。Mementoパターンは「Snapshotパターン」とも呼ばれますが、これなら分かりやすいでしょうか。Mementoパターンとは、ある時点のオブジェクトの記憶を保存し、あとで思い出せるようにするパターンです。
では、早速Mementoパターンを見ていきましょう。
たとえば
表計算ソフトやワードプロセッサ、テキストエディタなどのデスクトップアプリケーションを考えてみましょう。
ほとんどのアプリケーションでアンドゥ（Undo：やり直し）がサポートされています。アンドゥとは「ある状態を保存しておいて、その状態に戻せるようにしておく」機能です。また、リドゥ（Redo：やり直しのやり直し）をサポートしたアプリケーションも多いですね。リドゥも広い意味でアンドゥと同じと考えて良いと思います。なぜなら、リドゥは「アンドゥする前の状態を保存しておいて、その状態に戻せるようにしておく」機能だからです。
それでは、アンドゥやリドゥという機能はどういう風に実現しているのでしょうか？
オブジェクト思考的に考えてみると、「ある状態」というのはオブジェクトとして表せそうですね。そうすると、ある状態のオブジェクトをそのままどこかに保存しておき、必要なときにそのオブジェクトに置き変えてしまえばアンドゥが実現できそうです。
ここで言っている「状態」とはオブジェクト内部の状態、つまりオブジェクト内部に保持している値のことです。ですので、アンドゥを実現するために保存しておく必要があるのは、内部に保持している値そのもの、ということで良さそうです。ただし、アンドゥして期待した状態に復元させるには、保存した値を厳重に管理しなければならないでしょう。
いかがでしょうか？何となくイメージできましたか？
Mementoパターンは、これまで説明してきた内容そのままに、アンドゥを実現するパターンなのです。
Mementoパターンとは？
Mementoパターンの目的は、GoF本では次のように定義されています。
カプセル化を破壊せずに、オブジェクトの内部状態を捉えて外面化しておき、
オブジェクトを後にこの状態に戻すことができるようにする。
Mementoパターンは、ある時点のオブジェクトの状態を別のオブジェクトとして保存しておき、状態が変化した場合でも、その当時の状態に戻すことを可能にするパターンです。
Mementoパターンは、あるオブジェクトの記憶を保存するための専用のクラスと、その保存を管理するクラスから構成されます。
あるオブジェクトが記憶を保存する場合は、保存用のクラスをインスタンス化し、自分の記憶を詰め込みます。保存する記憶は、必要となる一部だけで構いませんが、他のクラスから記憶を書き換えられないよう注意する必要があります。そして、管理用のクラスに渡し、後で取り出せるよう管理してもらいます。逆に、記憶を戻したいときは、管理クラスに渡した記憶オブジェクトを取得し、自分自身に渡して記憶を復元します。管理クラスは、その記憶オブジェクトを操作したり、中を覗いたりしません。あくまで渡された記憶オブジェクトを管理するだけの役目を持ちます。
Mementoパターンは、状態を生成するクラスとその履歴の管理をするクラスを分離するパターンとも言えますね。
Mementoパターンの構造
Mementoパターンのクラス図と構成要素は、次のとおりです。
Mementoクラス
Originatorオブジェクトの記憶を保持する記憶用クラスです。Originatorオブジェクトの内部状態を保持します。厳密には、Originator以外のオブジェクトによってアクセスさせないようにする必要があります。理想的には、Mementoオブジェクトはそのオブジェクトを生成したOriginatorからのみアクセスできるようにすべきです。つまり、Caretakerオブジェクトなどの他のオブジェクトによって、内部状態を変化させないようにしなければなりません。保存した記憶の内容が変わってしまうからです。しかし残念ながら、PHP5には「特定のクラスだけにアクセスを許可する」といった制御機構はありません。これを回避するには、本来のMementoパターンの構造を若干変更する必要があります。
Originatorクラス
オブジェクトの内部状態を保存される側のクラスです。内部状態をMementoオブジェクトに詰め込み、それを返すメソッドを持ちます。
Caretakerクラス
Mementoオブジェクトを管理するクラスです。
Mementoパターンの適用例
Mementoパターンの適用例として、1行コメントを入力する小さなメモ帳を作ってみましょう。
このメモ帳はコメントを登録できるだけでなく、ある時点の状態を保存しておくことができます。また、その状態に戻すこともできる、というものです。
まずは、DataSnapshotクラスから見ていきましょう。DataSnapshotクラスはMementoクラスに相当するクラスで、「記憶」である1つ1つのコメントを保存します。コンストラクタとコメントを取り出すgetCommentメソッドがprotectedとして定義されていますが、これについては次のDataクラスで説明しています。
その他は、特に難しいところはないと思います。
●DataSnapshotクラス（DataSnapshot.class.php）
<?php
class DataSnapshot {
private $comment;
protected function __construct($comment) {
$this->comment = $comment;
}
protected function getComment() {
return $this->comment;
}
}
?>
次に、メモ帳のデータを表すDataクラスです。ここではDataSnapshotクラスのサブクラスとして定義しています。また、finalクラスとなっていることにも気づいたでしょうか？
これは構成要素のところでも説明しましたが、本来Mementoオブジェクトはそのオブジェクトを生成したOriginatorからのみアクセスできるようにする必要があります。さもないと、「記憶」であるDataSnapshotオブジェクトの内容が他のクラスから変更されてしまう可能性があるためです。
これを回避するためには、PHP5では継承とprotectedメソッドを組み合わせる必要があります。これにより、MementoオブジェクトであるDataSnapshotオブジェクトのメソッドには、Dataクラス以外からアクセスすることはできなくなり、記憶の保全が保証されます。
その他、スナップショットを生成するtakeSnapshotメソッドやスナップショットから状態を復元するrestoreSnapshotメソッドも用意されています。
●Dataクラス（Data.class.php）
<?php
require_once 'DataSnapshot.class.php';
?>
<?php
final class Data extends DataSnapshot {
private $comment;
public function __construct() {
$this->comment = array();
}
public function takeSnapshot() {
return new DataSnapshot($this->comment);
}
public function restoreSnapshot(DataSnapshot $snapshot) {
$this->comment = $snapshot->getComment();
}
public function addComment($comment) {
$this->comment[] = $comment;
}
public function getComment() {
return $this->comment;
}
}
?>
次はCaretakerクラスに相当するDataCaretakerクラスです。このサンプルではスナップショットの保存先としてPHPのセッション機能を利用していますが、セッションの開始やセッションとのデータのやりとりをおこなっています。
●DataCaretakerクラス（DataCaretaker.class.php）
<?php
class DataCaretaker {
public function __construct() {
if (!isset($_SESSION)) {
session_start();
}
}
public function setSnapshot($snapshot) {
$this->snapshot = $snapshot;
$_SESSION['snapshot'] = $this->snapshot;
}
public function getSnapshot() {
return (isset($_SESSION['snapshot']) ? $_SESSION['snapshot'] : null);
}
}
?>
最後にクライアント側のコードです。コメントの一覧と入力用HTMLフォームの表示を表示します。
コメントの状態のスナップショットを取る場合は、Dataオブジェクトからスナップショットを作成し、DataCaretakerオブジェクトに渡して保存してもらっています。また、状態を復元する際は、逆にDataCaretakerオブジェクトから「記憶」を取り出し、Dataオブジェクトに渡しています。
●クライアント側コード（memento_client.php）
<?php
require_once 'Data.class.php';
require_once 'DataCaretaker.class.php';
?>
<?php
$data = isset($_SESSION['data']) ? $_SESSION['data'] : new Data();
$caretaker = new DataCaretaker();
$mode = (isset($_POST['mode'])? $_POST['mode'] : '');
switch ($mode) {
case 'add':
$data->addComment((isset($_POST['comment']) ? $_POST['comment'] : ''));
break;
case 'save':
$caretaker->setSnapshot($data->takeSnapshot());
echo '<font style="color: #dd0000;">データを保存しました。</font><br>';
break;
case 'restore':
$data->restoreSnapshot($caretaker->getSnapshot());
echo '<font style="color: #00aa00;">データを復元しました。</font><br>';
break;
case 'clear':
$data = new Data();
}
echo '今までのコメント';
if (!is_null($data)) {
echo '<ol>';
foreach ($data->getComment() as $comment) {
echo '<li>' . htmlspecialchars($comment, ENT_QUOTES) . '</li>';
}
echo '</ol>';
}
$_SESSION['data'] = $data;
?>
<form action="" method="post">
コメント：<input type="text" name="comment"><br>
<input type="submit" name="mode" value="add">
<input type="submit" name="mode" value="save">
<input type="submit" name="mode" value="restore">
<input type="submit" name="mode" value="clear">
</form>
このサンプルコードのクラス図は、次のようになります。
Mementoパターンのメリット
Mementoパターンのメリットとしては、以下のものが挙げられます。
オブジェクトの状態をある時点に戻すことができる
Mementoパターンを適用する目的でもあります。サンプルでは、1つ前の状態にしか戻せませんが、複数の記憶を管理することもできます。
Originatorクラスを単純なものにする
Caretakerクラスに記憶を管理させることで、Originatorクラスを単純にすることができます。
Mementoパターンのオブジェクト指向的要素
「オブジェクト指向的な要素」という視点から見ると、Mementoパターンはちょっと特殊な形をしています。ここでは、「クラスが負う責任」と「APIの公開」について見ていきましょう。
まずは、クラスが負う責任についてです。Mementoパターンでは、記憶オブジェクトを作るOriginatorクラスと、それを管理するCaretakerクラスが分かれています。一見、同じクラスで実装してしまっても問題がなさそうに見えます。
では、それぞれのクラスが負っている責任を見てみましょう。
Originatorクラスの責任は、Mementoクラスのインスタンスを生成することと、Mementoオブジェクトから自分の状態を元に戻すことです。
一方、Caretakerクラスの責任は、Mementoオブジェクトを管理することです。また、いつ記憶を取るか、いつ記憶を戻すかを決めます。
このように「クラスが負う責任」ごとに分けておくと、「記憶を複数保存したい」とか「記憶の保存方式を変更したい」といった場合、Caretakerクラスの変更だけで済むようになります。また、記憶として保存したい情報が増えた場合は、Caretakerクラスの週性は必要ありません。
次に「APIの公開」について見ていきましょう。
Mementoパターンでは、どのクラスが「記憶」にアクセスできるか、またそれをどのように保証するかが重要になります。本来のMementoパターンでは、Mementoクラスは2種類のアクセス制御を行います。1つは、インスタンス化や内部情報へのアクセスを許可しない「narrowインターフェース」、もう1つは、それらを許可する「wideインターフェース」で、記憶を作るOriginatorクラスだけに公開します。
これを実装するには、言語でサポートされているアクセス制御の機構を使うことになります。PHPではバージョン5以降、メソッドやメンバ変数に対してアクセス権を設定できるようになりましたが、特定のクラスに対してのみwideインターフェースを公開することは難しいです。
このため、OriginatorクラスとMementoクラスに継承関係を作り、すべてのwideインターフェースをprotectedメソッドとして定義することで、Originatorクラスだけにwideインターフェースを公開することができます。
ちなみに、C++では特定のクラスどうしを「フレンドクラス」として定義することで、実装できます。また、JavaではPHP5のアクセス権に加え、「パッケージ」の範囲を対象とするアクセス権があります。OriginatorクラスとMementoクラスを同じパッケージとすることで、実装することができます。
関連するパターン
Decoratorパターン
Mementoパターンと良く併用されるパターンです。
まとめ
ここではオブジェクトの記憶を保存したり復元したりするMementoパターンについて見てきました。
|