备忘录模式

目录

• 备忘录模式
  • 案例
  • 模式介绍
  • 代码改造
  • 模式应用
  • 总结
  • 参考资料

备忘录模式

案例

张三一天在下班回家后，想放松一下，于是打开了电脑继续昨天没有挑战成功的 Boos 游戏关卡。这个游戏关卡相当的困难，张三已经打了很多天了还是没有挑战成功，但是还好张三可以保存他在挑战 Boss 之前的状态，不然的话他刚刚得到的幸运道具提升的角色状态就会被 Boss 打掉了。下面用代码的形式来模拟这一过程：

1.首先是玩家类：

/**
 * 游戏玩家角色类
 */
public class Player {
    // 玩家姓名
    private String name;
    // 生命值
    private int vitality;
    // 法力值
    private int mana;
    // 攻击值
    private int attack;
    // 防御值
    private int defense;

    public Player(String name) {
        this.name = name;
        // 创建玩家时初始化各个状态值
        this.vitality = 50;
        this.mana = 50;
        this.attack = 50;
        this.defense = 50;
        show();
    }

    public void show() {
        System.out.println("玩家{" +
                "姓名='" + name + '\'' +
                ", 生命值=" + vitality +
                ", 法力值=" + mana +
                ", 攻击值=" + attack +
                ", 防御值=" + defense +
                '}');
    }

    // 省略 getter/setter
}

2.模拟游戏过程：

public class Main {
    public static void main(String[] args) {
        Player player = new Player("张三");
        System.out.println("玩家[" + player.getName() + "]获得幸运道具奖励，状态提升↑");
        player.setVitality(100);
        player.setMana(100);
        player.setAttack(100);
        player.setDefense(100);
        System.out.println("提升后各状态值：");
        player.show();
        System.out.println("玩家将与 Boss PK，先保存一下获得幸运道具时的状态");
        Player backup = new Player(player.getName());
        backup.setVitality(player.getVitality());
        backup.setMana(player.getMana());
        backup.setAttack(player.getAttack());
        backup.setDefense(player.getDefense());
        System.out.println("玩家[" + player.getName() + "]与 Boss PK，状态下降↓");
        player.setVitality(0);
        player.setMana(0);
        player.setAttack(10);
        player.setDefense(10);
        System.out.println("下降后各状态值：");
        player.show();
        System.out.println("玩家恢复到获得幸运道具时的状态");
        player.setVitality(backup.getVitality());
        player.setMana(backup.getMana());
        player.setAttack(backup.getAttack());
        player.setDefense(backup.getDefense());
        System.out.println("恢复后各状态：");
        player.show();
    }
}

3.模拟结果

玩家{姓名='张三', 生命值=50, 法力值=50, 攻击值=50, 防御值=50}
玩家[张三]获得幸运道具奖励，状态提升↑
提升后各状态值：
玩家{姓名='张三', 生命值=100, 法力值=100, 攻击值=100, 防御值=100}
玩家将与 Boss PK，先保存一下获得幸运道具时的状态
玩家{姓名='张三', 生命值=50, 法力值=50, 攻击值=50, 防御值=50}
玩家[张三]与 Boss PK，状态下降↓
下降后各状态值：
玩家{姓名='张三', 生命值=0, 法力值=0, 攻击值=10, 防御值=10}
玩家恢复到获得幸运道具时的状态
恢复后各状态：
玩家{姓名='张三', 生命值=100, 法力值=100, 攻击值=100, 防御值=100}

可以看到，因为张三在打 Boss 之前保存了之前的状态，在挑战失败后也可以恢复到之前的状态。这种方式与设计模式中的备忘录模式的思想非常相似，下面就来介绍一下备忘录模式。

模式介绍

备忘录模式（Memento Pattern）又叫做快照模式（Snapshot Pattern）或Token模式，是GoF的23种设计模式之一，属于行为模式。

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

角色构成

• Originator（原发器）：它是一个普通类，可以创建一个备忘录，并存储它的当前内部状态，也可以使用备忘录来恢复其内部状态，一般将需要保存内部状态的类设计为原发器。
• Memento（备忘录)：存储原发器的内部状态，根据原发器来决定保存哪些内部状态。备忘录的设计一般可以参考原发器的设计，根据实际需要确定备忘录类中的属性。需要注意的是，除了原发器本身与负责人类之外，备忘录对象不能直接供其他类使用，原发器的设计在不同的编程语言中实现机制会有所不同。
• Caretaker（负责人）：负责人又称为管理者，它负责保存备忘录，但是不能对备忘录的内容进行操作或检查。在负责人类中可以存储一个或多个备忘录对象，它只负责存储对象，而不能修改对象，也无须知道对象的实现细节。

UML类图

在使用备忘录模式时，首先应该存在一个原发器类Originator，在真实业务中，原发器类是一个具体的业务类，它包含一些用于存储成员数据的属性。对于备忘录类Memento而言，它通常提供了与原发器相对应的属性（可以是全部，也可以是部分）用于存储原发器的状态。对于负责人类Caretaker，它用于保存备忘录对象，并提供getMemento()方法用于向客户端返回一个备忘录对象，原发器通过使用这个备忘录对象可以回到某个历史状态。

代码改造

下面就通过代码来对上面的案例进行改造：

1.原发器类，很明显就是这里的玩家角色类：

