17. 备忘录模式

1、简介

定义：在不破坏封闭的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样，以后就可以将该对象恢复到原先保存的状态。

备忘录模式有三个角色

• Originator ：负责创建一个备忘录,可以记录、恢复自身的内部状态。同时Originator还可以根据需要决定Memento存储自身的那些内部状态。通俗点说就是原始数据对象，内部可以创建一个可以记录当前对象的备忘录对象，还有一个可以通过备忘录实例恢复数据的方法。
• Memento ： 备忘录对象，用于存储Originator的内部状态，即需要备份的一些数据，并且可以防止Originator以外的对象访问Memento。
• Caretaker：负责存储多个备忘录对象，不能对备忘录的内容进行操作和访问，只能够将备忘录传递给其他对象。

适用场景

• 功能复杂，但需要维护、记录属性历史的类，或需要保存一部分属性历史的类。

• Originator可以根据保存的Memento信息还原到前一状态。

• 使用命令模式的系统中，需要实现命令的撤销功能，可以使用备忘录模式来存储可撤销操作的状态。

• 对象的内部信息必须保存在对象以外的地方，但必须由对象自己读取。使用备忘录模式可以把复杂的对象内部信息对其他的对象屏蔽起来，从而可以恰当第保持封装的边界。

• 当状态改变时，有可能这个状态会撤销，导致无效，这时可以使用Memento将状态复原。

2、具体实现

大家都知道，idea有一个可以恢复当前工作空间内历史代码的功能。如图：

这里我们以这个场景写一个简单的小例子。

//创建发起人角色，记录当前时间的数据
class Originator{
    //当前代码
    private String code;
    //当前时间
    private Date date;

    public Originator(Date date, String code){
        this.date = date;
        this.code = code;
    }

    //记录当前代码
    public Memento saveCode(){
        return new Memento(date,code);
    }

    //恢复历史代码
    public void resetCode(Memento memento){
        this.code = memento.getHistoryCode();
    }

    @Override
    public String toString() {
        return "当前代码：{" +
                "code='" + code + '\'' +
                "}";
    }

    public void setCode(String code) {
        this.code = code;
    }

    public void setDate(Date date) {
        this.date = date;
    }
}
//创建备忘录，记录历史代码
class Memento{

    private String historyCode;

    private Date historyDate;

    public Memento(Date date, String code){
        this.historyCode = code;
        this.historyDate = date;
    }

    public String getHistoryCode() {
        return historyCode;
    }

    public void setHistoryCode(String historyCode) {
        this.historyCode = historyCode;
    }

    public Date getHistoryDate() {
        return historyDate;
    }

    public void setHistoryDate(Date historyDate) {
        this.historyDate = historyDate;
    }
}
//创建管理历史代码角色
class IdeaManager{
   //创建一个保存历史代码的容器（也可以用map   stack）
   private List<Memento> list = new ArrayList<>();
   private Originator o;
   public IdeaManager(Originator o){
       this.o = o;
   }

   //保存某个时间点的历史代码
   public void saveCode(){
       Memento memento = o.saveCode();
       list.add(memento);
   }
    //恢复某个时间点的代码public
   public Originator resetCode(Date date){
       for(Memento memento : list){
           if(date.compareTo(memento.getHistoryDate()) == 0){
               o.resetCode(memento);
           }
       }
       return o;
   }
}

public class Idea {
    public static void main(String[] args) {

        Date date1 = new Date();
        Originator originator = new Originator(date1, "code1");
        IdeaManager ideaManager = new IdeaManager(originator);

        //第一次保存
        ideaManager.saveCode();

        Date date2 = new Date();
        //更改代码
        originator.setDate(date2);
        originator.setCode("code2");

        //第二次保存
        ideaManager.saveCode();

        //恢复到第一次
        Originator o = ideaManager.resetCode(date1);
        System.out.println(o.toString());
    }
}

由代码可见，通过使用备忘录模式，可以记录任何时间的代码，也可以恢复任何时间的代码状态

3、总结

优点
   1. 它提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用暂时存储起来的备忘录将状态复原。
  2. 备忘录实现了对信息的封装，一个备忘录对象是一种原发器对象状态的表示，不会被其他代码所改动。备忘录保存了原发器的状态，采用列表、堆栈等集合来存储备忘录对象可以实现多次撤销操作。

缺点
  资源消耗过大，如果需要保存的原发器类的成员变量太多，就不可避免需要占用大量的存储空间，每保存一次对象的状态都需要消耗一定的系统资源。