詳解Java設計模式之備忘錄模式的使用

定義與結構

備忘錄（Memento）模式又稱標記（Token）模式。 GOF給備忘錄模式的定義為：在不破壞封裝性的前提下，捕獲一個對象的內部狀態，並在該對象之外保存這個狀態。這樣以後就可將該對象恢復到原先保存的狀態。

在講命令模式的時候，我們曾經提到利用中間的命令角色可以實現undo、redo的功能。從定義可以看出備忘錄模式是專門來存放對象歷史狀態的，這對於很好的實現undo、redo功能有很大的幫助。所以在命令模式中undo、redo功能可以配合備忘錄模式來實現。

其實單就實現保存一個對像在某一時刻的狀態的功能，還是很簡單的――將對像中要保存的屬性放到一個專門管理備份的對像中，需要的時候則調用約定好的方法將備份的屬性放回到原來的對像中去。但是你要好好看看為了能讓你的備份對象訪問到原對像中的屬性，是否意味著你就要全部公開或者包內公開對象原本私有的屬性呢？如果你的做法已經破壞了封裝，那麼就要考慮重構一下了。

備忘錄模式只是GOF對“恢復對象某時的原有狀態”這一問題提出的通用方案。因此在如何保持封裝性上――由於受到語言特性等因素的影響，備忘錄模式並沒有詳細描述，只是基於C++闡述了思路。

1) 備忘錄（Memento）角色：備忘錄角色存儲“備忘發起角色”的內部狀態。 “備忘發起角色”根據需要決定備忘錄角色存儲“備忘發起角色”的哪些內部狀態。為了防止“備忘發起角色”以外的其他對象訪問備忘錄。備忘錄實際上有兩個接口，“備忘錄管理者角色”只能看到備忘錄提供的窄接口――對於備忘錄角色中存放的屬性是不可見的。 “備忘發起角色”則能夠看到一個寬接口――能夠得到自己放入備忘錄角色中屬性。

2) 備忘發起（Originator）角色：“備忘發起角色”創建一個備忘錄，用以記錄當前時刻它的內部狀態。在需要時使用備忘錄恢復內部狀態。

3) 備忘錄管理者（Caretaker）角色：負責保存好備忘錄。不能對備忘錄的內容進行操作或檢查。

備忘錄模式的類圖真是再簡單不過了：

通用代碼實現

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恢復等。