19 备忘录模式

定义

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

结构

1. Originator（原发器）：原发器是一个普通类，它通过创建一个备忘录来存储当前内部状态，也可以使用备忘录来恢复其内部状态，一般将系统中需要保存内部状态的类设计为原发器。
2. Memento（备忘录）：备忘录用于存储原发器的内部状态，根据原发器来决定保存哪些内部状态。备忘录的设计一般可以参考原发器的设计，根据实际需要确定备忘录中的属性。需要注意的是，除了原发器本身与负责人类之外，备忘录对象不能直接供其他类使用，原发器的设计在不同的编程语言中实现机制会有所不同。
3. Caretaker（负责人）：负责人又称为管理者，它负责保存备忘录，但是不能对备忘录的内容进行操作或检查。在负责人类中可以存储一个或多个备忘录对象，它只负责储存对象，而不能修改对象，也无须知道对象的实现细节。

代码

Originator

public class Originator {

    private String state;

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

    // 创建一个备忘录对象
    public Memento createMemento() {
        return new Memento(this);
    }

    // 根据备忘录对象恢复原发器状态
    public void restoreMemento(Memento memento) {
        state = memento.getState();
    }

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

    public String getState() {
        return state;
    }
}

Memento

// 备忘录类，默认可见性，包内可见
class Memento {

    private String state;

    public Memento(Originator originator) {
        state = originator.getState();
    }

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

    public String getState() {
        return state;
    }

}

Caretaker

public class Caretaker {

    private Memento memento;

    public Memento getMemento() {
        return memento;
    }

    public void setMemento(Memento memento) {
        this.memento = memento;
    }

}

Test

public class Test {

    public static void main(String[] args) {
        // 创建原发器对象
        Originator originator = new Originator("state1");
        System.out.println(originator.getState());

        // 创建负责人对象，保存创建的备忘录对象
        Caretaker caretaker = new Caretaker();
        caretaker.setMemento(originator.createMemento());

        originator.setState("state2");
        System.out.println(originator.getState());

        // 从负责人对象中取出备忘录，实现撤销
        originator.restoreMemento(caretaker.getMemento());
        System.out.println(originator.getState());
    }

}

Console

state1
state2
state1

实现多次撤销

MementoCaretaker

import java.util.ArrayList;
import java.util.List;

public class MementoCaretaker {

    // 定义一个集合来储存备忘录
    private List<Memento> mementoList = new ArrayList<>();

    public Memento getMemento(int i) {
        return mementoList.get(i);
    }

    public void setMemento(Memento memento) {
        mementoList.add(memento);
    }

}

Client

public class Client {

    public static void main(String[] args) {
        // 定义一个索引来记录当前状态所在位置
        int index = -1;
        // 创建原发器对象
        Originator originator = new Originator("state1");
        System.out.println(originator.getState());

        MementoCaretaker mementoCaretaker = new MementoCaretaker();
        // 设置备忘录
        mementoCaretaker.setMemento(originator.createMemento());
        index++;

        originator.setState("state2");
        System.out.println(originator.getState());

        Memento memento = mementoCaretaker.getMemento(index);
        System.out.println(memento.getState());

        // 撤销
        originator.restoreMemento(mementoCaretaker.getMemento(index));
        index--;

        System.out.println(index);

    }

}

优/缺点与适用环境

1. 优点

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

2. 缺点

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

3. 适用环境

• 保存一个对象在某一个时刻的全部或部分状态，这样以后需要时它能够恢复到先前的状态，实现撤销操作。
• 防止外界对象破坏一个对象的历史状态的封装性，避免将对象历史状态的实现细节暴露给外界对象。