设计模式之备忘录模式

 备忘录模式(Memento Pattern)：在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。它是一种对象行为型模式，其别名为Token。

实现原理：依赖、关联关系

在备忘录模式结构图中包含如下几个角色：

      ● Originator（原发器）：它是一个普通类，可以创建一个备忘录，并存储它的当前内部状态，也可以使用备忘录来恢复其内部状态，一般将需要保存内部状态的类设计为原发器。

      ●Memento（备忘录)：存储原发器的内部状态，根据原发器来决定保存哪些内部状态。备忘录的设计一般可以参考原发器的设计，根据实际需要确定备忘录类中的属性。需要注意的是，除了原发器本身与负责人类之外，备忘录对象不能直接供其他类使用，原发器的设计在不同的编程语言中实现机制会有所不同。

      ●Caretaker（负责人）：负责人又称为管理者，它负责保存备忘录，但是不能对备忘录的内容进行操作或检查。在负责人类中可以存储一个或多个备忘录对象，它只负责存储对象，而不能修改对象，也无须知道对象的实现细节。

      理解备忘录模式并不难，但关键在于如何设计备忘录类和负责人类。
 

主要优点

      (1)它提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用暂时存储起来的备忘录将状态复原。

      (2)备忘录实现了对信息的封装，一个备忘录对象是一种原发器对象状态的表示，不会被其他代码所改动。备忘录保存了原发器的状态，采用列表、堆栈等集合来存储备忘录对象可以实现多次撤销操作。

主要缺点

      资源消耗过大，如果需要保存的原发器类的成员变量太多，就不可避免需要占用大量的存储空间，每保存一次对象的状态都需要消耗一定的系统资源。

适用场景

      (1)保存一个对象在某一个时刻的全部状态或部分状态，这样以后需要时它能够恢复到先前的状态，实现撤销操作。

      (2)防止外界对象破坏一个对象历史状态的封装性，避免将对象历史状态的实现细节暴露给外界对象。
 

c++代码例子

void TestMementoPattern()
{
	static int index = -1; //定义一个索引来记录当前状态所在位置
	Caretaker *pmc = new Caretaker();
	Originator *pchess = new Originator("车", 1, 1);
	play(pchess, pmc, index);
	pchess->setY(4);
	play(pchess, pmc, index);
	pchess->setX(5);
	play(pchess, pmc, index);
	undo(pchess, pmc, index);
	undo(pchess, pmc, index);
	redo(pchess, pmc, index);
	redo(pchess, pmc, index);

	if (pmc)
	{
		delete pmc;
	}
	if (pchess)
	{
		delete pchess;
	}

}

#pragma once
class CMementoPattern
{
public:
	CMementoPattern();
	~CMementoPattern();
};

//#pragma once
#include <string>
#include <afxtempl.h>
using namespace std;


//象棋棋子备忘录类：备忘录
class Memento {
private:
	string m_label;
	int m_x;
	int m_y;

public:
	Memento() {}
	Memento(string label, int x, int y) {
		m_label = label;
		m_x = x;
		m_y = y;
	}

	void setLabel(string label) {
		m_label = label;
	}

	void setX(int x) {
		m_x = x;
	}

	void setY(int y) {
		m_y = y;
	}

	string getLabel() {
		return m_label;
	}

	int getX() {
		return m_x;
	}

	int getY() {
		return m_y;
	}
};


//象棋棋子类：原发器
class Originator
{
private:
	string m_label;
	int m_x;
	int m_y;

public:
	Originator(string label, int x, int y) {
		m_label = label;
		m_x = x;
		m_y = y;
	}

	void setLabel(string label) {
		m_label = label;
	}

	void setX(int x) {
		m_x = x;
	}

	void setY(int y) {
		m_y = y;
	}

	string getLabel() {
		return m_label;
	}

	int getX() {
		return m_x;
	}

	int getY() {
		return m_y;
	}

	//保存状态
	Memento save() {
		Memento men(m_label, m_x, m_y);
		return  men;
	}

	//恢复状态
	void restore(Memento memento) {
		m_label = memento.getLabel();
		m_x = memento.getX();
		m_y = memento.getY();
	}



};



//象棋棋子备忘录管理类：负责人
class Caretaker
{
private:
	CArray <Memento, Memento&> mementoArray;
public:
	Memento getMemento(int nIndex) {
		return mementoArray.GetAt(nIndex);
	}

	void setMemento(Memento memento) {
		mementoArray.Add(memento);
	}
};


//下棋
static void play(Originator *pchess, Caretaker *pCaretaker, int &nIndex) {
	TRACE("******下棋******\n");
	pCaretaker->setMemento(pchess->save()); //撤销到上一个备忘录	
	TRACE("棋子%s第%d步当前位置为：第%d行 第%d列\n", pchess->getLabel().c_str(), ++nIndex, pchess->getX(), pchess->getY());
}


//悔棋
static void undo(Originator *pchess, Caretaker *pCaretaker, int &nIndex) {
	TRACE("******悔棋******\n");
	nIndex--;
	pchess->restore(pCaretaker->getMemento(nIndex)); //撤销到上一个备忘录
	TRACE("棋子%s 当前位置为：第%d行 第%d列\n", pchess->getLabel().c_str(), pchess->getX(), pchess->getY());
}

//撤销悔棋
static void redo(Originator *pchess, Caretaker *pCaretaker, int &nIndex) {
	TRACE("******撤销悔棋******\n");
	nIndex++;
	pchess->restore(pCaretaker->getMemento(nIndex));
	TRACE("棋子%s 当前位置为：第%d行 第%d列\n", pchess->getLabel().c_str(), pchess->getX(), pchess->getY());
}

d:\study\c++ pattern\pattern\pattern\mementopattern.h(132) : atlTraceGeneral - ******下棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(134) : atlTraceGeneral - 棋子车第0步当前位置为：第1行 第1列
d:\study\c++ pattern\pattern\pattern\mementopattern.h(132) : atlTraceGeneral - ******下棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(134) : atlTraceGeneral - 棋子车第1步当前位置为：第1行 第4列
d:\study\c++ pattern\pattern\pattern\mementopattern.h(132) : atlTraceGeneral - ******下棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(134) : atlTraceGeneral - 棋子车第2步当前位置为：第5行 第4列
d:\study\c++ pattern\pattern\pattern\mementopattern.h(140) : atlTraceGeneral - ******悔棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(143) : atlTraceGeneral - 棋子车 当前位置为：第1行 第4列
d:\study\c++ pattern\pattern\pattern\mementopattern.h(140) : atlTraceGeneral - ******悔棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(143) : atlTraceGeneral - 棋子车 当前位置为：第1行 第1列
d:\study\c++ pattern\pattern\pattern\mementopattern.h(148) : atlTraceGeneral - ******撤销悔棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(151) : atlTraceGeneral - 棋子车 当前位置为：第1行 第4列
d:\study\c++ pattern\pattern\pattern\mementopattern.h(148) : atlTraceGeneral - ******撤销悔棋******
d:\study\c++ pattern\pattern\pattern\mementopattern.h(151) : atlTraceGeneral - 棋子车 当前位置为：第5行 第4列