第 22 章 備忘錄模式

1、遊戲角色狀態恢復問題

遊戲角色有攻擊力和防禦力，在大戰Boss前儲存自身的狀態(攻擊力和防禦力)， 當大戰Boss後攻擊力和防禦力下降， 然後從備忘錄物件恢復到大戰前的狀態

2、傳統方案解決遊戲角色恢復

類圖

傳統的方式的問題分析

1. 一個物件，就對應一個儲存物件狀態的物件， 這樣當我們遊戲的物件很多時，不利於管理，開銷也很大
2. 傳統的方式是簡單地做備份， new 出另外一個物件出來，再把需要備份的資料放到這個新物件，但這就暴露了物件內部的細節
3. 解決方案： ==> 備忘錄模式

3、備忘錄模式基本介紹

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

4、備忘錄模式原理類圖

類圖

1. Originator ：物件(需要儲存狀態的物件)
2. Memento ：備忘錄物件，負責儲存好記錄， 即 Originator 內部狀態
3. Caretaker：守護者物件，負責儲存多個備忘錄物件， 使用集合管理， 提高效率
4. 說明：如果希望儲存多個 Originator 物件的不同時間的狀態，只需要使用 HashMap <String, Collection> 儲存即可，String 為 Originator 物件的唯一標識(key)，Collection 為 Originator 物件不同時間的備忘錄集合

程式碼實現

1. Originator：實體類，該類的例項為需要儲存狀態的物件，saveStateMemento() 方法用於返回一個備忘錄物件，getStateFromMemento() 方法用於從備忘錄

   public class Originator {
   
   	private String state;// 狀態資訊
   
   	public String getState() {
   		return state;
   	}
   
   	public void setState(String state) {
   		this.state = state;
   	}
   
   	// 編寫一個方法，可以儲存一個狀態物件 Memento
   	// 因此編寫一個方法，返回 Memento
   	public Memento saveStateMemento() {
   		return new Memento(state);
   	}
   
   	// 通過備忘錄物件，恢復狀態
   	public void getStateFromMemento(Memento memento) {
   		state = memento.getState();
   	}
   }
   

2. Memento：備忘錄物件，負責儲存物件的狀態

   public class Memento {
   	private String state;
   
   	// 構造器
   	public Memento(String state) {
   		this.state = state;
   	}
   
   	public String getState() {
   		return state;
   	}
   
   }
   

3. Caretker：聚合了備忘錄的集合，即 List<Memento>

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

4. Client：測試程式碼

   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());
   
   	}
   
   }
   

5、備忘錄模式解決遊戲角色恢復

應用例項

遊戲角色有攻擊力和防禦力，在大戰Boss前儲存自身的狀態(攻擊力和防禦力)， 當大戰Boss後攻擊力和防禦力下降， 然後從備忘錄物件恢復到大戰前的狀態

---

類圖

---

程式碼實現

1. GameRole：遊戲角色對應的實體類，createMemento() 方法用於建立備忘錄物件，recoverGameRoleFromMemento() 用於從備忘錄物件中恢復角色的狀態

   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;
   	}
   
   }
   

2. Memento：備忘錄物件

   public class Memento {
   
   	// 攻擊力
   	private int vit;
   	// 防禦力
   	private int def;
   
   	public Memento(int vit, int def) {
   		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;
   	}
   
   }
   

3. Caretaker：守護者物件，用於管理備忘錄物件

   //守護者物件, 儲存遊戲角色的狀態
   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;
   	}
   
   }
   

4. Client：測試程式碼

   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();
   	}
   
   }
   

6、備忘錄模式的注意事項和細節

1. 給使用者提供了一種可以恢復狀態的機制，可以使使用者能夠比較方便地回到某個歷史的狀態
2. 實現了資訊的封裝，使得使用者不需要關心狀態的儲存細節
3. 如果類的成員變數過多，勢必會佔用比較大的資源，而且每一次儲存都會消耗一定的記憶體，這個需要注意
4. 為了節約記憶體，備忘錄模式可以和原型模式配合使用

---

適用的應用場景：

1. 後悔藥
2. 打遊戲時的存檔
3. Windows 裡的 Ctrl + Z。
4. IE 中的後退
5. 資料庫的事務管理