设计模式 ~ 行为型模式 ~ 备忘录模式 ~ Memento Pattern。

设计模式 ~ 行为型模式 ~ 备忘录模式 ~ Memento Pattern。

---

---

概述。

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

定义。

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

---

结构。

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

• 发起人（Originator）角色。
  记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，实现其他业务功能，它可以访问备忘录里的所有信息。

• 备忘录（Memento）角色。
  负责存储发起人的内部状态，在需要的时候提供这些内部状态给发起人。

• 管理者（Caretaker）角色。
  对备忘录进行管理，提供保存与获取备忘录的功能，但其不能对备忘录的内容进行访问与修改。

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

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

---

案例实现。

【eg.】游戏挑战 BOSS。

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

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

• “白箱”备忘录模式。

• “黑箱”备忘录模式。

---

“白箱”备忘录模式。

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

代码如下。

package com.geek.memento.pattern.white.box;

import lombok.Data;

/**
 * 游戏角色类 ~ 发起人角色。
 *
 * @author geek
 */
@Data
public class GameRole {

    /**
     * 生命力。
     */
    private int vitality;
    /**
     * 攻击力。
     */
    private int attack;
    /**
     * 防御力。
     */
    private int defence;

    /**
     * 初始化状态。
     */
    public void initState() {
        this.vitality = 100;
        this.attack = 100;
        this.defence = 100;
    }

    /**
     * 战斗。
     */
    public void fight() {
        this.vitality = 0;
        this.attack = 0;
        this.defence = 0;
    }

    /**
     * 保存角色状态。
     *
     * @return
     */
    public RoleStateMemento saveState() {
        return new RoleStateMemento(this.vitality, this.attack, this.defence);
    }

    /**
     * 恢复角色状态。
     *
     * @param roleStateMemento
     */
    public void recoverState(RoleStateMemento roleStateMemento) {
        this.vitality = roleStateMemento.getVitality();
        this.attack = roleStateMemento.getAttack();
        this.defence = roleStateMemento.getDefence();
    }

    public void displayState() {
        System.out.println("角色生命力 ~ " + this.vitality);
        System.out.println("角色攻击力 ~ " + this.attack);
        System.out.println("角色防御力 ~ " + this.defence);
    }

}

package com.geek.memento.pattern.white.box;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * 游戏状态存储类 ~ 备忘录类。
 *
 * @author geek
 */
@Data
@AllArgsConstructor
public class RoleStateMemento {

    /**
     * 生命力。
     */
    private int vitality;
    /**
     * 攻击力。
     */
    private int attack;
    /**
     * 防御力。
     */
    private int defence;

}

package com.geek.memento.pattern.white.box;

import lombok.Data;

/**
 * 备忘录对象管理类。
 *
 * @author geek
 */
@Data
public class RoleStateCaretaker {

    private RoleStateMemento roleStateMemento;

}

package com.geek.memento.pattern.white.box;

/**
 * @author geek
 */
public class Client {

    public static void main(String[] args) {
        System.out.println(" ~ ~ ~ ~ ~ ~ ~ 大战 Boss 前。 ~ ~ ~ ~ ~ ~ ~ ");
        // 大战 Boss 前。
        GameRole gameRole = new GameRole();
        gameRole.initState();
        gameRole.displayState();

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

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

}

/*
Connected to the target VM, address: '127.0.0.1:57499', transport: 'socket'
 ~ ~ ~ ~ ~ ~ ~ 大战 Boss 前。 ~ ~ ~ ~ ~ ~ ~
角色生命力 ~ 100
角色攻击力 ~ 100
角色防御力 ~ 100
 ~ ~ ~ ~ ~ ~ ~ 大战 Boss 后。 ~ ~ ~ ~ ~ ~ ~
角色生命力 ~ 0
角色攻击力 ~ 0
角色防御力 ~ 0
 ~ ~ ~ ~ ~ ~ ~ 恢复之前状态。 ~ ~ ~ ~ ~ ~ ~
角色生命力 ~ 100
角色攻击力 ~ 100
角色防御力 ~ 100
Disconnected from the target VM, address: '127.0.0.1:57499', transport: 'socket'

Process finished with exit code 0
 */

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

---

“黑箱”备忘录模式。

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

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

代码如下。

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

package com.geek.memento.pattern.black.box;

/**
 * 备忘录接口，对外提供窄接口 `IMemento`，这是一个标识接口，因此没有定义出任何的方法。
 *
 * @author geek
 */
public interface IMemento {
}

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

package com.geek.memento.pattern.black.box;

import lombok.AllArgsConstructor;
import lombok.Data;

/**
 * 游戏角色类。
 *
 * @author geek
 */
@Data
public class GameRole {