/**
 * 原发器类
 */
public class Player {
    // 玩家姓名
    private String name;
    // 生命值
    private int vitality;
    // 法力值
    private int mana;
    // 攻击值
    private int attack;
    // 防御值
    private int defense;

    public Player(String name) {
        this.name = name;
        // 创建玩家时初始化各个状态默认值
        this.vitality = 50;
        this.mana = 50;
        this.attack = 50;
        this.defense = 50;
        show();
    }

    // 创建一个备忘录对象
    public Memento createMemento() {
        return new Memento(this);
    }

    // 根据备忘录对象恢复原发器状态
    public void restoreMemento(Memento memento) {
        this.name = memento.getName();
        this.vitality = memento.getVitality();
        this.mana = memento.getMana();
        this.attack = memento.getAttack();
        this.defense = memento.getDefense();
    }

    public void show() {
        System.out.println("玩家{" +
                "姓名='" + name + '\'' +
                ", 生命值=" + vitality +
                ", 法力值=" + mana +
                ", 攻击值=" + attack +
                ", 防御值=" + defense +
                '}');
    }

    // 省略 getter/setter...
}

2.备忘录类：

/**
 * 备忘录角色类
 */
public class Memento {
    // 玩家姓名
    private String name;
    // 生命值
    private int vitality;
    // 法力值
    private int mana;
    // 攻击值
    private int attack;
    // 防御值
    private int defense;

    public Memento(Player player) {
        this.name = player.getName();
        this.vitality = player.getVitality();
        this.mana = player.getMana();
        this.attack = player.getAttack();
        this.defense = player.getDefense();
    }

	// 省略 getter/setter...
}

3.负责人类：

/**
 * 负责人类
 */
public class Caretaker {
    private Memento memento;

    public Memento getMemento() {
        return memento;
    }

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

4.模拟过程：

public class Main {
    public static void main(String[] args) {
        Caretaker caretaker = new Caretaker();
        Player player = new Player("张三");
        System.out.println("玩家[" + player.getName() + "]获得幸运道具奖励，状态提升↑");
        player.setVitality(100);
        player.setMana(100);
        player.setAttack(100);
        player.setDefense(100);
        System.out.println("提升后各状态值：");
        player.show();
        System.out.println("玩家将与 Boss PK，先保存一下获得幸运道具时的状态");
        caretaker.setMemento(player.createMemento());
        System.out.println("玩家[" + player.getName() + "]与 Boss PK，状态下降↓");
        player.setVitality(0);
        player.setMana(0);
        player.setAttack(10);
        player.setDefense(10);
        System.out.println("下降后各状态值：");
        player.show();
        System.out.println("玩家恢复到获得幸运道具时的状态");
        player.restoreMemento(caretaker.getMemento());
        System.out.println("恢复后各状态：");
        player.show();
    }
}

5.模拟结果：

玩家{姓名='张三', 生命值=50, 法力值=50, 攻击值=50, 防御值=50}
玩家[张三]获得幸运道具奖励，状态提升↑
提升后各状态值：
玩家{姓名='张三', 生命值=100, 法力值=100, 攻击值=100, 防御值=100}
玩家将与 Boss PK，先保存一下获得幸运道具时的状态
玩家[张三]与 Boss PK，状态下降↓
下降后各状态值：
玩家{姓名='张三', 生命值=0, 法力值=0, 攻击值=10, 防御值=10}
玩家恢复到获得幸运道具时的状态
恢复后各状态：
玩家{姓名='张三', 生命值=100, 法力值=100, 攻击值=100, 防御值=100}

可以看到效果是一样的，但是使用了备忘录模式之后，他将恢复前的状态用备忘录类Memento类来进行保存，在恢复时用负责人类Caretaker类进行保存备忘录，使得类之间的职责更加清晰。

模式应用

备忘录模式在很多软件的使用过程中普遍存在，但是在应用软件开发中，它的使用频率并不太高，因为现在很多基于窗体和浏览器的应用软件并没有提供撤销操作。如果需要为软件提供撤销功能，备忘录模式无疑是一种很好的解决方案。在一些字处理软件、图像编辑软件、数据库管理系统等软件中备忘录模式都得到了很好的应用。下面列举一些备忘录思想的场景：浏览器回退、数据库备份与还原、编辑器撤销与重做、棋牌游戏悔棋等。

总结

1.主要优点

• 它提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用暂时存储起来的备忘录将状态复原。
• 备忘录实现了对信息的封装，一个备忘录对象是一种原发器对象状态的表示，不会被其他代码所改动。备忘录保存了原发器的状态，采用列表、堆栈等集合来存储备忘录对象可以实现多次撤销操作。

2.主要缺点

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

3.适用场景

• 保存一个对象在某一个时刻的全部状态或部分状态，这样以后需要时它能够恢复到先前的状态，实现撤销操作。
• 防止外界对象破坏一个对象历史状态的封装性，避免将对象历史状态的实现细节暴露给外界对象。

参考资料

• 大话设计模式
• 设计模式Java版本-刘伟
• 设计模式 | 备忘录模式及典型应用

本篇文章github代码地址：https://github.com/Phoegel/design-pattern/tree/main/memento
转载请说明出处，本篇博客地址：https://www.cnblogs.com/phoegel/p/14231930.html