备忘录模式（Memento Pattern）- PHP示例

备忘录模式（Memento Pattern）

备忘录模式（Memento Pattern）保存一个对象的某个状态，以便在适当的时候恢复对象。

• 意图：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。

• 主要解决：所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。

• 何时使用：很多时候我们总是需要记录一个对象的内部状态，这样做的目的就是为了允许用户取消不确定或者错误的操作，能够恢复到他原先的状态，使得他有"后悔药"可吃。

• 如何解决：通过一个备忘录类专门存储对象状态。

• 关键代码：客户不与备忘录类耦合，与备忘录管理类耦合。

• 应用实例： 1、后悔药。 2、打游戏时的存档。 3、Windows 里的 ctri + z。 4、IE 中的后退。 4、数据库的事务管理。

• 优点： 1、给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态。 2、实现了信息的封装，使得用户不需要关心状态的保存细节。

• 缺点：消耗资源。如果类的成员变量过多，势必会占用比较大的资源，而且每一次保存都会消耗一定的内存。

• 使用场景： 1、需要保存/恢复数据的相关状态场景。 2、提供一个可回滚的操作。

• 注意事项： 1、为了符合迪米特原则，还要增加一个管理备忘录的类。 2、为了节约内存，可使用原型模式+备忘录模式。

示例代码：

<?php

// 相当于一条备忘记录
class Memento{
	private $state;
	
	function __construct($state){
		$this->state = $state;
	}
	
	function getState(){
		return $this->state;
	}
}

class Originator{
	private $state;
	
	function setState($state){
		$this->state = $state;
	}
	
	function getState(){
		return $this->state;
	}
	
	function save2memento(){
		// 保存状态设为创建一个Memento对象
		return new Memento($this->state);
	}
	
	function restoreMemento($memento){
		$this->state = $memento->getState();
	}
}

// 为了符合迪米特原则，增加一个管理备忘录的类。相当于一个备忘记录表
class CareTaker{	
	private $mementoList=[];
	
	function addMemento($mementoState){
		array_push($this->mementoList, $mementoState);
	}
	
	function pullMemento($step = 1){
		if(sizeof($this->mementoList) > $step){
			$ret_memento = '';

			for($i = 0; $i < $step; $i++){
				array_pop($this->mementoList); // 扔掉上面弃用的状态
			}

			return $this->mementoList[sizeof($this->mementoList) - 1];
		}

		//退到最初始状态
		return $this->mementoList[0];
	}
}

function main(){
	$originator = new Originator;
	$careTaker = new CareTaker;

	$originator->setState('state #1');
	echo 'Current State: ', $originator->getState(), PHP_EOL; 

	//过程：Originator设置state，把state保存到Memento，
	//把Memento加入到CareTaker队列
	$careTaker->addMemento($originator->save2memento());		

	$originator->setState('state #2');
	echo 'Current State: ', $originator->getState(), PHP_EOL; 
	$careTaker->addMemento($originator->save2memento());

	$originator->setState('state #3');
	echo 'Current State: ', $originator->getState(), PHP_EOL; 
	$careTaker->addMemento($originator->save2memento());

	//从CareTaker中获取Memento对象，把该Memento对象的状态
	//赋给Originator
	// $originator->restoreMemento($careTaker->pullMemento());
	$originator->restoreMemento($careTaker->pullMemento(2));

	echo 'Current State: ', $originator->getState(), PHP_EOL; 

	$originator->setState('state #4');
	echo 'Current State: ', $originator->getState(), PHP_EOL; 
	$careTaker->addMemento($originator->save2memento());
}main();

结果显示：

Current State: state #1
Current State: state #2
Current State: state #3
Current State: state #1
Current State: state #4