设计模式--行为型--备忘录模式
- 备忘录模式
- 定义
- 结构
- 案例实现
- 白箱备忘录模式
- 黑箱备忘录模式
- 优缺点
- 使用场景
备忘录模式
定义
又叫快照模式，在不破坏封装性的前提下，捕获一个对象的对象的内部状态，并在该对象之外保存这个状态，以便以后当需要时能将该对象恢复到原先保存的状态。
结构
- 发起人角色（Originator）：记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，实现其他业务功能，它可以访问备忘录里的所有信息。
- 备忘录角色（Memento）：负责存储发起人的内部状态，在需要的时候提供这些内部状态给发起人
- 管理者角色（Caretaker）：对备忘录进行管理，提供保存与获取备忘录的功能，但其不能对备忘录的内容进行访问与修改
- 备忘录有两个等效接口：
- 窄接口：管理者对象（和其他发起人对象之外的任何对象）看到的是备忘录的窄接口，这个窄接口只允许他把备忘录对象传递给其他的对象。
- 宽接口：与管理者看到的窄接口相反，发起人对象可以看到一个宽接口，这个宽接口允许它读取所有的数据，以便根据这些数据恢复这个发起人对象内部状态。
案例实现
游戏保存，游戏角色有生命力，攻击力，防御力等数据，模拟玩家打boss前的保存机制，失败后可以返回到进入boss关之前的状态
实现上述案例，有两种方式
- 白箱备忘录
- 黑箱备忘录
白箱备忘录模式
备忘录角色对任何对象都提供一个接口，即宽接口，备忘录角色内部所存储的状态就对所有对象公开。类图如下：
/**
* 游戏角色类 发起人角色
*/
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 = 100;
this.def = 100;
}
// 保存角色状态
public RoleStateMemento saveState() {
return new RoleStateMemento(vit, atk, def);
}
// 恢复角色到初始状态
public void recoverState(RoleStateMemento roleStatusMemento) {
// 将备忘录中的数据赋值给当前对象
this.vit = roleStatusMemento.getVit();
this.atk = roleStatusMemento.getAtk();
this.def = roleStatusMemento.getDef();
}
// 展示状态功能
public void stateDisplay() {
System.out.println("角色生命：" + vit);
System.out.println("角色攻击：" + atk);
System.out.println("角色防御：" + 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;
}
}
public class RoleStateMemento {
private int vit; // 生命
private int atk; // 攻击力
private int def; // 防御力
public RoleStateMemento() {
}
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;
}
}
/**
* 备忘录对象管理对象
*/
public class RoleStateCaretaker {
// 声明RoleStateMemento类型的变量
private RoleStateMemento roleStatusMemento;
public RoleStateMemento getRoleStatusMemento() {
return roleStatusMemento;
}
public void setRoleStatusMemento(RoleStateMemento roleStatusMemento) {
this.roleStatusMemento = roleStatusMemento;
}
}
public class Test01 {
public static void main(String[] args) {
// 创建游戏角色对象
GameRole gameRole = new GameRole();
System.out.println("---boss关卡前---");
gameRole.initState();
gameRole.stateDisplay();
// 将游戏角色内部状态进行备份
// 创建管理者对象
RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
roleStateCaretaker.setRoleStatusMemento(gameRole.saveState());
System.out.println("---挑战boss---");
gameRole.fight();
gameRole.stateDisplay();
System.out.println("---生命为0，boss关挑战失败，回到boss关卡前---");
gameRole.recoverState(roleStateCaretaker.getRoleStatusMemento());
gameRole.stateDisplay();
}
}
白箱备忘录模式是破坏封装性的，但是通过程序员的自律，同样可以在一定程度上实现模式的大部分用意
黑箱备忘录模式
备忘录角色对发起人提供一个宽接口，而为其他对象提供一个窄接口。在JAVA语言中，实现双重接口的办法就是将备忘录类设计成发起人类的内部成员类。将RoleStateMemento设为GameRole的内部类，从而将RoleStateMemento对象封装在GameRole里面；在外面提供一个标识接口Memento给RoleStateCaretaker及其他对象使用。这样GameRole类看到的是RoleStateMemento所有的接口，而RoleStateCaretaker及其他对象看到的仅仅是标识接口Memento所暴露出来的接口，从而维护了封装性。
/**
* 备忘录接口 对外提供窄接口
*/
public interface Memento {
}
/**
* 游戏角色类 发起人角色
*/
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 = 100;
this.def = 100;
}
// 保存角色状态
public Memento saveState() {
return new RoleStateMemento(vit, atk, def);
}
// 恢复角色到初始状态
public void recoverState(Memento memento) {
RoleStateMemento roleStatusMemento = (RoleStateMemento) memento;
// 将备忘录中的数据赋值给当前对象
this.vit = roleStatusMemento.getVit();
this.atk = roleStatusMemento.getAtk();
this.def = roleStatusMemento.getDef();
}
// 展示状态功能
public void stateDisplay() {
System.out.println("角色生命：" + vit);
System.out.println("角色攻击：" + atk);
System.out.println("角色防御：" + 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;
}
// 私有的成员内部类
private class RoleStateMemento implements Memento{
private int vit; // 生命
private int atk; // 攻击力
private int def; // 防御力
public RoleStateMemento() {
}
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;
}
}
}
/**
* 备忘录对象管理对象
*/
public class RoleStateCaretaker {
// 声明RoleStateMemento类型的变量
private Memento memento;
public Memento getMemento() {
return memento;
}
public void setMemento(Memento memento) {
this.memento = memento;
}
}
public class Test01 {
public static void main(String[] args) {
// 创建游戏角色对象
GameRole gameRole = new GameRole();
System.out.println("---boss关卡前---");
gameRole.initState();
gameRole.stateDisplay();
// 将游戏角色内部状态进行备份
// 创建管理者对象
RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
roleStateCaretaker.setMemento(gameRole.saveState());
System.out.println("---挑战boss---");
gameRole.fight();
gameRole.stateDisplay();
System.out.println("---生命为0，boss关挑战失败，回到boss关卡前---");
gameRole.recoverState(roleStateCaretaker.getMemento());
gameRole.stateDisplay();
}
}
优缺点
- 优点
- 提供了一种可以恢复状态的机制。当用户需要时能够比较方便地将数据恢复到某个历史状态。
- 实现了内部状态的封装。除了创建它的发起人之外，其他对象都不能够访问这些状态信息
- 简化了发起人类。发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。
- 缺点
- 资源消耗大，如果要保存的内部状态信息过多或者特别频繁，将会占用较大的内存资源。
使用场景
- 需要保存与恢复数据的场景，例如游戏的存档功能。
- 需要提供一个可回滚操作的场景。
