备忘录模式

2023-11-10 14:16:10

一、定义

备忘录模式(Memento Pattern) 又称为快照模式(Snapshot Pattern) 或令牌模式(Token Pattern) ，是指在不破坏封装的前提下，捕获一个对象的内部状态，并在对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态，属于行为型模式。在软件系统中，备忘录模式可以为我们提供一种“后悔药”的机制，它通过存储系统各个历史状态的快照，使得我们可以在任一时刻将系统回滚到某一个历史状态。备忘录模式本质是从发起人实体类(Originator) 隔离存储功能，降低实体类的职责。同时由于存储信息(Memento) 独立，且存储信息的实体交由管理类(Caretaker) 管理，则可以通过为管理类扩展额外的功能对存储信息进行扩展操作(比如增加历史快照功能...)。

备忘录模式主要包含三种角色：

发起人角色(Originator)：负责创建一个备忘录，记录自身需要保存的状态；具备状态回滚功能；
备忘录角色(Memento) ：用于存储Originator的内部状态，且可以防止Originator以外的对象进行访问；
备忘录管理员角色(Caretaker) ：负责存储，提供管理备忘录(Memento) ，无法对备忘录内容进行操作和访问。

二、备忘录模式的案例

对于我们程序员来说，可能天天都在使用备忘录模式，比如我们每天使用的Git、SVN都可以提供一种代码版本撤回的功能。还有一个比较贴切的现实场景应该是游戏的存档功能，通过将游戏当前进度存储到本地文件系统或数据库中，使得下次继续游戏时，玩家可以从之前的位置继续进行。备忘录模式适用于以下应用场景：

需要保存历史快照的场景；
希望在对象之外保存状态，且除了自己其他类对象无法访问状态保存具体内容。

1、利用压栈管理落地备忘录模式：

我们肯定都用过网页中的富文本编辑器，编辑器中的通常会附带草稿箱、撤销等这样的操作。下面我们用一段带代码来实现一个这样的功能。假设，我们在博客园中发布一篇文章，文章编辑的过程需要花很长时间，中间也会不停地撤销、修改。甚至可能要花好几天才能写出一篇精品文章，因此可能会将已经编辑好的内容实时保存到草稿箱。首先创建发起人角色编辑器Editor类：

//发起人角色(Originator)
public class Editor {
    private String title;
    private String content;
    private String imgs;

    public Editor(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;
    }

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

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

    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 "Editor{" +
                "title='" + title + '\'' +
                ", content='" + content + '\'' +
                ", imgs='" + imgs + '\'' +
                '}';
    }

}

再创建备忘录角色 ArticleMemento 类：

//备忘录角色(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 + '\'' +
                '}';
    }
}

最后创建备忘录管理员草稿箱 DraftsBox 类：

//备忘录管理员角色(Caretaker):草稿箱
public class DraftsBox {
    //采用容器，stack采用了后进先出的逻辑，有兴趣的可以看源码，很简单
    private final Stack<ArticleMemento> STACK = new Stack<ArticleMemento>();
   //取栈
    public ArticleMemento getMemento(){
        ArticleMemento articleMemento = STACK.pop();
        return articleMemento;
    }
   //压栈
    public void addMemento(ArticleMemento articleMemento){
        STACK.push(articleMemento);
    }
}

测试：

public class Test {
    public static void main(String[] args) {
    DraftsBox draftsBox = new DraftsBox();
    Editor editor = new Editor("备忘录模式",
            "备忘录模式(Memento Pattern) 又称为快照模式(Snapshot Pattern) 或令牌模式(Token Pattern) ",
            "1.png");

        ArticleMemento articleMemento = editor.saveToMemento();
        draftsBox.addMemento(articleMemento);

        System.out.println("标题：" + editor.getTitle() + "\n" +
                "内容：" + editor.getContent() + "\n" +
                "插图：" + editor.getImgs() + "\n暂存成功");

        System.out.println("完整的信息" + editor);


        System.out.println("==========第一次修改===========");
        editor.setTitle("备忘录模式");
        editor.setContent("备忘录模式(Memento Pattern) 又称为快照模式(Snapshot Pattern) 或令牌模式(Token Pattern) ， 是指在不破坏封装的前提下");

        System.out.println("===========第一次修改文章完成===========");

        System.out.println("完整的信息" + editor);

        articleMemento = editor.saveToMemento();
        draftsBox.addMemento(articleMemento);

        System.out.println("==========保存到草稿箱===========");


        System.out.println("==========第2次修改文章===========");
        editor.setTitle("备忘录模式1");
        editor.setContent("备忘录模式(Memento Pattern) 又称为快照模式(Snapshot Pattern) 或令牌模式(Token Pattern) ， 是指在不破坏封装的前提下， 捕获一个对象的内部状态，");
        System.out.println("完整的信息" + editor);
        System.out.println("==========第2次修改文章完成===========");

        System.out.println("==========第1次撤销===========");
       articleMemento = draftsBox.getMemento();
        editor.undoFromMemento(articleMemento);
        System.out.println("完整的信息" + editor);
        System.out.println("==========第1次撤销完成===========");


        System.out.println("==========第2次撤销===========");
    articleMemento = draftsBox.getMemento();
        editor.undoFromMemento(articleMemento);
        System.out.println("完整的信息" + editor);
        System.out.println("==========第2次撤销完成===========");

}
}

三、备忘录模式在源码中的体现

备忘录模式在源码中应用还是比较少见的，在spring的webflow源码中有一个StateManageableMessageContext接口中，有体现这个模式；

pring的webflow源码中StateManageableMessageContext接口

public interface StateManageableMessageContext extends MessageContext {

    Serializable createMessagesMemento();

    void restoreMessages(Serializable messagesMemento);

    void setMessageSource(MessageSource messageSource);
}

可以看到这里有一个createMessagesMemento()方法，创建一个消息备忘录。它的实现类：

public class DefaultMessageContext implements StateManageableMessageContext {

    private static final Log logger = LogFactory.getLog(DefaultMessageContext.class);

    private MessageSource messageSource;

    @SuppressWarnings("serial")
    private Map<Object, List<Message>> sourceMessages = new AbstractCachingMapDecorator<Object, List<Message>>(
            new LinkedHashMap<Object, List<Message>>()) {

        protected List<Message> create(Object source) {
            return new ArrayList<>();
        }
    };
    
    ...

    public void clearMessages() {
        sourceMessages.clear();
    }

    // implementing state manageable message context

    public Serializable createMessagesMemento() {
        return new LinkedHashMap<Object, List<Message>>(sourceMessages);
    }

    @SuppressWarnings("unchecked")
    public void restoreMessages(Serializable messagesMemento) {
        sourceMessages.putAll((Map<Object, List<Message>>) messagesMemento);
    }

    public void setMessageSource(MessageSource messageSource) {
        if (messageSource == null) {
            messageSource = new DefaultTextFallbackMessageSource();
        }
        this.messageSource = messageSource;
    }
    ...
}

我们看到其主要逻辑就相当于是给Message留一个备用，以备恢复之用。

四、总结

优点：

简化发起人实体类(Originator) 职责，隔离状态存储与获取，实现了信息的封装，客户端
无需关心状态的保存细节；
提供状态回滚功能；

缺点：

　　消耗资源：如果需要保存的状态过多时，每一次保存都会消耗很多内存。

GIT源码：https://github.com/ljx958720/design_patterns.git

码农公寓

一、定义

二、备忘录模式的案例

三、备忘录模式在源码中的体现

四、总结

相关文章