设计模式之备忘录模式

备忘录模式（Memento）:在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样以后就可以将该对象恢复到原先保存的状态。

作为一名码农，当你辛辛苦苦忙了一天，写了若干行代码，一不小心点了退出IDE，所有的劳动都付之东流，但此时的你，要是有随时往svn或者git上提交代码的习惯，恭喜你，你的代码可以回来了。这就是备忘录模式的必要性。

所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。其UML图如下：

发起人（Originator）：负责创建一个备忘录，用以记录当前时刻它的内部状态，并可以使用备忘录恢复内部状态。可根据需要决定Memento存储Originator的那些内部状态。

备忘录（Memento）：负责存储Originator对象的内部状态，并可防止Originator以外的其他对象访问备忘录Memento。备忘录有两个接口，Caretaker只能看到备忘录的窄接口，只能将备忘录传递给其他对象。Originator能够看到一个宽接口，允许他访问返回到先前状态所需要的数据。

负责人（CareTaker）：负责保存好备忘录。不能对备忘录的内容进行修改。只能传递备忘录给其他对象。

基本代码：
Originator：

class Originator{
    private String state;

    public Memento CreateMemento(){
        return new Memento(state);
    }

    public void setMemento(Memento memento){
        state = memento.getState();
    }

    public void show(){
        System.out.println("state is "+state);
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
}

Memento部分

class Memento{
    private String state;

    public Memento(String state) {
        this.state = state;
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
}

CareTaker部分：

class CareTaker{
    private Memento memento;

    public Memento getMemento() {
        return memento;
    }

    public void setMemento(Memento memento) {
        this.memento = memento;
    }
}

客户端测试：

public class test {
    public static void main(String[] args) {
        Originator o = new Originator();
        o.setState("1");
        o.show();

        CareTaker c1= new CareTaker();
        c1.setMemento(o.CreateMemento());

        o.setState("2");
        o.show();

        o.setMemento(c1.getMemento());
        o.show();
    }
}

运行结果：

二、案列分析

《西游记》第二十四回《万寿山大仙留故友　五庄观行者窃人参》中，孙悟空把镇元大仙的人参树给推倒了，到处寻找救树之法，幸得观音菩萨解救，才解了这围，也是这树矫情：

这宝贝三千年一开花，三千年一结果，再三千年方得成熟。短头一万年，只结得三十个。

也难怪大仙和师徒四人不依不饶，这树直接就被推倒了，假若我们把这颗树的不同状态，都装在一个备忘录里，当孙悟空推倒了这树以后，在备忘录中取出想要的状态的树，这树岂不是就活了么？ 其UML图如下：

代码部分：

Originator类—人参树

class RenshenShu{
    private String state;

    public Memento CreateMemento(){
        return new Memento(state);
    }

    public void setMemento(Memento memento){
        state = memento.getState();
    }

    public void show(){
        System.out.println("我是一棵树，正在"+state);
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
}

备忘录类

class Memento{
    private String state;

    public Memento(String state) {
        this.state = state;
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
}

CareTaker–菩萨

class CareTaker{
    private Memento memento;

    public Memento getMemento() {
        return memento;
    }

    public void setMemento(Memento memento) {
        this.memento = memento;
    }
}

故事上演：

public class Story{
    public static void main(String[] args) {

        RenshenShu o = new RenshenShu();
        o.setState("开花");
        o.show();

        CareTaker c1= new CareTaker();
        c1.setMemento(o.CreateMemento());

        o.setState("结果");
        o.show();

        CareTaker c2= new CareTaker();
        c2.setMemento(o.CreateMemento());

        o.setState("成熟");
        o.show();

        CareTaker c3= new CareTaker();
        c3.setMemento(o.CreateMemento());

        o.setState("被孙悟空推倒");
        o.show();

        CareTaker c4= new CareTaker();
        c4.setMemento(o.CreateMemento());

        o.setMemento(c3.getMemento());
        o.show();
    }
}

运行结果：

代码地址：Memento

当人参树被孙悟空推倒后，只要从Caretaker中取出推到之前的状态，就能恢复原状！

三、模式结语

备忘录模式给用户提供了一种可以恢复状态的机制。可以是用户能够比较方便地回到某个历史的状态。

欢迎大家留言评论，点击查看更多设计模式。