設計模式---備忘錄模式

一. 概述

1. 備忘錄模式（Memento Pattern）在不破壞封裝性的前提下，捕獲一個對象的內部狀態，並在該對象之外保存這個狀態。這樣以後就可將該對象恢復到原先保存的狀態。
2. 可以這樣理解備忘錄模式：現實生活中的備忘錄是用來記錄某些要去做的事情，或者是記錄已經達成的共同意見的事情，以防忘記了。而在軟件層面，備忘錄模式有着相同的含義，備忘錄對象主要用來記錄一個對象的某種狀態，或者某些數據，當要做回退時，可以從備忘錄對象裏獲取原來的數據進行恢復操作。
3. 備忘錄模式屬於行爲型模式。

• 原理類圖：
  

1. originator : 對象(需要保存狀態的對象)
2. Memento ： 備忘錄對象,負責保存好記錄，即Originator內部狀態
3. Caretaker: 守護者對象,負責保存多個備忘錄對象， 使用集合管理，提高效率
4. 說明：如果希望保存多個originator對象的不同時間的狀態，也可以，只需要 HashMap <String, 集合>

• 代碼演示：

public class Memento {
	private String state;

	public Memento(String state) {
		super();
		this.state = state;
	}

	public String getState() {
		return state;
	}
}

public class Originator {
	private String state;//狀態信息
	public String getState() {
		return state;
	}

	public void setState(String state) {
		this.state = state;
	}
	
	//編寫一個方法，可以保存一個狀態對象 Memento
	public Memento saveStateMemento() {
		return new Memento(state);
	}
	
	//通過備忘錄對象，恢復狀態
	public void getStateFromMemento(Memento memento) {
		state = memento.getState();
	}
}

public class Caretaker {
	//在List 集合中會有很多的備忘錄對象
	private List<Memento> mementoList = new ArrayList<>();
	
	public void add(Memento memento) {
		mementoList.add(memento);
	}
	
	//獲取到第index個Originator 的 備忘錄對象(即保存狀態)
	public Memento get(int index) {
		return mementoList.get(index);
	}
}

public class Client {
	public static void main(String[] args) {
		Originator originator = new Originator();
		Caretaker caretaker = new Caretaker();
		
		originator.setState(" 狀態#1 攻擊力 100 ");
		//保存了當前的狀態
		caretaker.add(originator.saveStateMemento());
		originator.setState(" 狀態#2 攻擊力 80 ");
		caretaker.add(originator.saveStateMemento());
		originator.setState(" 狀態#3 攻擊力 50 ");
		caretaker.add(originator.saveStateMemento());

		System.out.println("當前的狀態是 =" + originator.getState());
		
		//希望得到狀態 1, 將 originator 恢復到狀態1
		originator.getStateFromMemento(caretaker.get(0));
		System.out.println("恢復到狀態1 , 當前的狀態是");
		System.out.println("當前的狀態是 =" + originator.getState());
	}
}

二. 場景示例

• 遊戲角色恢復狀態實例
  遊戲角色有攻擊力和防禦力，在大戰Boss前保存自身的狀態(攻擊力和防禦力)，當大戰Boss後攻擊力和防禦力下降，從備忘錄對象恢復到大戰前的狀態。
• 思路分析圖解：
  
• 代碼實現：

public class Memento {
	//攻擊力
	private int vit;
	//防禦力
	private int def;
	public Memento(int vit, int def) {
		super();
		this.vit = vit;
		this.def = def;
	}
	public int getVit() {
		return vit;
	}
	public void setVit(int vit) {
		this.vit = vit;
	}
	public int getDef() {
		return def;
	}
	public void setDef(int def) {
		this.def = def;
	}
}

public class GameRole {
	private int vit;
	private int def;
	//創建Memento ,即根據當前的狀態得到Memento
	public Memento createMemento() {
		return new Memento(vit, def);
	}
	
	//從備忘錄對象，恢復GameRole的狀態
	public void recoverGameRoleFromMemento(Memento memento) {
		this.vit = memento.getVit();
		this.def = memento.getDef();
	}
	
	//顯示當前遊戲角色的狀態
	public void display() {
		System.out.println("遊戲角色當前的攻擊力：" + this.vit + " 防禦力: " + this.def);
	}

	public int getVit() {
		return vit;
	}
	public void setVit(int vit) {
		this.vit = vit;
	}
	public int getDef() {
		return def;
	}
	public void setDef(int def) {
		this.def = def;
	}
}

//守護者對象, 保存遊戲角色的狀態
public class Caretaker {
	//如果只保存一次狀態
	private Memento  memento;
	//對GameRole 保存多次狀態
	//private ArrayList<Memento> mementos;
	//對多個遊戲角色保存多個狀態
	//private HashMap<String, ArrayList<Memento>> rolesMementos;
	public Memento getMemento() {
		return memento;
	}
	public void setMemento(Memento memento) {
		this.memento = memento;
	}
}

public class Client {
	public static void main(String[] args) {
		//創建遊戲角色
		GameRole gameRole = new GameRole();
		gameRole.setVit(100);
		gameRole.setDef(100);
		
		System.out.println("和boss大戰前的狀態");
		gameRole.display();
		
		//把當前狀態保存caretaker
		Caretaker caretaker = new Caretaker();
		caretaker.setMemento(gameRole.createMemento());
		
		System.out.println("和boss大戰~~~");
		gameRole.setDef(30);
		gameRole.setVit(30);
		
		gameRole.display();
		
		System.out.println("大戰後，使用備忘錄對象恢復到站前");
		
		gameRole.recoverGameRoleFromMemento(caretaker.getMemento());
		System.out.println("恢復後的狀態");
		gameRole.display();
	}
}

三. 備忘錄模式的注意事項和細節

1. 給用戶提供了一種可以恢復狀態的機制，可以使用戶能夠比較方便地回到某個歷史的狀態
2. 實現了信息的封裝，使得用戶不需要關心狀態的保存細節
3. 如果類的成員變量過多，勢必會佔用比較大的資源，而且每一次保存都會消耗一定
   的內存, 這個需要注意
4. 適用的應用場景：1、後悔藥。 2、打遊戲時的存檔。 3、Windows 裏的 ctri+ z 4、IE 中的後退。 4、數據庫的事務管理
5. 爲了節約內存，備忘錄模式可以和原型模式配合使用