行为型设计模式——备忘录模式

备忘录模式

备忘录模式提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用暂时存储起来的备忘录将状态复原，很多软件都提供了撤销（Undo）操作，如 Word、记事本、Photoshop、IDEA等软件在编辑时按 Ctrl+Z 组合键时能撤销当前操作，使文档恢复到之前的状态；还有在 浏览器 中的后退键、数据库事务管理中的回滚操作、玩游戏时的中间结果存档功能、数据库与操作系统的备份操作、棋类游戏中的悔棋功能等都属于这类。定义： 又叫快照模式，在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，以便以后当需要时能将该对象恢复到原先保存的状态。

备忘录模式的主要角色如下：

• 发起人（Originator）角色：记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，实现其他业务功能，它可以访问备忘录里的所有信息。
• 备忘录（Memento）角色：负责存储发起人的内部状态，在需要的时候提供这些内部状态给发起人。
• 管理者（Caretaker）角色：对备忘录进行管理，提供保存与获取备忘录的功能，但其不能对备忘录的内容进行访问与修改。

备忘录有两个等效的接口：

• 窄接口：管理者(Caretaker)对象（和其他发起人对象之外的任何对象）看到的是备忘录的窄接口(narror Interface)，这个窄接口只允许他把备忘录对象传给其他的对象。
• 宽接口：与管理者看到的窄接口相反，发起人对象可以看到一个宽接口(wide Interface)，这个宽接口允许它读取所有的数据，以便根据这些数据恢复这个发起人对象的内部状态。

案例实现

【例】游戏存档功能

游戏中的某个场景，一游戏角色有生命力、攻击力、防御力等数据，在打Boss前和后一定会不一样的，我们允许玩家如果感觉与Boss决斗的效果不理想可以让游戏恢复到决斗之前的状态。

要实现上述案例，有两种方式：

• “白箱”备忘录模式
• “黑箱”备忘录模式

“白箱”备忘录模式

备忘录角色对任何对象都提供一个接口，即宽接口，备忘录角色的内部所存储的状态就对所有对象公开。类图如下：

其实上面的RoleStateCaretaker类可以不要，它其实就维护了一个RoleStateMemento。其实RoleStateMemento就是我们所谓的数据对象，存储游戏中的关键数据，当需要存档时将游戏数据保存到一个新RoleStateMemento对象即可。代码如下：

首先得定义游戏角色类：

// 定义游戏角色类
public class GameRole {
    private int blood; //血量生命
    private int atk;  //攻击力
    private int def;  //防御力

    // 初始化状态
    public void initState(){
        this.blood =100;
        this.atk = 100;
        this.def = 100;
    }
    // 保存角色状态
    public RoleStateMemento saveState(){
        return new RoleStateMemento(blood,atk,def);
    }

    // 加载角色状态
    public void recoverState(RoleStateMemento roleStateMemento) {
        this.blood = roleStateMemento.getBlood();
        this.atk = roleStateMemento.getAtk();
        this.def = roleStateMemento.getDef();
    }

    // 显示角色状态
    public void showRoleState(){
        System.out.println("角色生命力：" + blood);
    }

    public void setBlood(int val){
        this.blood = val;
    }
}

然后我们定义游戏角色的关键信息数据对象：

public class RoleStateMemento {
    private int blood; //血量生命
    private int atk;  //攻击力
    private int def;  //防御力

    public RoleStateMemento(int blood, int atk, int def) {
        this.blood = blood;
        this.atk = atk;
        this.def = def;
    }

    public int getBlood() {
        return blood;
    }

    public int getAtk() {
        return atk;
    }

    public int getDef() {
        return def;
    }
}

然后再客户类中测试如下：

public class Main {
    public static void main(String[] args) {
        // 开始游戏
        GameRole role = new GameRole();
        role.initState();
        role.showRoleState();

        System.out.println("--------打boss受伤...");
        // 打boss，只剩下30血量
        role.setBlood(30);
        role.showRoleState();

        // 存档数据
        System.out.println("--------游戏存档...");
        RoleStateMemento roleStateMemento = role.saveState();

        // 继续战斗
        System.out.println("--------继续打boss");
        role.setBlood(0);
        role.showRoleState();
        System.out.println("--------战斗死亡！");

        // 恢复存档
        System.out.println("--------恢复存档...");
        role.recoverState(roleStateMemento);
        role.showRoleState();
    }
}

输出结果：

角色生命力：100
--------打boss受伤…
角色生命力：30
--------游戏存档…
--------继续打boss
角色生命力：0
--------战斗死亡！
--------恢复存档…
角色生命力：30

