20-Java备忘录模式 ( Memento Pattern )

• 备忘录模式（Memento Pattern）保存一个对象的某个状态，以便在适当的时候恢复对象

• 备忘录模式属于行为型模式

摘要

1. 意图

• 在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态

2. 主要解决

• 所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态

3. 何时使用

• 很多时候我们总是需要记录一个对象的内部状态，这样做的目的就是为了允许用户取消不确定或者错误的操作，能够恢复到他原先的状态，使得他有”后悔药”可吃

4. 如何解决

• 通过一个备忘录类专门存储对象状态

5. 关键代码

• 客户不与备忘录类耦合，与备忘录管理类耦合

6. 应用实例

• 后悔药；
• 打游戏时的存档；
• Windows里的ctri+z；
• IE中的后退；
• 数据库的事务管理；

7. 优点

• 给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态；
• 实现了信息的封装，使得用户不需要关心状态的保存细节；

8. 缺点

• 消耗资源
  如果类的成员变量过多，势必会占用比较大的资源，而且每一次保存都会消耗一定的内存

9. 使用场景

• 需要保存/恢复数据的相关状态场景；
• 提供一个可回滚的操作；

10. 注意事项

• 为了符合迪米特原则，还要增加一个管理备忘录的类；
• 为了节约内存，可使用原型模式+备忘录模式；

实现

备忘录模式使用三个类 Memento 、 Originator 和 CareTaker

1. 定义类Memento包含了要被恢复的对象的状态；
2. 定义类Originator创建并在Memento对象中存储状态；
3. 定义类Caretaker对象负责从Memento中恢复对象的状态；
4. 最后使用MementoPatternDemo类使用CareTaker和Originator对象来显示对象的状态恢复；

范例

1. 创建 Memento 类

Memento.java

package com.demo.gof;
public class Memento {
   private String state;

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

   public String getState(){
      return state;
   }    
}
1
2
3
4
5
6
7
8
9
10
11
12

2. 创建 Originator 类

Originator.java

package com.demo.gof;
public class Originator {
   private String state;

   public void setState(String state){
      this.state = state;
   }

   public String getState(){
      return state;
   }

   public Memento saveStateToMemento(){
      return new Memento(state);
   }

   public void getStateFromMemento(Memento Memento){
      state = Memento.getState();
   }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

3. 创建 CareTaker 类

CareTaker.java

package com.demo.gof;
import java.util.ArrayList;
import java.util.List;

public class CareTaker {
   private List<Memento> mementoList = new ArrayList<Memento>();

   public void add(Memento state){
      mementoList.add(state);
   }

   public Memento get(int index){
      return mementoList.get(index);
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

4. 使用 CareTaker 和 Originator 对象

MementoPatternDemo.java

package com.demo.gof;
public class MementoPatternDemo {
   public static void main(String[] args) {
      Originator originator = new Originator();
      CareTaker careTaker = new CareTaker();
      originator.setState("State #1");
      originator.setState("State #2");
      careTaker.add(originator.saveStateToMemento());
      originator.setState("State #3");
      careTaker.add(originator.saveStateToMemento());
      originator.setState("State #4");

      System.out.println("Current State: " + originator.getState());        
      originator.getStateFromMemento(careTaker.get(0));
      System.out.println("First saved State: " + originator.getState());
      originator.getStateFromMemento(careTaker.get(1));
      System.out.println("Second saved State: " + originator.getState());
   }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

编译运行以上 Java 范例，输出结果如下

$ javac -d . src/main/com.demo/gof/MementoPatternDemo.java
$ java  com.demo.gof.MementoPatternDemo
Current State: State #4
First saved State: State #2
Second saved State: State #3
1
2
3
4
5