设计模式14 -- 备忘录模式

备忘录模式（Memento Pattern）是一种行为型设计模式，它的核心作用是在不破坏对象封装性的前提下，捕获并存储对象的内部状态，以便后续需要时能将对象恢复到之前的状态。

简单来说，备忘录模式就像 “游戏存档”—— 游戏过程中可以随时存档（存储当前状态），遇到失败时可以读档（恢复到之前的状态），且存档过程不会暴露游戏内部的复杂数据结构。

备忘录模式的UML如下

如上图，备忘录模式包含三个核心角色，职责严格分离：

发起人（Originator）
- 核心对象，拥有内部状态（如游戏角色的血量、装备）。
- 提供createMemento()方法：创建备忘录，将当前内部状态存入备忘录。
- 提供restoreFromMemento()方法：从备忘录中读取状态，恢复自身到之前的状态。
- 关键：备忘录的创建和恢复逻辑由发起人控制，确保状态封装性。
备忘录（Memento）
- 仅负责存储发起人状态，不包含任何业务逻辑。
- 状态变量通常为私有，仅通过有限接口（如getState()）暴露，且仅允许发起人或负责人访问（通过访问权限控制，如 Java 中的包访问权限）。
- 关键：防止外部对象随意修改或查看状态，保护发起人封装性。
负责人（Caretaker）
- 充当备忘录的 “仓库”，负责存储和管理多个备忘录（如按时间顺序存储多个存档）。
- 不关心备忘录的内容，也不参与状态的创建或恢复，仅提供 “保存” 和 “获取” 的管理能力。
- 关键：隔离发起人（状态创建者）和备忘录（状态存储），降低耦合。

这个模式的核心价值在于：

保护封装性：发起人状态仅通过备忘录间接暴露，外部无法直接访问或修改。
状态回溯：支持对象状态的多次存档和恢复（如多步撤销操作）。
职责分离：将 “状态创建”（Originator）、“状态存储”（Memento）、“状态管理”（Caretaker）拆分，符合单一职责原则。

备忘录模式的常见应用场景包括：

文本编辑器的撤销 / 重做功能（存储每次编辑后的文档状态）。
游戏存档 / 读档（存储角色、地图、进度等状态）。
事务回滚（数据库存储事务执行前的状态，失败时恢复）。
配置中心的版本管理（存储配置的历史版本，支持回滚）。

下面以 “文本编辑器的撤销功能” 为例，用代码实现备忘录模式。这个场景中，我们需要保存文本的历史状态，以便用户随时撤销到之前的编辑状态。

首先我们创建这个文本编辑器的备忘录对象，它用于存储文本编辑器的内容

// 1. 备忘录类：存储文本编辑器的状态
// 注意：构造方法和状态获取方法设为包级私有，仅允许同包的Originator访问
class TextMemento {
    private final String content;  // 保存的文本内容
    private final int cursorPosition;  // 保存的光标位置

    // 包级私有构造：仅TextEditor可创建
    TextMemento(String content, int cursorPosition) {
        this.content = content;
        this.cursorPosition = cursorPosition;
    }

    // 包级私有方法：仅TextEditor可读取状态
    String getContent() {
        return content;
    }

    // 包级私有方法：仅TextEditor可读取状态
    int getCursorPosition() {
        return cursorPosition;
    }
}

接着我们创建一个文本编辑器对象，它记录每次的键盘录入和光标位置并存到备忘录对象中，并且提供了从某个备忘录恢复的方法。

// 2. 发起人：文本编辑器（创建和恢复备忘录）
class TextEditor {
    private String content = "";  // 当前文本内容
    private int cursorPosition = 0;  // 当前光标位置

    // 编辑文本
    public void type(String text) {
        content = content.substring(0, cursorPosition) + text + content.substring(cursorPosition);
        cursorPosition += text.length();
        System.out.println("编辑后：" + content + "（光标在" + cursorPosition + "位置）");
    }

    // 移动光标
    public void moveCursor(int position) {
        if (position >= 0 && position <= content.length()) {
            cursorPosition = position;
            System.out.println("光标移动到：" + cursorPosition);
        }
    }

    // 创建备忘录（保存当前状态）
    public TextMemento createMemento() {
        System.out.println("创建存档...");
        return new TextMemento(content, cursorPosition);
    }

    // 从备忘录恢复状态
    public void restoreFromMemento(TextMemento memento) {
        this.content = memento.getContent();
        this.cursorPosition = memento.getCursorPosition();
        System.out.println("撤销后：" + content + "（光标在" + cursorPosition + "位置）");
    }
}

第三步，我们创建一个管理备忘录的对象，它将每次的备忘录副本保存到一个列表对象中，并提供从列表中取出某个备忘录副本的功能。

// 3. 负责人：管理备忘录（存档历史）
class Caretaker {
    private final List<TextMemento> history = new ArrayList<>();

    // 保存备忘录
    public void saveMemento(TextMemento memento) {
        history.add(memento);
    }

    // 获取上一个备忘录（用于撤销）
    public TextMemento getPreviousMemento() {
        if (history.size() == 0) {
            return null;
        }
        // 移除并返回最后一个存档（模拟单次撤销）
        return history.remove(history.size() - 1);
    }
}

最后我们演示客户端使用备忘录模式的代码

// 客户端：使用文本编辑器
public class TextEditorClient {
    public static void main(String[] args) {
        // 创建文本编辑器和负责人
        TextEditor editor = new TextEditor();
        Caretaker caretaker = new Caretaker();

        // 第一次编辑
        caretaker.saveMemento(editor.createMemento());  // 保存初始状态
        editor.type("Hello ");

        // 第二次编辑
        caretaker.saveMemento(editor.createMemento());  // 保存当前状态
        editor.type("World");

        // 移动光标
        editor.moveCursor(5);

        // 第三次编辑
        caretaker.saveMemento(editor.createMemento());  // 保存当前状态
        editor.type("Java ");

        // 执行撤销
        System.out.println("\n执行第一次撤销：");
        TextMemento prev1 = caretaker.getPreviousMemento();
        if (prev1 != null) {
            editor.restoreFromMemento(prev1);
        }

        // 再次撤销
        System.out.println("\n执行第二次撤销：");
        TextMemento prev2 = caretaker.getPreviousMemento();
        if (prev2 != null) {
            editor.restoreFromMemento(prev2);
        }
    }
}