✨这里是第七人格的博客✨小七，欢迎您的到来~✨

🍅系列专栏：设计模式🍅

✈️本篇内容: 备忘录模式✈️

🍱 本篇收录完整代码地址：gitee.com/diqirenge/d… 🍱

楔子

需求背景

为了解决他的需求痛点，我们可以为文档编辑器增加一个保存与恢复的简单功能。

分析设计

我们可以设计一个基于备忘录模式的文本编辑器状态保存与恢复的功能。

首先我们有一个文本编辑器，它有自己的状态，包括当前编辑的文本内容和光标位置。

其次我们还需要有两个类，一个用于保存文本编辑器的状态，另一个类负责管理备忘录对象，即保存和提供文本编辑器的状态。

UML图

根据分析设计，我们可以先画一个简单的UML图，后面通过UML图编码

模块名称

memento

模块地址

gitee.com/diqirenge/d…

模块描述

备忘录模式代码示例

代码实现

1、编写【文本编辑器状态】类

/**
 * 文本编辑器的状态
 * 关注公众号【奔跑的码畜】，一起进步不迷路
 *
 * @author 第七人格
 * @date 2024/06/12
 */
public class TextEditorState {
    /**
     * 文本
     */
    private String text;
    /**
     * 游标位置
     */
    private int cursorPosition;
  
    public TextEditorState(String text, int cursorPosition) {  
        this.text = text;  
        this.cursorPosition = cursorPosition;  
    }  
  
    public String getText() {  
        return text;  
    }  
  
    public int getCursorPosition() {  
        return cursorPosition;  
    }

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

    public void setCursorPosition(int cursorPosition) {
        this.cursorPosition = cursorPosition;
    }
}

2、编写【文本编辑器】类

/**
 * 文本编辑器（发起人）
 * 关注公众号【奔跑的码畜】，一起进步不迷路
 *
 * @author 第七人格
 * @date 2024/06/12
 */
class TextEditor {
    /**
     * 编辑器状态
     */
    private final TextEditorState state;
  
    public TextEditor(String initialText) {  
        this.state = new TextEditorState(initialText, 0);  
    }  
  
    public void setText(String text) {  
        this.state.setText(text);
    }  
  
    public void setCursorPosition(int position) {  
        this.state.setCursorPosition(position);
    }  
  
    public TextEditorMemento saveState() {
        // 注意：这里返回的是状态的一个拷贝，以防止外部修改影响内部状态
        return new TextEditorMemento(new TextEditorState(state.getText(), state.getCursorPosition()));
    }  
  
    public void restoreState(TextEditorMemento memento) {  
        TextEditorState savedState = memento.getState();  
        this.state.setText(savedState.getText());
        this.state.setCursorPosition(savedState.getCursorPosition());
    }  
  
    public String getText() {  
        return state.getText();
    }  
  
    public int getCursorPosition() {  
        return state.getCursorPosition();
    }  
}

3、编写【备忘录】类

/**
 * 备忘录
 * 关注公众号【奔跑的码畜】，一起进步不迷路
 *
 * @author 第七人格
 * @date 2024/06/12
 */
class TextEditorMemento {
    /**
     * 编辑器状态
     */
    private final TextEditorState state;
  
    public TextEditorMemento(TextEditorState state) {  
        this.state = state;  
    }  
  
    public TextEditorState getState() {  
        return state;  
    }  
}

4、编写【文本编辑器状态管理者】类

/**
 * 文本编辑器状态管理者
 * 关注公众号【奔跑的码畜】，一起进步不迷路
 *
 * @author 第七人格
 * @date 2024/06/12
 */
class TextEditorCaretaker {
    /**
     * 备忘录
     */
    private TextEditorMemento memento;
  
    public void saveState(TextEditorMemento memento) {  
        this.memento = memento;  
    }  
  
    public TextEditorMemento getState() {  
        return memento;  
    }  
}

5、编写测试类

/**
 * 备忘录测试类
 * 关注公众号【奔跑的码畜】，一起进步不迷路
 *
 * @author 第七人格
 * @date 2024/06/12
 */
public class MementoTest {
    @Test
    public void testCommand() {
        TextEditor textEditor = new TextEditor("初始化文本...");
        TextEditorCaretaker caretaker = new TextEditorCaretaker();  
  
        // 编辑文本并保存状态  
        textEditor.setText("小七开始编辑文本啦~");
        // 光标位置移动到5
        textEditor.setCursorPosition(5);
        // 保存
        // textEditor.saveState()==>【要点1】创建备忘录并保存当前状态
        // caretaker.saveState(textEditor.saveState())==>【要点2】管理者保存备忘录
        caretaker.saveState(textEditor.saveState());  
  
        // 继续编辑文本  
        textEditor.setText("小七继续编辑文本...");
        // 光标位置移动到10
        textEditor.setCursorPosition(10);

        // 恢复之前保存的状态  
        // caretaker.getState()==>【要点3】从管理者处检索备忘录
        // textEditor.restoreState(retrievedState)==>【要点4】使用备忘录恢复状态到先前保存的点
        textEditor.restoreState(caretaker.getState());  
  
        // 输出恢复后的状态  
        System.out.println("恢复后的文本: " + textEditor.getText());
        System.out.println("恢复后的游标位置: " + textEditor.getCursorPosition());
    }  
}

6、测试结果

恢复后的文本: 小七开始编辑文本啦~】

恢复后的游标位置: 5

实现要点

1. 创建备忘录（Memento）：在需要保存状态的时刻，发起人（Originator）会创建一个备忘录对象，该对象包含了发起人当前状态的完整快照。

   对应例子中的textEditor.saveState()方法

2. 保存备忘录：管理者（Caretaker）负责保存备忘录对象。在实际应用中，管理者可能会保存多个备忘录，以便能够恢复到不同的历史状态。

   对应例子中的caretaker.saveState(savedState)

3. 检索备忘录：当需要恢复到某个先前状态时，管理者会提供相应的备忘录对象。

   对应例子中的caretaker.getState()

4. 恢复状态：发起人使用从管理者处检索到的备忘录来恢复其状态。这通常涉及将发起人的当前状态替换为备忘录中保存的状态。

   对应例子中的textEditor.restoreState(retrievedState)

总结

备忘录模式（Memento Pattern）是一种行为设计模式，它允许在不破坏封装性的前提下捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态。