设计模式——Memento(备忘录)模式

前言

有时有必要记录一个对象的内部状态，以方便用户从错误中恢复过来。比如访问浏览器要求实现后退和撤销功能等。

1 定义

Memento(备忘录)模式：在不破坏封装性前提下，获取对象内部状态并外部保存，以方便日后恢复对象状态。

2 适用情况

• 当需要保存一个对象的内部状态，以方便后续在用户出错时进行恢复。
• 如果一个接口让其它对象直接获取内部状态，又要不破坏对象的封装性。

3 结构

3.1 结构图

Memento备忘录模式结构图：

3.2 参与者

• Memento：备忘录，备份Orginator的内部state，在需要时根据备忘录进行恢复。
• Orginator：原发器，用于创建备忘录，在需要时恢复状态。
• CareTaker：存储备忘录，可以根据原发器需要进行恢复和撤销操作等。

4 应用举例

自定义浏览器撤销，恢复操作。

4.1 Memento和MementoCare

定义如下：

@Data
public class MementoCare {

    /**
     * 维护访问历史
     */
    static List<Memento> history = new ArrayList<>();
    /**
     * 当前的访问索引
     */
    static volatile int cursor = -1;

    static void addMemento(Memento memento) {
        history.add(memento);
        cursor++;
    }

    static Memento restoreMemento() {
        cursor--;
        if (cusor>history.size()) {
            return history.get(history.size()-1);
        }
        return history.get(cursor);
    }

    static Memento undoMemento() {
        cursor++;
        if (cusor>history.size()) {
            return history.get(history.size()-1);
        }
        return history.get(cursor);
    }

    /**
     * 维护一个内部静态类记录浏览记录和名称
     */
    @Data
    @AllArgsConstructor
    @NoArgsConstructor
    static class Memento {
        private String url;
        private String name;

    }
}

维护备忘录列表，定义恢复和撤销操作。

4.2 Orginator——UrlEntity

定义如下：

@Data
@AllArgsConstructor
@NoArgsConstructor
public class UrlEntity {
    private String url;
    private String name;

    public void createMemento(){
        MementoCare.addMemento(new MementoCare.Memento(url, name));
    }

    public void restoreMemento() {
        MementoCare.Memento memento = MementoCare.restoreMemento();
        setUrl(memento.getUrl());
        setName(memento.getName());
    }

    public void undoMemento() {
        MementoCare.Memento memento = MementoCare.undoMemento();
        setUrl(memento.getUrl());
        setName(memento.getName());
    }

    public void printVisit() {
        String context = "你正在访问：" + name + "——" + url;
        System.out.println(context);
    }
}

定义创建备忘录操作，调用MementoCare处理恢复和撤销操作。

4.3 Client——ClientTest

测试如下：

public class ClientTest {
    public static void main(String[] args) {
        UrlEntity urlEntity = new UrlEntity("www.baidu.com", "百度");
        urlEntity.printVisit();
        urlEntity.createMemento();
        urlEntity.setUrl("www.google.com");
        urlEntity.setName("谷歌");
        urlEntity.printVisit();
        urlEntity.createMemento();
        urlEntity.setUrl("www.alipay.com");
        urlEntity.setName("支付宝");
        urlEntity.printVisit();
        urlEntity.createMemento();
        System.out.println("********恢复上次浏览*******");
        urlEntity.restoreMemento();
        urlEntity.printVisit();
        System.out.println("********恢复上次浏览*******");
        urlEntity.restoreMemento();
        urlEntity.printVisit();
        System.out.println("********撤销操作*******");
        urlEntity.undoMemento();
        urlEntity.printVisit();
        System.out.println("********撤销操作*******");
        urlEntity.undoMemento();
        urlEntity.printVisit();

    }
}

运行结果：

5 总结

当需要保存对象内部状态，并在需要时恢复和撤销操作，可以使用备忘录模式。

参考文献

[1]. 《设计模式》