备忘录模式(Memento)

备忘录模式(Memento)

1.意图

在不破坏封装性的前提下,捕获一个对象的内部状态,并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态。
有时有必要记录一个对象的内部状态。为了允许用户取消不确定的操作或从错误中恢复过来,需要实现检查点和取消机制 , 而要实现这些机制,你必须事先将状态信息保存在某处,这样才能将对象恢复到它们先前的状态。
在以下情况下使用备忘录模式:
• 必须保存一个对象在某一个时刻的 (部分)状态, 这样以后需要时它才能恢复到先前的状态。
• 如果一个用接口来让其它对象直接得到这些状态,将会暴露对象的实现细节并破坏对象的封装性。

2.特点

• Memento(备忘录)
— 备忘录存储原发器对象的内部状态。原发器根据需要决定备忘录存储原发器的哪些内部状态。
— 防止原发器以外的其他对象访问备忘录。备忘录实际上有两个接口,
管理者( Caretaker)只能看到备忘录的窄接口 — 它只能将备忘录传递给其他对象。
原发器能够看到一个宽接口, 允许它访问返回到先前状态所需的所有数据。理想的情况是只允许生成本备忘录的那个原发器访问本备忘录的内部状态。
• Originator(原发器)
— 原发器创建一个备忘录 ,用以记录当前时刻它的内部状态。
— 使用备忘录恢复内部状态 .。
• Caretaker(负责人)
— 负责保存好备忘录。
— 不能对备忘录的内容进行操作或检查。

• 管理器向原发器请求一个备忘录 , 保留一段时间后 ,将其送回给原发器 ,有时管理者不会将备忘录返回给原发器 , 因为原发器可能根本不需要退到先前的状态。
• 备忘录是被动的。只有创建备忘录的原发器会对它的状态进行赋值和检索。

3.UML类图

4.代码

/**
 * • Memento(备忘录)
 — 备忘录存储原发器对象的内部状态。原发器根据需要决定备忘录存储原发器的哪些内部状态。
 — 防止原发器以外的其他对象访问备忘录。备忘录实际上有两个接口,
 */
public 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;
    }
}

/**
 * • Originator(原发器)
 — 原发器创建一个备忘录 ,用以记录当前时刻它的内部状态。
 — 使用备忘录恢复内部状态 .。
 */
public class Originator {
    private String state;


    public Memento createMemento(){
        return new Memento(this.state);
    }
    public void restoreMemento(Memento memento){
        this.state = memento.getState();
    }
    public String getState() {
        return state;
    }

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

/**
 * Caretaker(负责人)
 — 负责保存好备忘录。
 — 不能对备忘录的内容进行操作或检查。
 */
public class Caretaker {
    private HashMap<String,Memento> map = new HashMap<String,Memento>();

    public void setMemento(String key,Memento memento) {
        map.put(key,memento);
    }
    public Memento getMemento(String key) {
        return map.get(key);
    }

    public void showMemento(){
        map.forEach((String key,Memento memento)->{
            System.out.println(key+":"+memento.getState());
        });
    }
}

public class MementoTest {
    public static void main(String[] args) {
        Caretaker caretaker = new Caretaker();

        Originator originator = new Originator();
        originator.setState("状态1");
        caretaker.setMemento("A",originator.createMemento());
        originator.setState("状态2");
        caretaker.setMemento("B",originator.createMemento());

        caretaker.showMemento();
        originator.restoreMemento(caretaker.getMemento("A"));
        System.out.println(originator.getState());
    }
}