设计模式十九-备忘录模式

备忘录模式是一种行为型设计模式，它允许在不暴露对象实现细节的情况下捕获和恢复对象的内部状态。该模式在很多情况下都有应用，例如：

1. 撤销/重做操作：可以使用备忘录模式来实现撤销和重做操作。在每次操作前，可以创建一个备忘录对象，保存当前状态。如果需要撤销操作，则可以将对象恢复到备忘录对象保存的状态。

2. 编辑器应用：例如文本编辑器，图片编辑器等应用程序，可以使用备忘录模式来实现撤销和重做操作。在编辑器中，每当进行一次操作，可以创建一个备忘录对象，并将其保存在撤销栈中。如果需要撤销操作，则可以从撤销栈中取出最近保存的备忘录对象，并将编辑器恢复到该状态。

3. 游戏应用：例如游戏中的存档和恢复功能，可以使用备忘录模式来实现。在游戏中，每当玩家进行一次操作或达到一个新的游戏状态时，可以创建一个备忘录对象，并将其保存在游戏的备忘录列表中。如果需要恢复游戏状态，则可以从备忘录列表中取出最近保存的备忘录对象，并将游戏恢复到该状态。

备忘录模式的核心原理是将对象的内部状态封装在备忘录对象中，并在需要时恢复对象的状态。该模式包含三个角色：Originator、Memento和Caretaker。Originator是需要被保存和恢复状态的对象，Memento是保存状态的对象，而Caretaker是负责保存备忘录对象和恢复状态的对象。

以下是一个在Java中实现备忘录模式的简单示例：

假设有一个文本编辑器，用户可以在编辑器中进行编辑，并且可以通过undo和redo操作撤销和重做前一步操作。这可以使用备忘录模式来实现。

首先定义一个文本编辑器类Editor，其中包含当前编辑器状态的成员变量text和撤销操作的栈undoStack和重做操作的栈redoStack，以及进行编辑、撤销和重做操作的方法：

import java.util.Stack;

public class Editor {
    private String text = "";
    private Stack<String> undoStack = new Stack<>();
    private Stack<String> redoStack = new Stack<>();

    public void write(String text) {
        undoStack.push(this.text);
        this.text += text;
        redoStack.clear();
    }

    public void undo() {
        if (!undoStack.isEmpty()) {
            redoStack.push(this.text);
            this.text = undoStack.pop();
        }
    }

    public void redo() {
        if (!redoStack.isEmpty()) {
            undoStack.push(this.text);
            this.text = redoStack.pop();
        }
    }

    public String getText() {
        return this.text;
    }
}

然后定义备忘录类EditorMemento，它包含了Editor类的状态信息text，以及获取和设置状态的方法：

public class EditorMemento {
    private String text;

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

    public String getText() {
        return text;
    }

    public void setText(String text) {
        this.text = text;
    }
}

最后，在Editor类中添加获取和设置备忘录状态的方法createMemento和restoreFromMemento，以及一个备忘录栈mementoStack，用于存储备忘录状态：

public class Editor {
    private String text = "";
    private Stack<String> undoStack = new Stack<>();
    private Stack<String> redoStack = new Stack<>();
    private Stack<EditorMemento> mementoStack = new Stack<>();

    public void write(String text) {
        undoStack.push(this.text);
        this.text += text;
        redoStack.clear();
    }

    public void undo() {
        if (!undoStack.isEmpty()) {
            redoStack.push(this.text);
            this.text = undoStack.pop();
        }
    }

    public void redo() {
        if (!redoStack.isEmpty()) {
            undoStack.push(this.text);
            this.text = redoStack.pop();
        }
    }

    public String getText() {
        return this.text;
    }

    public EditorMemento createMemento() {
        return new EditorMemento(this.text);
    }

    public void restoreFromMemento(EditorMemento memento) {
        this.text = memento.getText();
    }

    public void save() {
        mementoStack.push(createMemento());
    }

    public void restore() {
        if (!mementoStack.isEmpty()) {
            EditorMemento memento = mementoStack.pop();
            restoreFromMemento(memento);
        }
    }
}

在这个例子中，文本编辑器的状态包括当前的文本内容，因此备忘录类只需要保存这个状态信息即可。通过将当前状态保存到备忘录中，并将备忘录存储到备忘录栈中，我们就可以在需要的时候恢复到之前的状态。