二、22【设计模式】之备忘录模式

今天的博客主题

       设计模式 ——》 设计模式之备忘录模式

---

备忘录模式 MP （Memento Pattern）

 

定义

保存一个对象的某个状态，以便在适当的时候恢复对象。其主要是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。

是一种有撤销、回退的机制，通过存储系统各个历史状态的快照，可以回滚到某一个历史状态。

 

应用场景

1）需要保存历史快照的场景。

2）在对象之外保存状态，除了自己其他对象无法访问状态保存具体内容。

3）

生活中的场景例子还是有的，比如 git 提供了一种代码版本回滚的功能，还有象棋游戏里的悔棋操作

 

优点

1）提供了一种状态恢复的实现机制，可以方便地回到一个特定的历史步骤。

2）实现了信息的封装，客户端无需关心状态的保存细节，简化发起人是实体类的职责，隔离状态存储与获取。

3）

 

缺点

资源消耗过大，如果需要保存的原发器类的成员变量太多，就不可避免需要占用大量的存储空间，每保存一次对象的状态都需要消耗一定的系统资源

 

源码中的应用

该模式的具体应用在源码中非常少见。

 

代码示例

备忘录模式主要包含三个角色

发起人角色（Originator）：负责创建一个备忘录，记录自身需要保存的状态。

备忘录角色（Memento）：用于存储发起人角色的内部状态，且可以防止发起人角色以外的对象访问

备忘录管理员角色（Caretaker）：负责存储，提供管理备忘录，无法对备忘内容操作和访问。

// 发起人角色，需要被回滚的对象
class Originator{

    private String str;

    public String getStr() {
        return str;
    }

    public void setStr(String str) {
        this.str = str;
    }

    public Memento saveToMemento(){
        Memento memento = new Memento(this.str);
        return memento;
    }

    public void undoLastTime(Memento memento){
        this.str = memento.getStr();
    }

    @Override
    public String toString() {
        return "Originator{" +
                "str='" + str + '\'' +
                '}';
    }
}

// 备忘录角色
class Memento{

    private String str;

    public String getStr() {
        return str;
    }

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

    @Override
    public String toString() {
        return "Memento{" +
                "str='" + str + '\'' +
                '}';
    }
}

// 备忘录管理角色，记录每一个版本
class Caretaker{

    // 利用栈的一个 后进先出 特性
    private Stack<Memento> mementoStack = new Stack<>();

    public Memento getMemento(){
        return mementoStack.pop();
    }

    public void addMemento(Memento memento){
        mementoStack.push(memento);
    }
}

// 客户端调用
public class MementoPatternSample {
    public static void main(String[] args) {
        // 声明备忘录管理员
        Caretaker caretaker = new Caretaker();

        // 发起人
        Originator originator = new Originator();
        originator.setStr("a");

        // 开始备忘
        Memento memento = originator.saveToMemento();
        caretaker.addMemento(memento);
        System.out.println("1当前对象完整信息：" + originator);

        originator.setStr("ab");
        memento = originator.saveToMemento();
        caretaker.addMemento(memento);
        System.out.println("2当前对象完整信息：" + originator);

        originator.setStr("abc");
        memento = originator.saveToMemento();
        caretaker.addMemento(memento);
        System.out.println("3当前对象完整信息：" + originator);

        originator.setStr("abc123");
        originator.saveToMemento();
        System.out.println("4当前对象完整信息：" + originator);

        memento = caretaker.getMemento();
        originator.undoLastTime(memento);
        System.out.println("撤销1次之后完整信息：" + originator);

        memento = caretaker.getMemento();
        originator.undoLastTime(memento);
        System.out.println("撤销2次之后完整信息：" + originator);
    }
}

// 输出结果
1当前对象完整信息：Originator{str='a'}
2当前对象完整信息：Originator{str='ab'}
3当前对象完整信息：Originator{str='abc'}
4当前对象完整信息：Originator{str='abc123'}
撤销1次之后完整信息：Originator{str='abc'}
撤销2次之后完整信息：Originator{str='ab'}

---