备忘录类

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

---

优点:实现新的封装和提供了状态恢复的实现机制

---

缺点:资源消耗过大

---

模式结构:

---

1.Originator(原发器)
保存内部状态的类称为原发器。原发器可以创建一个备忘录，并存储它的当前状态，也可以使用备忘录来恢复其内部状态。一句话，触发存储操作和恢复操作。

2.Memonto(备忘录)
备忘录对象不能直接被其他类使用，根据原发器来决定保存哪些内部状态。一句话，备忘录类，用来描述备忘录信息的类。

3.Caretaker(负责人)
负责人又称管理者，它负责保存备忘录，但不能对备忘录的内容进行检查或者操作。它可以保存一个或者多个备忘录对象。一句话，用于照顾历史信息的类。

---

示例
下棋例子，可以下棋，悔棋，撤销悔棋等

棋子类 Chessman，原发器角色

@Data
@AllArgsConstructor
class Chessman {
    private String label;
    private int x;
    private int y;

    //保存状态
    public ChessmanMemento save() {
        return new ChessmanMemento(this.label, this.x, this.y);
    }

    //恢复状态
    public void restore(ChessmanMemento memento) {
        this.label = memento.getLabel();
        this.x = memento.getX();
        this.y = memento.getY();
    }

    public void show() {
        System.out.println(String.format("棋子<%s>：当前位置为：<%d, %d>", this.getLabel(), this.getX(), this.getY()));
    }
}

备忘录角色 ChessmanMemento

@Data
@AllArgsConstructor
class ChessmanMemento {
    private String label;
    private int x;
    private int y;
}

负责人角色 MementoCaretaker

class MementoCaretaker {
    //定义一个集合来存储备忘录
    private ArrayList mementolist = new ArrayList();

    public ChessmanMemento getMemento(int i) {
        return (ChessmanMemento) mementolist.get(i);
    }

    public void addMemento(ChessmanMemento memento) {
        mementolist.add(memento);
    }
}

棋子客户端，维护了一个 MementoCaretaker 对象

class Client {
    private static int index = -1;
    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);
        chess.setX(5);
        play(chess);
        undo(chess, index);
        undo(chess, index);
        redo(chess, index);
        redo(chess, index);
    }

    //下棋，同时保存备忘录
    public static void play(Chessman chess) {
        mc.addMemento(chess.save());
        index++;
        chess.show();
    }

    //悔棋，撤销到上一个备忘录
    public static void undo(Chessman chess, int i) {
        System.out.println("******悔棋******");
        index--;
        chess.restore(mc.getMemento(i - 1));
        chess.show();
    }

    //撤销悔棋，恢复到下一个备忘录
    public static void redo(Chessman chess, int i) {
        System.out.println("******撤销悔棋******");
        index++;
        chess.restore(mc.getMemento(i + 1));
        chess.show();
    }
}

输出如下，悔棋成功，撤销悔棋成功

 

棋子<车>：当前位置为：<1, 1>
棋子<车>：当前位置为：<1, 4>
棋子<车>：当前位置为：<5, 4>
******悔棋******
棋子<车>：当前位置为：<1, 4>
******悔棋******
棋子<车>：当前位置为：<1, 1>
******撤销悔棋******
棋子<车>：当前位置为：<1, 4>
******撤销悔棋******
棋子<车>：当前位置为：<5, 4>

 

个人总结

当你的程序，需要对某些状态进行存档，取档的时候，备忘录模式就可以“粉墨登场"啦。

抽取变化：不存在变化与不变化，只是一种备忘的模块化。