设计模式(二十二)：行为型之备忘录模式

设计模式系列文章

设计模式(一)：创建型之单例模式

设计模式(二、三)：创建型之工厂方法和抽象工厂模式

设计模式(四)：创建型之原型模式

设计模式(五)：创建型之建造者模式

设计模式(六)：结构型之代理模式

设计模式(七)：结构型之适配器模式

设计模式(八)：结构型之装饰器模式

设计模式(九)：结构型之桥接模式

设计模式(十)：结构型之外观模式

设计模式(十一)：结构型之组合模式

设计模式(十二)：结构型之享元模式

设计模式(十三)：行为型之模板方法模式

设计模式(十四)：行为型之策略模式

设计模式(十五)：行为型之命令模式

设计模式(十六)：行为型之责任链模式

设计模式(十七)：行为型之状态模式

设计模式(十八)：行为型之观察者模式

设计模式(十九)：行为型之中介者模式

设计模式(二十)：行为型之迭代器模式

设计模式(二十一)：行为型之访问者模式

设计模式(二十二)：行为型之备忘录模式

设计模式(二十三)：行为型之解释器模式

---

---

一、设计模式分类

• 创建型模式
  • 用于描述“怎样创建对象”，它的主要特点是“将对象的创建与使用分离”
  • 提供了单例、原型、工厂方法、抽象工厂、建造者 5 种创建型模式
• 结构型模式
  • 用于描述如何将类或对象按某种布局组成更大的结构
  • 提供了代理、适配器、桥接、装饰、外观、享元、组合 7 种结构型模式
• 行为型模式
  • 用于描述类或对象之间怎样相互协作共同完成单个对象无法单独完成的任务，以及怎样分配职责
  • 提供了模板方法、策略、命令、职责链、状态、观察者、中介者、迭代器、访问者、备忘录、解释器 11 种行为型模式

二、备忘录模式

1、概述

• 备忘录模式提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤
• 例如很多软件都提供了撤销（Undo）操作，如 Word、记事本、Photoshop、IDEA等软件在编辑时按 Ctrl+Z 组合键时能撤销当前操作

定义

• 又叫快照模式
• 在不破坏封装性的前提下，捕获一个对象的内部状态
• 并在该对象之外保存这个状态，以便以后当需要时能将该对象恢复到原先保存的状态

2、结构

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

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

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

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

3、实现

【例】游戏挑战BOSS

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

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

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

3.1、“白箱”备忘录模式

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

代码如下：

• 游戏角色类(属于发起人角色)

@Data
public class GameRole {
    private int vit; //生命力
    private int atk; //攻击力
    private int def; //防御力

    //初始化内部状态
    public void initState() {
        this.vit = 100;
        this.atk = 100;
        this.def = 100;
    }

    //战斗
    public void fight() {
        this.vit = 0;
        this.atk = 0;
        this.def = 0;
    }

    //保存角色状态功能
    public RoleStateMemento saveState() {
        return new RoleStateMemento(vit,atk,def);
    }

    //恢复角色状态
    public void recoverState(RoleStateMemento roleStateMemento) {
        //将备忘录对象中存储的状态赋值给当前对象的成员
        this.vit = roleStateMemento.getVit();
        this.atk = roleStateMemento.getAtk();
        this.def = roleStateMemento.getDef();
    }

    //展示状态功能
    public void stateDisplay() {
        System.out.println("角色生命力：" + vit);
        System.out.println("角色攻击力：" + atk);
        System.out.println("角色防御力：" + def);
    }
}

• 游戏状态存储类(备忘录类)

@Data
@AllArgsConstructor
@NoArgsConstructor
public class RoleStateMemento {
    private int vit; //生命力
    private int atk; //攻击力
    private int def; //防御力
}

• 角色状态管理者类

public class RoleStateCaretaker {
    //声明RoleStateMemento类型的变量
    private RoleStateMemento roleStateMemento;
}

• 测试类

