备忘录模式.md

Java设计模式 ———— 备忘录模式

一、介绍

意图

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

主要解决

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

何时使用

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

如何解决

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

关键代码

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

应用实例

1、后悔药。

2、打游戏时的存档。

3、Windows 里的 ctrl + z。

4、IE 中的后退。

5、数据库的事务管理。

注意事项

1、为了符合迪米特原则，还要增加一个管理备忘录的类。

2、为了节约内存，可使用原型模式+备忘录模式。

二、优缺点

优点

1、给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态。

2、实现了信息的封装，使得用户不需要关心状态的保存细节。

缺点

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

三、使用场景

1、需要保存/恢复数据的相关状态场景。

2、提供一个可回滚的操作。

四、实现

创建备忘录 Memento 类。

@Setter
@Getter
@AllArgsConstructor
public class Memento {
   private String state; 
}

创建发起者 Originator，发起者通过创建一个新的备忘录对象来保存自己的内部状态。

@Setter
@Getter
@AllArgsConstructor
public class Originator {
   private String state;
 
   // 创建备忘 
   public Memento createMemento(){
      return new Memento(state);
   }
   
   // 从备忘恢复
   public void restoreFromMemento(Memento Memento){
      state = Memento.getState();
   }
}

创建备忘录管理者 Caretaker ，负责保存备忘录对象，但是从不修改（甚至不查看）备忘录对象的内容。

public class Caretaker {
   private Map<String, Memento> map = new HashMap<>();
 
   // 存储备份
   public String addMemento(Memento memento) {
       String uuid = UUID.randomUUID().toString().replace("-", "");
       map.put(uuid, memento);
       return uuid;
   }
    
   // 获取备份
   public Memento getMemento(String uuid){
       return map.get(uuid);
   }
}

使用 Caretaker 和 Originator 对象。

public class MementoPatternDemo {
   public static void main(String[] args) {
    Originator originator = new Originator("# state 1");
    Caretaker caretaker = new Caretaker();
    originator.setState("# state 2");
    String memento1 = caretaker.addMemento(originator.createMemento());
    originator.setState("# state 3");
    String memento2 = caretaker.addMemento(originator.createMemento());
    originator.setState("# state 4");

    System.out.println("Current State: " + originator.getState());
    originator.restoreFromMemento(caretaker.getMemento(memento1));
    System.out.println("First saved State: " + originator.getState());
    originator.restoreFromMemento(caretaker.getMemento(memento2));
    System.out.println("Second saved State: " + originator.getState());
   }
}

验证输出。

Current State: # state 4
First saved State: # state 2
Second saved State: # state 3