详解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恢复等。