设计模式（13）备忘录模式

1 备忘录模式简介

@1 备忘录模式

属于行为型模式。它保存一个对象的某个状态，以便在适当的时候恢复对象。有点像我们常说的“后悔药”。注意：

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

@2 4W1H 模型解读备忘录模式

• why 备忘录模式的意图：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。主要是在需要保存/恢复数据的相关状态场景下提供一个可回滚的操作。主要应用场景和案例为：
  • 后悔药。
  • 打游戏时的存档。
  • Windows 里的 ctri + z 以及浏览器中的后退。
  • 数据库的事务管理。
• what 主要解决：所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。
• when/where 何时使用：很多时候我们总是需要记录一个对象的内部状态，这样做的目的就是为了允许用户取消不确定或者错误的操作，能够恢复到他原先的状态，使得他有"后悔药"可吃。
• how 如何解决：通过一个备忘录类专门存储对象状态。

@3 备忘录模式优缺点

优点：

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

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

@4 备忘录模式UML图

2 备忘录模式简单实现（Java）

2.1 Memento类（包含了要被恢复的对象的状态）

代码实现如下：

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

2.2 Originator 类（创建并在 Memento 对象中存储状态）

代码实现如下：

public class Originator {
   private String state;
 
   public void setState(String state){
      this.state = state;
   }
   public String getState(){
      return state;
   }
 
   //保存对象到Memento中并返回该对象
   public Memento saveStateToMemento(){
      return new Memento(state);
   }

   //从Memento对象中获取该对象的状态
   public void getStateFromMemento(Memento Memento){
      state = Memento.getState();
   }
}

2.3 CareTaker 类（负责从 Memento 中恢复对象的状态）

代码实现如下：

import java.util.ArrayList;
import java.util.List;
 
public class CareTaker {
   //创建一个保存Memento对象集的ArrayList列表
   private List<Memento> mementoList = new ArrayList<Memento>();
 
   //链表中添加Memento对象
   public void add(Memento state){
      mementoList.add(state);
   }
 
   //链表中通过index获取Memento对象
   public Memento get(int index){
      return mementoList.get(index);
   }
}

2.4 demo测试类

这里使用 CareTaker 和 Originator 对象来显示对象的状态恢复，代码实现如下：

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");
      //通过上面两次状态设置当前状态为为#2，将其添加到careTaker内部链表中，index=0。
      careTaker.add(originator.saveStateToMemento());
      originator.setState("State #3");
      //再次设置状态为#3，将其添加到careTaker内部链表中，index=1。
      careTaker.add(originator.saveStateToMemento());

      originator.setState("State #4");
      //当前状态最近被设置为4，因此输出为4.
      System.out.println("Current State: " + originator.getState());
      //获取index为0的元素并输出，状态为#2
      originator.getStateFromMemento(careTaker.get(0));
      System.out.println("First saved State: " + originator.getState());

      //获取index为1的元素并输出，状态为#3
      originator.getStateFromMemento(careTaker.get(1));
      System.out.println("Second saved State: " + originator.getState());
   }
}