备忘录模式（行为型模式）

10 备忘录模式

备忘录模式提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用暂时存储起来的备忘录将状态复原，很多软件都提供了撤销（Undo）操作，如 Word、记事本、Photoshop、IDEA等软件在编辑时按 Ctrl+Z 组合键时能撤销当前操作，使文档恢复到之前的状态；还有在 浏览器 中的后退键、数据库事务管理中的回滚操作、玩游戏时的中间结果存档功能、数据库与操作系统的备份操作、棋类游戏中的悔棋功能等都属于这类。

定义：

又叫快照模式，在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，以便以后当需要时能将该对象恢复到原先保存的状态。

10.1组成结构

• 发起人（Originator）角色：记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，实现其他业务功能，它可以访问备忘录里的所有信息。
• 备忘录（Memento）角色：负责存储发起人的内部状态，在需要的时候提供这些内部状态给发起人。
• 管理者（Caretaker）角色：对备忘录进行管理，提供保存与获取备忘录的功能，但其不能对备忘录的内容进行访问与修改。

备忘录有两个等效的接口：

• 窄接口：管理者(Caretaker)对象（和其他发起人对象之外的任何对象）看到的是备忘录的窄接口(narror Interface)，这个窄接口只允许他把备忘录对象传给其他的对象。
• 宽接口：与管理者看到的窄接口相反，发起人对象可以看到一个宽接口(wide Interface)，这个宽接口允许它读取所有的数据，以便根据这些数据恢复这个发起人对象的内部状态。

10.2 场景设计

文本编辑器的撤回功能

10.3 实现

记事本

public class Text {

    private String title;

    private String content;

    private Date createTime;

    public String getTitle() {
        return title;
    }

    public String getContent() {
        return content;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public void setContent(String content) {
        this.content = content;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    /**
     * 保存信息到备忘录
     * @return
     */
    public TextMementor saveTextMementor(){
        TextMementor mementor = new TextMementor();
        mementor.setTitle(this.title);
        mementor.setContent(this.content);
        mementor.setCreateTime(this.createTime);
        return mementor;
    }

    /**
     * 获取备忘录信息
     * @param mementor
     */
    public void getTextMementor(TextMementor mementor){
        this.title = mementor.getTitle();
        this.content = mementor.getContent();
        this.createTime = mementor.getCreateTime();
    }

    @Override
    public String toString() {
        return "Text{" +
                "title='" + title + '\'' +
                ", content='" + content + '\'' +
                ", createTime=" + createTime +
                '}';
    }
}

备忘录

public class TextMementor {

    private String title;

    private String content;

    private Date createTime;

    public String getTitle() {
        return title;
    }

    public String getContent() {
        return content;
    }

    public Date getCreateTime() {
        return createTime;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public void setContent(String content) {
        this.content = content;
    }

    public void setCreateTime(Date createTime) {
        this.createTime = createTime;
    }

    @Override
    public String toString() {
        return "TextMementor{" +
                "title='" + title + '\'' +
                ", content='" + content + '\'' +
                ", createTime=" + createTime +
                '}';
    }
}

备忘录管理者

public class TextMementorCaretaker {

    /**
     * 备忘录信息容器
     */
    List<TextMementor> mementorList = new ArrayList<>();

    /**
     * 获取历史备忘录信息
     * @param index
     * @return
     */
    public TextMementor getTextMementor(int index){
        TextMementor mementor = null;
        if (mementorList.size() > 0){
            mementor = mementorList.get(index);
        }
        return mementor;
    }

    /**
     * 添加历史备忘录信息
     * @param mementor
     */
    public TextMementorCaretaker addTextMementor(TextMementor mementor){
        this.mementorList.add(mementor);
        return this;
    }
}

测试

public class TextMementorTest {

    public static void main(String[] args) throws InterruptedException {
        // 创建发起人对象，设置属性
        Text text = new Text();
        text.setTitle("文本一二三");
        text.setContent("这是文本一二三");
        text.setCreateTime(new Date());
      
        //备份
        TextMementor mementor1 = text.saveTextMementor();
        //恢复
        TextMementor textMementor1 = mementorCaretaker.getTextMementor(0);
        text.getTextMementor(textMementor1);
      	
    }
}

10.4 优缺点分析

优点：

• 提供了一种可以恢复状态的机制。当用户需要时能够比较方便地将数据恢复到某个历史的状态。
• 实现了内部状态的封装。除了创建它的发起人之外，其他对象都不能够访问这些状态信息。
• 简化了发起人类。发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。

缺点：

• 资源消耗大。如果要保存的内部状态信息过多或者特别频繁，将会占用比较大的内存资源。

10.5 使用场景

• 需要保存与恢复数据的场景，如玩游戏时的中间结果的存档功能。

• 需要提供一个可回滚操作的场景，如 Word、记事本、Photoshop，idea等软件在编辑时按 Ctrl+Z 组合键，还有数据库中事务操作。