但是上面的实现就是非常不符合面向对象程序设计的封装性原则，因为游戏的数据对象RoleStateMemento直接暴露给调用者了，下面使用黑盒模式进行改进。

“黑箱”备忘录模式

备忘录角色对发起人对象提供一个宽接口，而为其他对象提供一个窄接口。在Java语言中，实现双重接口的办法就是将备忘录类设计成发起人类的内部成员类。将 RoleStateMemento 设为 GameRole 的内部类，从而将 RoleStateMemento 对象封装在 GameRole 里面；在外面提供一个标识接口 Memento 给 RoleStateCaretaker 及其他对象使用。这样 GameRole 类看到的是 RoleStateMemento 所有的接口，而RoleStateCaretaker 及其他对象看到的仅仅是标识接口 Memento 所暴露出来的接口，从而维护了封装型。类图如下：

同样，RoleStateCaretaker类也是可以不需要的，首先定义Memento接口，这个接口只是为了使用多态功能，即传参使用Memento来保护不直接使用ROleStateMemento泄露数据的风险，因为调用方拿到了Memento没有用。代码如下：

public interface Memento {
}

首先对GameRole类进行改造，将数据对象封装到内部类中，代码如下：

public class GameRole {
    private int blood; //血量生命
    private int atk;  //攻击力
    private int def;  //防御力

    // 初始化状态
    public void initState(){
        this.blood =100;
        this.atk = 100;
        this.def = 100;
    }
    // 保存角色状态
    public RoleStateMemento saveState(){
        return new RoleStateMemento(blood,atk,def);
    }

    // 加载角色状态
    public void recoverState(Memento memento) {
        // 要使用实现类必须强转
        RoleStateMemento roleStateMemento = (RoleStateMemento) memento;
        this.blood = roleStateMemento.getBlood();
        this.atk = roleStateMemento.getAtk();
        this.def = roleStateMemento.getDef();
    }

    // 显示角色状态
    public void showRoleState(){
        System.out.println("角色生命力：" + blood);
    }

    public void setBlood(int val){
        this.blood = val;
    }


    // 私有内部类，杜绝外部访问此类
    private class RoleStateMemento implements Memento{
        private int blood; //血量生命
        private int atk;  //攻击力
        private int def;  //防御力

        public RoleStateMemento(int blood, int atk, int def) {
            this.blood = blood;
            this.atk = atk;
            this.def = def;
        }

        public int getBlood() {
            return blood;
        }

        public int getAtk() {
            return atk;
        }

        public int getDef() {
            return def;
        }
    }

}

如此一来，调用者就无法获取到实际的数据对象，而只能获取他们的接口，然而接口是无法调用的，代码如下：

public class Main {
    public static void main(String[] args) {
        // 开始游戏
        GameRole role = new GameRole();
        role.initState();
        role.showRoleState();

        System.out.println("--------打boss受伤...");
        // 打boss，只剩下30血量
        role.setBlood(30);
        role.showRoleState();

        // 存档数据
        System.out.println("--------游戏存档...");
        // 如果没有Memento接口下面这个肯定报错，因为内部类是私有的
        // GameRole.RoleStateMemento roleStateMemento = role.saveState();
        Memento memento = role.saveState(); // 多态牛逼

        // 继续战斗
        System.out.println("--------继续打boss");
        role.setBlood(0);
        role.showRoleState();
        System.out.println("--------战斗死亡！");

        // 恢复存档
        System.out.println("--------恢复存档...");
        role.recoverState(memento);
        role.showRoleState();
    }
}

输出结果：

角色生命力：100
--------打boss受伤…
角色生命力：30
--------游戏存档…
--------继续打boss
角色生命力：0
--------战斗死亡！
--------恢复存档…
角色生命力：30

优点

• 提供了一种可以恢复状态的机制。当用户需要时能够比较方便地将数据恢复到某个历史的状态。
• 实现了内部状态的封装。除了创建它的发起人之外，其他对象都不能够访问这些状态信息。
• 简化了发起人类。发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。

缺点

• 资源消耗大。如果要保存的内部状态信息过多或者特别频繁，将会占用比较大的内存资源。

使用场景

• 需要保存与恢复数据的场景，如玩游戏时的中间结果的存档功能。

• 需要提供一个可回滚操作的场景，如 Word、记事本、Photoshop，idea等软件在编辑时按 Ctrl+Z 组合键，还有数据库中事务操作。

参考内容：

传智播客设计模式相关笔记（主要）