备忘录模式

概述

备忘录模式提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定地历史步骤，当新地状态无效或者存在问题时，可以使用暂时存储起来地备忘录将状态复原。很多软件都提供了撤销操作，撤销操作可以恢复到之前的状态；还有子啊浏览器中的后退键、数据库事务管理中的回滚操作，玩游戏时的的中间结果存档功能、数据与操作系统的备份操作都属于这类。

定义

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

结构

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

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

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

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

案例

游戏挑战Boss

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

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

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

“白箱”备忘录模式

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

发起人角色

java

package com.huangjiliang.design.heima.behavior.memento.white;

import lombok.Data;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 游戏角色类
 */
@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;
    }

    /**
     * 保存状态
     * @return
     */
    public RoleStateMemento saveState() {
        return new RoleStateMemento(vit, atk, def);
    }

    /**
     * 恢复角色状态
     * @param roleStateMemento
     */
    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);
    }

}

备忘录角色

java

package com.huangjiliang.design.heima.behavior.memento.white;


/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 状态存储类（备忘录类）
 */
public class RoleStateMemento {

    /**
     * 生命力
     */
    private int vit;

    /**
     * 攻击力
     */
    private int atk;

    /**
     * 防御力
     */
    private int def;

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

    public int getVit() {
        return vit;
    }

    public void setVit(int vit) {
        this.vit = vit;
    }

    public int getAtk() {
        return atk;
    }

    public void setAtk(int atk) {
        this.atk = atk;
    }

    public int getDef() {
        return def;
    }

    public void setDef(int def) {
        this.def = def;
    }
}

管理员角色

java

package com.huangjiliang.design.heima.behavior.memento.white;

import lombok.Data;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 角色状态管理类
 */
@Data
public class RoleStateCaretaker {

    private RoleStateMemento roleStateMemento;

}

客户端

java

package com.huangjiliang.design.heima.behavior.memento.white;

import cn.hutool.extra.ssh.GanymedUtil;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 描述
 */
public class Client {

    public static void main(String[] args) {
        System.out.println("开战之前========》");

        GameRole gameRole = new GameRole();
        gameRole.initState();
        gameRole.stateDisplay();

        RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
        roleStateCaretaker.setRoleStateMemento(gameRole.saveState());

        System.out.println("开战之后========》");

        gameRole.fight();
        gameRole.stateDisplay();
        System.out.println("恢复战斗前状态========》");

        gameRole.recoverState(roleStateCaretaker.getRoleStateMemento());
        gameRole.stateDisplay();
    }
}

分析：白箱备忘录模式是破坏封装性的，但是通过程序员自律，同样可以在一定程度上实现模式的大部分用意

“黑箱”备忘录

备忘录角色是对发起人对象提供一个宽接口，而为其他对象提供一个窄接口，在java语言中，实现双重接口的办法就是将备忘录类设计成发起人类的内部成员类。

将RoleStateMemento设为GameRole的内部类，从而将RoleStateMemento对象封装在GameRole里面；在外面提供一个标识接口Memento给RoleStateCaretaker及其对象使用。这样GameRole类看到RoleStateMemento所有的接口，而RoleStateCaretaker及其他对象看到的仅仅是标识接口Memento所暴露出来的接口，从而维护了封装性。其UML类图如下。

发起人角色

java

package com.huangjiliang.design.heima.behavior.memento.black;

import lombok.Data;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 游戏角色类
 */
@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;
    }

    /**
     * 保存状态
     * @return
     */
    public Memento saveState() {
        return new RoleStateMemento(vit, atk, def);
    }

    /**
     * 恢复角色状态
     * @param memento
     */
    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);
    }

    private class RoleStateMemento implements Memento {
        /**
         * 生命力
         */
        private int vit;

        /**
         * 攻击力
         */
        private int atk;

        /**
         * 防御力
         */
        private int def;

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

        public int getVit() {
            return vit;
        }

        public void setVit(int vit) {
            this.vit = vit;
        }

        public int getAtk() {
            return atk;
        }

        public void setAtk(int atk) {
            this.atk = atk;
        }

        public int getDef() {
            return def;
        }

        public void setDef(int def) {
            this.def = def;
        }
    }

}

抽象状态角色

java

package com.huangjiliang.design.heima.behavior.memento.black;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 描述
 */
public interface Memento {
}

其实现类在GameRole的内部类RoleStateMemento

状态管理角色

java

package com.huangjiliang.design.heima.behavior.memento.black;

import lombok.Data;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 角色状态管理类
 */
@Data
public class RoleStateCaretaker {

    private Memento memento;

}

客户端

java

package com.huangjiliang.design.heima.behavior.memento.black;

/**
 * @author 黄继良
 * @date 2022/12/12
 * @describe 描述
 */
public class Client {

    public static void main(String[] args) {
        System.out.println("开战之前========》");

        GameRole gameRole = new GameRole();
        gameRole.initState();
        gameRole.stateDisplay();

        RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
        roleStateCaretaker.setMemento(gameRole.saveState());

        System.out.println("开战之后========》");

        gameRole.fight();
        gameRole.stateDisplay();
        System.out.println("恢复战斗前状态========》");

        gameRole.recoverState(roleStateCaretaker.getMemento());
        gameRole.stateDisplay();
    }
}

优缺点

优点

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

缺点

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

使用场景

需要保存与恢复数据的场景，如玩游戏时的中间结果的存档功能
需要提供一个可回滚操作的场景，如：word、记事本等编辑器，还有数据库事务操作。

备忘录模式 ​

概述 ​

定义 ​

结构 ​

案例 ​

“白箱”备忘录模式 ​

发起人角色 ​

备忘录角色 ​

管理员角色 ​

客户端 ​

“黑箱”备忘录 ​

发起人角色 ​

抽象状态角色 ​

状态管理角色 ​

客户端 ​

优缺点 ​

优点 ​

缺点 ​

使用场景 ​

备忘录模式

概述

定义

结构

案例

“白箱”备忘录模式

发起人角色

备忘录角色

管理员角色

客户端

“黑箱”备忘录

发起人角色

抽象状态角色

状态管理角色

客户端

优缺点

优点

缺点

使用场景