    /**
     * 生命力。
     */
    private int vitality;
    /**
     * 攻击力。
     */
    private int attack;
    /**
     * 防御力。
     */
    private int defence;

    /**
     * 初始化状态。
     */
    public void initState() {
        this.vitality = 100;
        this.attack = 100;
        this.defence = 100;
    }

    /**
     * 战斗。
     */
    public void fight() {
        this.vitality = 0;
        this.attack = 0;
        this.defence = 0;
    }

    /**
     * 保存角色状态。
     *
     * @return
     */
    public IMemento saveState() {
        return new RoleStateMemento(this.vitality, this.attack, this.defence);
    }

    /**
     * 恢复角色状态。
     *
     * @param memento
     */
    public void recoverState(IMemento memento) {
        RoleStateMemento roleStateMemento = (RoleStateMemento) memento;
        this.vitality = roleStateMemento.getVitality();
        this.attack = roleStateMemento.getAttack();
        this.defence = roleStateMemento.getDefence();
    }

    public void stateDisplay() {
        System.out.println("角色生命力 ~ " + this.vitality);
        System.out.println("角色攻击力 ~ " + this.attack);
        System.out.println("角色防御力 ~ " + this.defence);
    }

    @Data
    @AllArgsConstructor
    private static class RoleStateMemento implements IMemento {

        /**
         * 生命力。
         */
        private int vitality;
        /**
         * 攻击力。
         */
        private int attack;
        /**
         * 防御力。
         */
        private int defence;

    }

}

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

package com.geek.memento.pattern.black.box;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * 角色状态管理者类。
 *
 * @author geek
 */
@Data
@AllArgsConstructor
@NoArgsConstructor
public class RoleStateCaretaker {

    private IMemento memento;

}

客户端测试类。

package com.geek.memento.pattern.black.box;

/**
 * @author geek
 */
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();
    }

}

/*
Connected to the target VM, address: '127.0.0.1:57683', transport: 'socket'
 ~ ~ ~ ~ ~ ~ ~ 大战 Boss 前。 ~ ~ ~ ~ ~ ~ ~ 
角色生命力 ~ 100
角色攻击力 ~ 100
角色防御力 ~ 100
 ~ ~ ~ ~ ~ ~ ~ 大战 Boss 后。 ~ ~ ~ ~ ~ ~ ~ 
角色生命力 ~ 0
角色攻击力 ~ 0
角色防御力 ~ 0
 ~ ~ ~ ~ ~ ~ ~ 恢复之前状态。 ~ ~ ~ ~ ~ ~ ~ 
角色生命力 ~ 100
角色攻击力 ~ 100
角色防御力 ~ 100
Disconnected from the target VM, address: '127.0.0.1:57683', transport: 'socket'

Process finished with exit code 0

 */

---

优缺点。

优点。

• 提供了一种可以恢复状态的机制。当用户需要时能够比较方便地将数据恢复到某个历史的状态。

• 实现了内部状态的封装。除了创建它的发起人之外，其他对象都不能够访问这些状态信息。

• 简化了发起人类。发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。

缺点。

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

---

使用场景。

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

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