设计模式20---设计模式之备忘录模式（Memento）（行为型）

1.讲解备忘录模式

备忘录模式（Memento Pattern）又叫做快照模式（Snapshot Pattern）或Token模式，是GoF的23种设计模式之一，属于行为模式。

1.1定义

在不破坏封闭的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态。

1.2涉及角色

1.Originator(发起人)：负责创建一个备忘录Memento，用以记录当前时刻自身的内部状态，并可使用备忘录恢复内部状态。Originator可以根据需要决定Memento存储自己的哪些内部状态。
2.Memento(备忘录)：负责存储Originator对象的内部状态，并可以防止Originator以外的其他对象访问备忘录。备忘录有两个接口：Caretaker只能看到备忘录的窄接口，他只能将备忘录传递给其他对象。Originator却可看到备忘录的宽接口，允许它访问返回到先前状态所需要的所有数据。
3.Caretaker(管理者):负责备忘录Memento，不能对Memento的内容进行访问或者操作。

1.3备忘录模式的优点和缺点

一、备忘录模式的优点
1、有时一些发起人对象的内部信息必须保存在发起人对象以外的地方，但是必须要由发起人对象自己读取，这时，
使用备忘录模式可以把复杂的发起人内部信息对其他的对象屏蔽起来，从而可以恰当地保持封装的边界。
2、本模式简化了发起人类。发起人不再需要管理和保存其内部状态的一个个版本，客户端可以自行管理他们所需
要的这些状态的版本。
3、当发起人角色的状态改变的时候，有可能这个状态无效，这时候就可以使用暂时存储起来的备忘录将状态复原。
二、备忘录模式的缺点：
1、如果发起人角色的状态需要完整地存储到备忘录对象中，那么在资源消耗上面备忘录对象会很昂贵。
2、当负责人角色将一个备忘录 存储起来的时候，负责人可能并不知道这个状态会占用多大的存储空间，从而无法提醒用户一个操作是否很昂贵。
3、当发起人角色的状态改变的时候，有可能这个协议无效。如果状态改变的成功率不高的话，不如采取“假如”协议模式。 

1.4备忘录模式本质

保存和恢复内部状态

1.5备忘录模式的结构 

1.6通用代码

package demo18.memento.example1;


/**
 * 备忘录的窄接口，没有任何方法定义
 */
public interface Memento {


}
**********************************************************************************************
package demo18.memento.example1;


/**
 * 原发器对象
 */
public class Originator {
	/**
	 * 示意，表示原发器的状态
	 */
	private String state = "";


	/**
	 * 创建保存原发器对象的状态的备忘录对象
	 * 
	 * @return 创建好的备忘录对象
	 */
	public Memento createMemento() {
		return new MementoImpl(state);
	}


	/**
	 * 重新设置原发器对象的状态，让其回到备忘录对象记录的状态
	 * 
	 * @param memento
	 *        记录有原发器状态的备忘录对象
	 */
	public void setMemento(Memento memento) {
		MementoImpl mementoImpl = (MementoImpl) memento;
		this.state = mementoImpl.getState();
	}


	/**
	 * 真正的备忘录对象，实现备忘录窄接口 实现成私有的内部类，不让外部访问
	 */
	private static class MementoImpl implements Memento {
		/**
		 * 示意，表示需要保存的状态
		 */
		private String state = "";


		public MementoImpl(String state) {
			this.state = state;
		}


		public String getState() {
			return state;
		}
	}


}
***********************************************************************************************
package demo18.memento.example1;


/**
 * 负责保存备忘录的对象
 */
public class Caretaker {
	/**
	 * 记录被保存的备忘录对象
	 */
	private Memento memento = null;


	/**
	 * 保存备忘录对象
	 * 
	 * @param memento
	 *        被保存的备忘录对象
	 */
	public void saveMemento(Memento memento) {
		this.memento = memento;
	}


	/**
	 * 获取被保存的备忘录对象
	 * 
	 * @return 被保存的备忘录对象
	 */
	public Memento retriveMemento() {
		return this.memento;
	}
}

2.举例说明：

以保存游戏进度为例，在游戏角色大战Boss前将该角色的状态存储，与Boss作战后角色的各项能力会下降，如果没有通关，则可利用备忘录进行恢复到战前状态。

21.角色类

package demo18.memento.example2;


public class PlayRole {
	private int vitality;
	private int aggressivity;
	private int defencivity;


	public PlayRole(int vitality, int aggressivity, int defencivity) {
		super();
		this.vitality = vitality;
		this.aggressivity = aggressivity;
		this.defencivity = defencivity;
	}


	public PlayRole() {
	}


	public int getVitality() {
		return vitality;
	}


	public void setVitality(int vitality) {
		this.vitality = vitality;
	}


	public int getAggressivity() {
		return aggressivity;
	}


	public void setAggressivity(int aggressivity) {
		this.aggressivity = aggressivity;
	}


	public int getDefencivity() {
		return defencivity;
	}


	public void setDefencivity(int defencivity) {
		this.defencivity = defencivity;
	}


	public RoleMemento createMemento() {
		RoleMemento memento = new RoleMemento();
		memento.setAggressivity(aggressivity);
		memento.setDefencivity(defencivity);
		memento.setVitality(vitality);
		return memento;
	}


	public void setMemento(RoleMemento memento) {
		this.aggressivity = memento.getAggressivity();
		this.defencivity = memento.getDefencivity();
		this.vitality = memento.getVitality();
	}


	public void showState() {
		System.out.println("攻击力：" + this.aggressivity + "|防御力：" + this.defencivity + "|生命力：" + this.vitality);
	}
}

2.2角色备忘类

package demo18.memento.example2;


public class RoleMemento {
	private int vitality;
	private int aggressivity;
	private int defencivity;


	public int getVitality() {
		return vitality;
	}


	public void setVitality(int vitality) {
		this.vitality = vitality;
	}


	public int getAggressivity() {
		return aggressivity;
	}


	public void setAggressivity(int aggressivity) {
		this.aggressivity = aggressivity;
	}


	public int getDefencivity() {
		return defencivity;
	}


	public void setDefencivity(int defencivity) {
		this.defencivity = defencivity;
	}
}

2.3负责保存备忘录对象

package demo18.memento.example2;


public class Caretaker {
	RoleMemento memento;


	public RoleMemento getMemento() {
		return memento;
	}


	public void setMemento(RoleMemento memento) {
		this.memento = memento;
	}
}

2.4客户端使用

package demo18.memento.example2;


public class Client {
	public static void main(String[] args) {
		// 测试程序
		// 新建角色
		PlayRole role = new PlayRole(100, 100, 100);
		// 新建管理者
		Caretaker taker = new Caretaker();
		// 角色初始状态
		System.out.println("游戏刚开始，角色各属性:");
		role.showState();
		// 利用备忘录模式保存当前状态
		System.out.println("\n【保存游戏状态！】\n");
		taker.setMemento(role.createMemento());
		role.setAggressivity(20);
		role.setDefencivity(30);
		role.setVitality(0);
		// 大战过后，角色能力值下降
		System.out.println("与Boss对战后，角色各项能力已大大下降:");
		role.showState();
		// 恢复保存的角色状态
		role.setMemento(taker.getMemento());
		System.out.println("\n【恢复保存的角色状态！】");
		System.out.println("\n恢复后角色的当前状态：");
		role.showState();
	}
}