设计模式二十之备忘录模式

  每个人都有犯错误的时候，都希望有种“后悔药”能弥补自己的过失，让自己重新开始，但现实是残酷的。在计算机应用中，客户同样会常常犯错误，能否提供“后悔药”给他们呢？当然是可以的，而且是有必要的。这个功能由“备忘录模式”来实现。
  其实很多应用软件都提供了这项功能，如 Word、记事本、Photoshop、Eclipse 等软件在编辑时按 Ctrl+Z 组合键时能撤销当前操作，使文档恢复到之前的状态；还有在 IE 中的后退键、数据库事务管理中的回滚操作、玩游戏时的中间结果存档功能、数据库与操作系统的备份操作、棋类游戏中的悔棋功能等都属于这类。

1. 模式的定义与特点

1.1 模式的定义

  备忘录模式（Memento）：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，希望能在需要是恢复到保存的这个状态，该模式又叫快照模式。

1.2 模式的特点

  备忘录模式的优点有：
    1. 为用户提供了一种可恢复机制；
    2. 实现了内部状态的封装，除了创建它的发起人之外，其他对象都不能够访问这些状态信息；
    3. 简化了发起人类。发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。

  备忘录模式的缺点有：
    1. 资源消耗大，如果要保存的内部状态过多或过于频繁，将会占用比较大的内存资源。

1.3 模式的使用场景

  1. 保存及恢复数据业务场景；
  2. 后悔的时候，即想恢复到之前的状态。

2. 模式的结构与实现

2.1 模式的结构

  备忘录模式的主要角色如下：
    1. 发起人角色（Originator）：记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，它可以访问备忘录里的所有信息；
    2. 备忘录角色（Memento）：负责存储发起人的内部状态信息，在需要的时候提供这些内部状态给发起人；
    3. 管理者角色（Manager）：对备忘录进行管理，提供保存和获取备忘录的功能，但其不能对备忘录的内容进行访问和修改。

2.2 模式的实现

发起人角色

/**
 * 发起人角色
 */
public class Article {

    private String articleName;

    private String articleContent;

    private String articleImg;

    public Article(String articleName, String articleContent, String articleImg) {
        this.articleName = articleName;
        this.articleContent = articleContent;
        this.articleImg = articleImg;
    }

    public ArticleMemento save2Memento() {
        ArticleMemento memento = new ArticleMemento(articleName, articleContent, articleImg);
        return memento;
    }

    public void recall(ArticleMemento memento) {
        this.articleName = memento.getArticleName();
        this.articleContent = memento.getArticleContent();
        this.articleImg = memento.getArticleImg();
    }

    public void setArticleName(String articleName) {
        this.articleName = articleName;
    }

    public void setArticleContent(String articleContent) {
        this.articleContent = articleContent;
    }

    public void setArticleImg(String articleImg) {
        this.articleImg = articleImg;
    }

    @Override
    public String toString() {
        return "Article{" +
                "articleName='" + articleName + '\'' +
                ", articleContent='" + articleContent + '\'' +
                ", articleImg='" + articleImg + '\'' +
                '}';
    }

备忘录角色

/**
 * 备忘录角色
 */
public class ArticleMemento {

    private String articleName;

    private String articleContent;

    private String articleImg;

    public ArticleMemento(String articleName, String articleContent, String articleImg) {
        this.articleName = articleName;
        this.articleContent = articleContent;
        this.articleImg = articleImg;
    }

    public String getArticleName() {
        return articleName;
    }

    public String getArticleContent() {
        return articleContent;
    }

    public String getArticleImg() {
        return articleImg;
    }

    @Override
    public String toString() {
        return "ArticleMemento{" +
                "articleName='" + articleName + '\'' +
                ", articleContent='" + articleContent + '\'' +
                ", articleImg='" + articleImg + '\'' +
                '}';
    }
}

管理者角色

/**
 * 管理者角色
 */
public class ArticleManager {

    private final Stack<ArticleMemento> mementoStack = new Stack<>();

    public void addMemento(ArticleMemento memento) {
        mementoStack.push(memento);
    }

    public ArticleMemento getMemento() {
        return mementoStack.pop();
    }

}

客户端

public class Client {

    public static void main(String[] args) {
        ArticleManager manager = new ArticleManager();
        Article article = new Article("Java 设计模式 A", "笔记内容 A", "图片 A");
        ArticleMemento memento = article.save2Memento();
        manager.addMemento(memento);
        System.out.println(article);

        System.out.println("进行第一次修改...");
        article.setArticleName("Java 设计模式 B");
        article.setArticleContent("笔记内容 B");
        article.setArticleImg("图片 B");
        memento = article.save2Memento();
        manager.addMemento(memento);
        System.out.println(article);
        System.out.println("进行第一次修改结束...");

        article.setArticleName("Java 设计模式 C");
        article.setArticleContent("笔记内容 C");
        article.setArticleImg("图片 C");

        System.out.println("进行第一次回退...");
        memento = manager.getMemento();
        article.recall(memento);
        System.out.println(article);
        System.out.println("进行第一次回退结束...");

        System.out.println("进行第二次回退...");
        memento = manager.getMemento();
        article.recall(memento);
        System.out.println(article);
        System.out.println("进行第二次回退结束...");
    }

}

# 运行结果如下：
Article{articleName='Java 设计模式 A', articleContent='笔记内容 A', articleImg='图片 A'}
进行第一次修改...
Article{articleName='Java 设计模式 B', articleContent='笔记内容 B', articleImg='图片 B'}
进行第一次修改结束...
进行第一次回退...
Article{articleName='Java 设计模式 B', articleContent='笔记内容 B', articleImg='图片 B'}
进行第一次回退结束...
进行第二次回退...
Article{articleName='Java 设计模式 A', articleContent='笔记内容 A', articleImg='图片 A'}
进行第二次回退结束...