设计模式-备忘录模式

备忘录模式介绍

备忘录模式（Memento Pattern）是一种行为模式。用于保存一个对象的当前状态，以便在适当的时候恢复对象。例如：浏览器回退、编辑器撤销与重做、虚拟机生成快照与恢复、游戏悔棋等。

备忘录模式定义

在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。

备忘录模式使用场景

需要保存/恢复数据的相关状态场景。

备忘录模式 UML 类图

角色介绍：

Originator：原发器，真正要被保存或恢复的对象，其负责创建一个备忘录，可以存储、恢复需要状态信息。
Memento：备忘录角色，用于存储 Originator 的内部状态。防止外部直接访问 Originator。
Caretaker：管理者，负责存储备忘录，但不能对备忘录的内容进行操作和访问，只能够将备忘录传递给其他对象。

备忘录模式示例

这里以下棋为例，下棋支持悔棋，撤销悔棋操作。
原发器角色
棋子类 Chessman，包含棋子名称，棋子所在棋盘位置状态。

public class Chessman {
    String label;
    int x;
    int y;

    public Chessman(String label, int x, int y) {
        this.label = label;
        this.x = x;
        this.y = y;
    }

    // 创建备忘录
    public Memento save() {
        return new Memento(label, x, y);
    }

    // 恢复状态
    public void restore(Memento memento) {
        label = memento.label;
        x = memento.x;
        y = memento.y;
    }

    @Override
    public String toString() {
        return "Chessman{" +
                "label='" + label + '\'' +
                ", x=" + x +
                ", y=" + y +
                '}';
    }
}

备忘录角色
存储棋子的状态

public class Memento {
    String label;
    int x;
    int y;

    public Memento(String label, int x, int y) {
        this.label = label;
        this.x = x;
        this.y = y;
    }
}

管理者角色
管理备忘录，负责备忘录的存取。

public class Caretaker {
    // 备忘录列表
    List mementos = new ArrayList<>();

    // 存档
    public void archive(Memento memento) {
        mementos.add(memento);
    }

    // 获取存档
    public Memento getMemento(int index) {
        return mementos.get(index);
    }
}

客户端

public class Client {
    private static Caretaker caretacker = new Caretaker();
    private static int step = 0;

    public static void main(String[] args) {
        Chessman chessman = new Chessman("车", 0, 0);
        System.out.println(chessman);
        // 走车，位置(5,0)
        playChess(chessman, 5, 0);
        // 走车，位置(5,10)
        playChess(chessman, 5, 10);
        // 走错了，悔棋
        undoChess(chessman);
        // 悔错了，撤销悔棋
        redoChess(chessman);
    }

    // 走一步
    public static void playChess(Chessman chessman, int x, int y) {
        chessman.x = x;
        chessman.y = y;
        caretacker.archive(chessman.save());
        step++;
        System.out.println(chessman);
    }

    // 悔棋
    public static void undoChess(Chessman chessman) {
        System.out.println("悔棋");
        step--;
        chessman.restore(caretacker.getMemento(step - 1));
        System.out.println(chessman);
    }

    // 撤销悔棋
    public static void redoChess(Chessman chessman) {
        System.out.println("撤销悔棋");
        step++;
        chessman.restore(caretacker.getMemento(step - 1));
        System.out.println(chessman);
    }
}

输出结果如下：

Chessman{label='车', x=0, y=0}
Chessman{label='车', x=5, y=0}
Chessman{label='车', x=5, y=10}
悔棋
Chessman{label='车', x=5, y=0}
撤销悔棋
Chessman{label='车', x=5, y=10}

备忘录模式总结

优点

给用户提供了一种可以恢复状态的机制，使用户能够方便地回到某个历史状态。
实现了信息的封装，使用户无需关系状态的保存细节。

缺点
资源消耗过大，如果需要保存的原发器类的成员变量太多，势必会占用比较大的存储空间，而且每保存一次对象的状态都需要消耗一定的内存。

Android 源码中备忘录模式

Android 源码中 Activity 异常关闭后需要恢复之前的状态，此处就使用了备忘录模式，具体请参考Activity源码分析-状态保存及恢复文章。
这个过程 Activity 扮演了 Caretaker 角色，负责存储和恢复 UI 的状态信息；Activity、View 体系、Fragment 对象为 Originator 角色，也就是要存储状态的对象；Bundle 充当 Memento 角色。