设计模式系列篇(十九)——备忘录模式

What

备忘录模式（Memento Design Pattern）是一种软件设计模式，它提供了将对象恢复到其先前状态的功能。具体来讲，在不违背封装原则的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，以便之后恢复对象为先前的状态。

Why

备忘录模式最大的优点在于，可以在不破坏对象封装情况的前提下创建对象状态快照。

When

当你需要创建对象状态快照来恢复其之前的状态时，可以使用备忘录模式。
备忘录模式允许你复制对象中的全部状态（包括私有成员变量），并将其独立于对象进行保存。尽管大部分人因为 “撤销” 这个用例才记得该模式，但其实它在处理事务（比如需要在出现错误时回滚一个操作）的过程中也必不可少。
当直接访问对象的成员变量、获取器或设置器将导致封装被突破时，可以使用该模式。
备忘录让对象自行负责创建其状态的快照。任何其他对象都不能读取快照，这有效地保障了数据的安全性。

How

实现备忘录模式，主要需要3个类，分别是原始对象（OriginObject）类，备忘录（Memento或者Snapshot）类和SnapshotHolder类。
原始对象类，即你需要保存状态的对象类。注意，为了不破坏对象封装原则，原始对象类不应该暴露任何setter方法，防止其他对象更改。
备忘录类，没有声明任何公有的成员变量、获取器（getter）和设置器，因此没有对象可以修改其内容。
SnapshotHolder类，主要作用是保存对象的快照，其内部的数据结构是栈。

下面，我们就以日常工作学习中常使用的文本编辑器为例来讲解备忘录模式的实现方法。文本编辑器支持用户输入、撤销、恢复文本。其中撤销和恢复其实就可以用快照来实现——当用户输入文本点击保存后，生成当前文本快照，保存到快照栈中；当用户需要撤销时，则直接从快照栈中pop出栈顶的文本快照，即可恢复至之前的版本。
话不多说，直接上代码。
首先是编辑器类：

public class TextEditor {
    private StringBuilder editor;

    public TextEditor() {
        editor = new StringBuilder();
    }

    public String getText() {
        return editor.toString();
    }

    public void append(String text) {
        this.editor.append(text);
    }

    // 用来创建快照
    public Snapshot createSnapshot() {
        return new Snapshot(this.getText());
    }

    // 用来恢复快照，直接使用快照替换原始字符串
    public void restoreSnapshot(Snapshot snapshot) {
        this.editor.replace(0, this.editor.length(), snapshot.getText());
    }
}

然后是Snapshot类，注意该类不提供任何修改快照属性text的方法，因此，满足封装特性。

public class Snapshot {
    private String text;

    public Snapshot(String text) {
        this.text = text;
    }

    public String getText() {
        return text;
    }
}

然后，是SnapshotHolder类，内部就只有一个栈结构。

public class SnapshotHolder {
    private Stack<Snapshot> snapshots = new Stack<>();

    public Snapshot pop() {
        return snapshots.pop();
    }

    public void push(Snapshot snapshot) {
        snapshots.push(snapshot);
    }
}

最后，我们用终端模拟一下该过程。输入字符串，代表向编辑器输入文本；输入:list，输出所有文本；输入:undo，撤销上一步操作，即恢复前一文本。

public class TestMain {
    public static void main(String[] args) {
        TextEditor textEditor = new TextEditor();
        SnapshotHolder snapshotHolder = new SnapshotHolder();
        Scanner scanner = new Scanner(System.in);
        while (!scanner.hasNextInt()) {
            String text = scanner.next();
            if (":list".equals(text)) {
                System.out.println(textEditor.getText());
            } else if (":undo".equals(text)) {
                Snapshot snapshot = snapshotHolder.pop();
                textEditor.restoreSnapshot(snapshot);
            } else {
                Snapshot snapshot = textEditor.createSnapshot();
                snapshotHolder.push(snapshot);
                textEditor.append(text);
            }
        }
    }
}

输出结果如下：

hello
world
:list
helloworld
!
:list
helloworld!
:undo
:list
helloworld
:undo
:list
hello

上述代码存在的问题是，每次保存快照，都是将之前输入的所有文本进行备份，这会严重浪费内存。可优化的地方就是不需要每一次都进行全量备份，而是通过一下的策略来进行备份：当我们需要恢复到某一时间点的备份的时候，如果这一时间点有做全量备份，我们直接拿来恢复就可以了。如果这一时间点没有对应的全量备份，我们就先找到最近的一次全量备份，然后用它来恢复，之后执行此次全量备份跟这一时间点之间的所有增量备份，也就是对应的操作或者数据变动。这样就能减少全量备份的数量和频率，减少对时间、内存的消耗。

代码地址

i-learning

写在最后

如果你觉得我写的文章帮到了你，欢迎点赞、评论、分享、赞赏哦，你们的鼓励是我不断创作的动力～