public class Client {
    public static void main(String[] args) {
        System.out.println("------------大战Boss前------------");
        //大战Boss前
        GameRole gameRole = new GameRole();
        gameRole.initState();
        gameRole.stateDisplay();

        //保存进度
        RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
        roleStateCaretaker.setRoleStateMemento(gameRole.saveState());

        System.out.println("------------大战Boss后------------");
        //大战Boss时，损耗严重
        gameRole.fight();
        gameRole.stateDisplay();
        System.out.println("------------恢复之前状态------------");
        //恢复之前状态
        gameRole.recoverState(roleStateCaretaker.getRoleStateMemento());
        gameRole.stateDisplay();

    }
}

输出结果：

---------------大战boos前-----------------
角色生命力：100
角色攻击力：100
角色防御力：100
---------------大战boos后-----------------
角色生命力：0
角色攻击力：0
角色防御力：0
---------------恢复之前的状态-----------------
角色生命力：100
角色攻击力：100
角色防御力：100

• 破坏封装性
• 保存角色状态saveState()方法，返回RoleStateMemento，此时客户端可以修改状态存储类中的属性

3.2、“黑箱”备忘录模式

• 备忘录角色对发起人对象提供一个宽接口，而为其他对象提供一个窄接口
• 实现双重接口的办法就是将备忘录类设计成发起人类的内部成员类
• 将 RoleStateMemento(状态存储类) 设为 GameRole(游戏角色类) 的内部类，从而将 RoleStateMemento对象封装在GameRole里面
• 在外面提供一个标识接口 Memento 给 RoleStateCaretaker(状态存储管理类) 及其他对象使用
• 这样 GameRole 类看到的是 RoleStateMemento 所有的接口
• 而RoleStateCaretaker 及其他对象看到的仅仅是标识接口 Memento 所暴露出来的接口，从而维护了封装型

代码如下：

• 窄接口Memento，这是一个标识接口，因此没有定义出任何的方法

public interface Memento {
}

• 定义发起人类 GameRole，并在内部定义备忘录内部类 RoleStateMemento（该内部类设置为私有的）

@Data
public class GameRole {
    private int vit; //生命力
    private int atk; //攻击力
    private int def; //防御力

    //初始化内部状态
    public void initState() {
        this.vit = 100;
        this.atk = 100;
        this.def = 100;
    }

    //战斗
    public void fight() {
        this.vit = 0;
        this.atk = 0;
        this.def = 0;
    }

    //保存角色状态功能
    public Memento saveState() {
        return new RoleStateMemento(vit, atk, def);
    }

    //恢复角色状态
    public void recoverState(Memento memento) {
        RoleStateMemento roleStateMemento = (RoleStateMemento) memento;
        //将备忘录对象中存储的状态赋值给当前对象的成员
        this.vit = roleStateMemento.getVit();
        this.atk = roleStateMemento.getAtk();
        this.def = roleStateMemento.getDef();
    }

    //展示状态功能
    public void stateDisplay() {
        System.out.println("角色生命力：" + vit);
        System.out.println("角色攻击力：" + atk);
        System.out.println("角色防御力：" + def);
    }

    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    private static class RoleStateMemento implements Memento {
        private int vit; //生命力
        private int atk; //攻击力
        private int def; //防御力
    }
}

• 负责人角色类 RoleStateCaretaker 能够得到的备忘录对象是以 Memento 为接口的
• 由于这个接口仅仅是一个标识接口，因此负责人角色不可能改变这个备忘录对象的内容

@Data
public class RoleStateCaretaker {

    //声明RoleStateMemento类型的变量
    private Memento memento;
}

• 客户端测试类

public class Client {
    public static void main(String[] args) {
        System.out.println("------------大战Boss前------------");
        //大战Boss前
        GameRole gameRole = new GameRole();
        gameRole.initState();
        gameRole.stateDisplay();

        //保存进度
        RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
        roleStateCaretaker.setMemento(gameRole.saveState());
        
        System.out.println("------------大战Boss后------------");
        //大战Boss时，损耗严重
        gameRole.fight();
        gameRole.stateDisplay();
        System.out.println("------------恢复之前状态------------");
        //恢复之前状态
        gameRole.recoverState(roleStateCaretaker.getMemento());
        gameRole.stateDisplay();
    }
}

• 保存角色状态saveState()方法，返回Memento，此时客户端不可以修改状态存储类中的属性
• 从而维护了封装型

4、优缺点

优点

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

缺点

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