备忘录模式——java设计模式（二十）

简介

备忘录模式(Memento Pattern)：在不破坏封装性的前提下捕获一个对象内部的状态，并在对象之外保存这个状态，以便对象以后恢复到这一状态。

• 备忘录模式可以使系统恢复到某一历史时期的状态，又称标记模式。

结构和实现

• 角色包括：
  
  • 源发器：普通类，可以创建备忘录，也可以使用备忘录恢复状态。
  • 备忘录：储存原发器内部状态，处理原发器和负责人类，备忘录不直接和其他类交互。
  • 负责人：保存备忘录，但是不对备忘录操作或检查。
• 备忘录结构。
  
• 保证只有原发器可以访问和修改备忘录中的数据，而负责人不可以操作备忘录的状态:
  
  • 原发器和备忘录在一个包中，备忘录的方法使用默认修饰符，包可见。
  • 备忘录作为原发器的内部类，但是不提供set,get方法，只有外部类能访问内部类的属性。

实例

• 开发象棋软件，需要提供单步悔棋功能。
• 象棋软件结构。
  
• 客户端代码。

    public static void main(String args[]) {
        MementoCaretaker mc = new MementoCaretaker();
        Chessman chess = new Chessman("车", 1, 1);
        display(chess);
        mc.setMemento(chess.save()); //保存状态
        chess.setY(4);
        display(chess);
        mc.setMemento(chess.save()); //保存状态
        display(chess);
        chess.setX(5);
        display(chess);
        System.out.println("******悔棋******");
        chess.restore(mc.getMemento()); //恢复状态
        display(chess);
    }

多次撤销

• 需要定义一个集合存储多个备忘录，一个下标表示当前状态所处的位置。考虑操作过程中出现分支的情况，即还有未恢复的操作时，储存状态，这些未恢复的状态作废。
• 多次撤销结构。
  
• 负责人。

public class MementoCaretaker {

    private Stack<Chessman.ChessmanMemento> mementos;
    private int index;

    public MementoCaretaker() {
        index = -1;
        mementos = new Stack<>();
    }

    public Chessman.ChessmanMemento undo() {
        if (index >= 0) {
            index--;
        } else {
            index = 0;
        }
        return mementos.get(index);
    }

    public void save(Chessman.ChessmanMemento memento) {
        while (mementos.size() > index + 1) {
            mementos.pop();
        }
        mementos.push(memento);
        index++;
    }

    public Chessman.ChessmanMemento redo() {
        if (index + 1 < mementos.size()) {
            index++;
        } else {
            index = mementos.size() - 1;
        }
        return mementos.get(index);
    }

• 客户端调用。

public class Client {

    private static MementoCaretaker mc = new MementoCaretaker();

    public static void main(String args[]) {
        Chessman chess = new Chessman("车", 1, 1);
        play(chess);
        chess.setY(4);
        play(chess);
        play(chess);
        chess.setX(5);
        play(chess);
        undo(chess);
        undo(chess);
        chess.setX(10);
        chess.setY(10);
        play(chess);
        redo(chess);

    }

    private static void play(Chessman chess) {
        System.out.println("******下棋******");
        mc.save(chess.save()); //保存状态
        display(chess);
    }

    private static void undo(Chessman chess) {
        System.out.println("******悔棋******");
        chess.restore(mc.undo()); //恢复状态
        display(chess);
    }

    private static void redo(Chessman chess) {
        System.out.println("******撤销悔棋******");
        chess.restore(mc.redo()); //恢复状态
        display(chess);
    }

    private static void display(Chessman chess) {
        System.out.println("棋子" + chess.getLabel() + "当前位置为：" + "第" + chess.getX() + "行" + "第" + chess.getY() + "列。");
    }
}

优缺点和适用范围

• 优点：
  
  • 提供状态恢复。对象恢复到特定的历史步骤。
  • 封装信息。备忘录保存了原发器的状态，并且只有原发器可以改动。
• 缺点：
  
  • 资源消耗大。特别是保存的原发器类的对象较多时，需要占据内存，保存操作也需要开销。
• 适用范围：
  
  • 需要实现撤销操作。
  • 需要封装对象的历史状态，并且避免暴露给其他对象。

jdk中的应用

• Date类通过fastTime这一变量保存历史时间。

public class Date
    implements java.io.Serializable, Cloneable, Comparable<Date>
{
    private transient long fastTime;
}