设计模式-备忘录模式（Memento Pattern）

原创

ITKaven 2022-11-09 18:25:07 博主文章分类：设计模式 ©著作权

©著作权归作者所有：来自51CTO博客作者ITKaven的原创作品，请联系作者获取转载授权，否则将追究法律责任

备忘录模式

定义

Without violating encapsulation, capture and externalize an object’s internal state so that the object can be restored to this state later.

在不破坏封闭的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样就可以将该对象恢复到原先保存的状态。

像游戏的存档功能，office、wps等文字编辑工具的回退功能，都可以看做备忘录模式的应用。

类型
行为型。

角色

Originator（发起者）：负责创建备忘录，并且可以记录、恢复自身的内部状态。可以根据需要决定Memento保存自身的那些内部状态。
Memento（备忘录）：用于存储Originator的状态，防止Originator以外的的对象访问Memento。
Caretaker（备忘录管理者）：负责存储备忘录，不能对备忘录的内容进行操作和访问，只能够将备忘录传递给其他对象。

例子
慕课网有手记板块，当作者将手记修改后，作者可能需要回退到之前的版本，我们来实现这个功能，当然只是逻辑上简单模拟实现。

Article类（发起者），手记类，saveToMemento()方法创建当前Originator的Memento，undoFromMemento()方法根据得到的Memento来回退Originator。

package com.kaven.design.pattern.behavioral.memento;

public class Article {
    private String title;
    private String content;
    private String imgs;

    public Article(String title, String content ,String imgs){
        this.title = title;
        this.content =content;
        this.imgs = imgs;
    }

    public String getTitle() {
        return title;
    }

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

    public String getContent() {
        return content;
    }

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

    public String getImgs() {
        return imgs;
    }

    public void setImgs(String imgs) {
        this.imgs = imgs;
    }

    public ArticleMemento saveToMemento(){
        ArticleMemento articleMemento = new ArticleMemento(this.title , this.content , this.imgs);
        return articleMemento;
    }

    public void undoFromMemento(ArticleMemento articleMemento){
        this.title = articleMemento.getTitle();
        this.content = articleMemento.getContent();
        this.imgs = articleMemento.getImgs();
    }

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

ArticleMemento类（备忘录）。

package com.kaven.design.pattern.behavioral.memento;

public class ArticleMemento {
    private String title;
    private String content;
    private String imgs;

    public ArticleMemento(String title, String content, String imgs) {
        this.title = title;
        this.content = content;
        this.imgs = imgs;
    }

    public String getTitle() {
        return title;
    }

    public String getContent() {
        return content;
    }

    public String getImgs() {
        return imgs;
    }

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

ArticleMementoManager类（备忘录管理者），它负责存储备忘录，使用栈进行存储备忘录的原因大家应该知道，最新加进去的实例最早出来，并且它可以将备忘录提供给外界。

package com.kaven.design.pattern.behavioral.memento;

import java.util.Stack;

public class ArticleMementoManager {
    private final Stack<ArticleMemento> ARTICLE_MEMENTO_STACK = new Stack<ArticleMemento>();

    public ArticleMemento getMemento(){
        ArticleMemento articleMemento = ARTICLE_MEMENTO_STACK.pop();
        return articleMemento;
    }

    public void addMemento(ArticleMemento articleMemento){
        ARTICLE_MEMENTO_STACK.push(articleMemento);
    }
}

应用层代码：

package com.kaven.design.pattern.behavioral.memento;

public class Test {
    public static void main(String[] args) {
        ArticleMementoManager articleMementoManager = new ArticleMementoManager();
        Article article = new Article("Java设计模式","手记内容-Java必须要学","img1");
        ArticleMemento articleMemento = article.saveToMemento();
        articleMementoManager.addMemento(articleMemento);

        System.out.println("标题："+article.getTitle()+" 内容："+article.getContent()+" 图片："+article.getImgs()+" 暂存成功");
        System.out.println("手记完整信息："+article);

        System.out.println("修改手记start-----");

        article.setTitle("Javascript设计模式");
        article.setContent("手记内容-Javascript必须要学");
        article.setImgs("img2");

        System.out.println("修改手记end-----");

        System.out.println("手记完整信息："+article);

        System.out.println("修改手记start-----");

        articleMemento = article.saveToMemento();
        articleMementoManager.addMemento(articleMemento);

        article.setTitle("Python设计模式");
        article.setContent("手记内容-Python必须要学");
        article.setImgs("img3");

        System.out.println("修改手记end-----");

        System.out.println("手记完整信息："+article);

        System.out.println("暂存回退start-----");

        System.out.println("回退出栈1次");
        articleMemento = articleMementoManager.getMemento();
        article.undoFromMemento(articleMemento);

        System.out.println("回退出栈2次");
        articleMemento = articleMementoManager.getMemento();
        article.undoFromMemento(articleMemento);

        System.out.println("暂存回退end-----");
        System.out.println("手记完整信息："+article);
    }
}

输出：

标题：Java设计模式 内容：手记内容-Java必须要学 图片：img1 暂存成功
手记完整信息：Article{title='Java设计模式', content='手记内容-Java必须要学', imgs='img1'}
修改手记start-----
修改手记end-----
手记完整信息：Article{title='Javascript设计模式', content='手记内容-Javascript必须要学', imgs='img2'}
修改手记start-----
修改手记end-----
手记完整信息：Article{title='Python设计模式', content='手记内容-Python必须要学', imgs='img3'}
暂存回退start-----
回退出栈1次
回退出栈2次
暂存回退end-----
手记完整信息：Article{title='Java设计模式', content='手记内容-Java必须要学', imgs='img1'}

这里便完成了一个简单的备忘录模式。

适用场景