23種設計模式之備忘錄模式

定義：在不破壞封裝性的前提下，捕獲一個物件的內部狀態，並在該物件之外儲存這個狀態。這樣就可以將該物件恢復到原先儲存的狀態

型別：行為類

類圖：

我們在程式設計的時候，經常需要儲存物件的中間狀態，當需要的時候，可以恢復到這個狀態。比如，我們使用Eclipse進行程式設計時，假如編寫失誤（例如不小心誤刪除了幾行程式碼），我們希望返回刪除前的狀態，便可以使用Ctrl+Z來進行返回。這時我們便可以使用備忘錄模式來實現。

備忘錄模式的結構

• 發起人：記錄當前時刻的內部狀態，負責定義哪些屬於備份範圍的狀態，負責建立和恢復備忘錄資料。
• 備忘錄：負責儲存發起人物件的內部狀態，在需要的時候提供發起人需要的內部狀態。
• 管理角色：對備忘錄進行管理，儲存和提供備忘錄。

通用程式碼實現

class Originator {
	private String state = "";

	public String getState() {
		return state;
	}
	public void setState(String state) {
		this.state = state;
	}
	public Memento createMemento(){
		return new Memento(this.state);
	}
	public void restoreMemento(Memento memento){
		this.setState(memento.getState());
	}
}

class Memento {
	private String state = "";
	public Memento(String state){
		this.state = state;
	}
	public String getState() {
		return state;
	}
	public void setState(String state) {
		this.state = state;
	}
}
class Caretaker {
	private Memento memento;
	public Memento getMemento(){
		return memento;
	}
	public void setMemento(Memento memento){
		this.memento = memento;
	}
}
public class Client {
	public static void main(String[] args){
		Originator originator = new Originator();
		originator.setState("狀態1");
		System.out.println("初始狀態:"+originator.getState());
		Caretaker caretaker = new Caretaker();
		caretaker.setMemento(originator.createMemento());
		originator.setState("狀態2");
		System.out.println("改變後狀態:"+originator.getState());
		originator.restoreMemento(caretaker.getMemento());
		System.out.println("恢復後狀態:"+originator.getState());
	}
}

程式碼演示了一個單狀態單備份的例子，邏輯非常簡單：Originator類中的state變數需要備份，以便在需要的時候恢復；Memento類中，也有一個state變數，用來儲存Originator類中state變數的臨時狀態；而Caretaker類就是用來管理備忘錄類的，用來向備忘錄物件中寫入狀態或者取回狀態。

多狀態多備份備忘錄

通用程式碼演示的例子中，Originator類只有一個state變數需要備份，而通常情況下，發起人角色通常是一個javaBean，物件中需要備份的變數不止一個，需要備份的狀態也不止一個，這就是多狀態多備份備忘錄。實現備忘錄的方法很多，備忘錄模式有很多變形和處理方式，像通用程式碼那樣的方式一般不會用到，多數情況下的備忘錄模式，是多狀態多備份的。其實實現多狀態多備份也很簡單，最常用的方法是，我們在Memento中增加一個Map容器來儲存所有的狀態，在Caretaker類中同樣使用一個Map容器才儲存所有的備份。下面我們給出一個多狀態多備份的例子：

class Originator {
	private String state1 = "";
	private String state2 = "";
	private String state3 = "";

	public String getState1() {
		return state1;
	}
	public void setState1(String state1) {
		this.state1 = state1;
	}
	public String getState2() {
		return state2;
	}
	public void setState2(String state2) {
		this.state2 = state2;
	}
	public String getState3() {
		return state3;
	}
	public void setState3(String state3) {
		this.state3 = state3;
	}
	public Memento createMemento(){
		return new Memento(BeanUtils.backupProp(this));
	}

	public void restoreMemento(Memento memento){
		BeanUtils.restoreProp(this, memento.getStateMap());
	}
	public String toString(){
		return "state1="+state1+"state2="+state2+"state3="+state3;
	}
}
class Memento {
	private Map<String, Object> stateMap;

	public Memento(Map<String, Object> map){
		this.stateMap = map;
	}

	public Map<String, Object> getStateMap() {
		return stateMap;
	}

	public void setStateMap(Map<String, Object> stateMap) {
		this.stateMap = stateMap;
	}
}
class BeanUtils {
	public static Map<String, Object> backupProp(Object bean){
		Map<String, Object> result = new HashMap<String, Object>();
		try{
			BeanInfo beanInfo = Introspector.getBeanInfo(bean.getClass());
			PropertyDescriptor[] descriptors = beanInfo.getPropertyDescriptors();
			for(PropertyDescriptor des: descriptors){
				String fieldName = des.getName();
				Method getter = des.getReadMethod();
				Object fieldValue = getter.invoke(bean, new Object[]{});
				if(!fieldName.equalsIgnoreCase("class")){
					result.put(fieldName, fieldValue);
				}
			}

		}catch(Exception e){
			e.printStackTrace();
		}
		return result;
	}

	public static void restoreProp(Object bean, Map<String, Object> propMap){
		try {
			BeanInfo beanInfo = Introspector.getBeanInfo(bean.getClass());
			PropertyDescriptor[] descriptors = beanInfo.getPropertyDescriptors();
			for(PropertyDescriptor des: descriptors){
				String fieldName = des.getName();
				if(propMap.containsKey(fieldName)){
					Method setter = des.getWriteMethod();
					setter.invoke(bean, new Object[]{propMap.get(fieldName)});
				}
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}
}
class Caretaker {
	private Map<String, Memento> memMap = new HashMap<String, Memento>();
	public Memento getMemento(String index){
		return memMap.get(index);
	}

	public void setMemento(String index, Memento memento){
		this.memMap.put(index, memento);
	}
}
class Client {
	public static void main(String[] args){
		Originator ori = new Originator();
		Caretaker caretaker = new Caretaker();
		ori.setState1("中國");
		ori.setState2("強盛");
		ori.setState3("繁榮");
		System.out.println("===初始化狀態===/n"+ori);

		caretaker.setMemento("001",ori.createMemento());
		ori.setState1("軟體");
		ori.setState2("架構");
		ori.setState3("優秀");
		System.out.println("===修改後狀態===/n"+ori);

		ori.restoreMemento(caretaker.getMemento("001"));
		System.out.println("===恢復後狀態===/n"+ori);
	}
}

備忘錄模式的優缺點和適用場景

備忘錄模式的優點有：

• 當發起人角色中的狀態改變時，有可能這是個錯誤的改變，我們使用備忘錄模式就可以把這個錯誤的改變還原。
• 備份的狀態是儲存在發起人角色之外的，這樣，發起人角色就不需要對各個備份的狀態進行管理。

備忘錄模式的缺點：

• 在實際應用中，備忘錄模式都是多狀態和多備份的，發起人角色的狀態需要儲存到備忘錄物件中，對資源的消耗是比較嚴重的。

如果有需要提供回滾操作的需求，使用備忘錄模式非常適合，比如jdbc的事務操作，文字編輯器的Ctrl+Z恢復等。