设计模式
备忘录模式
现在市场上很多应用软件都提供了撤回功能,如 IDEA、PS、Eclipse、Notepad++等软件都可以使用 ctrl + n
撤回之前的操作;还比如浏览器的 “后退” 按钮;还比如五子棋、围棋、象棋游戏中的 “悔棋” 操作;还有我们经常玩的那些主机游戏或剧情类游戏都有一个 “存档点” 在游戏角色死亡后,可以读取存档。这些类似的具有备分/恢复操作的场景都是备忘录模式的体现。
模式的定义
备忘录(Memento)模式,在不破坏封装性的前提下,捕获一个对象的内部状态,并在该对象之外保存这个状态,这样以后就可将该对象恢复到原先保存的状态。
模式的优点:
- 提供了一种状态的备分与恢复机制,你可以在不破坏对象封装情况的前提下创建对象状态快照,并在需要的时候恢复。
- 实现了内部状态的封装,除了发起人外,其他对象都不能够访问这些状态信息。
- 拆分了职责,发起人不在需要管理和维护其内部状态的历史备分,所有状态信息都保存在备忘录中,并由管理者进行管理,体现了合单一职责原则。
缺点:
- 如果客户端过于频繁地创建备忘录, 程序将消耗大量内存。
- 管理者必须完整跟踪发起人的生命周期, 这样才能销毁弃用的备忘录。
- 绝大部分动态编程语言(例如 PHP、 Python 和 JavaScript)不能确保备忘录中的状态不被修改。
模式的结构
备忘录模式的主要角色如下:
- 发起人角色(Originator):负责创建一个备忘录 Memento,用以记录当前时刻它的内部状态,并可以使用备忘录恢复内部状态。Originator 可以根据需要决定 Memento 存储 Originator 的那些内部状态。
- 备忘录角色(Memento):负责存储 Originator 对象的内部状态,并可防止 Originator 以外的其他对象访问备忘录 Memento。备忘录有两个接口,Caretaker 只能看到备忘录的窄接口,它只能将备忘录传递给其他对象。Originator 能够看到一个宽接口,允许它访问返回到先前状态所需的所有数据。
- 管理者角色(Caretaker):对备忘录进行管理,提供保存与获取备忘录的功能,不能对备忘录的内容进行操作或检查。
其 UML 类图如下:
模式的使用
以下以 游戏角色状态 的存档与读档为例,介绍备忘录模式的使用。
- 发起人:
GameRole
,其中包含其状态数据的存档archive
与读档load
方法,存档方法可以生成一个包含角色当前状态的备忘录,读档方法可以根据给定的备忘录读取角色的状态数据。- 备忘录:
RoleStateMemento
,其中包含了某一时刻游戏角色的内部状态信息。- 管理者:
RoleStateCaretaker
,其中维护了一个保存角色状态备忘录的列表,提供了添加或获取角色状态备忘录的方法。
/**
* 发起人 - 游戏角色
*/
@Getter
@Setter
public class GameRole {
/**
* 生命力
*/
private int vit;
/**
* 攻击力
*/
private int atk;
/**
* 防御力
*/
private int def;
/**
* 魔力
*/
private int magic;
/**
* 初始化角色
*/
public void initGameRole() {
this.vit = 100;
this.atk = 100;
this.def = 100;
this.magic = 100;
}
/**
* 显示角色状态
*/
public void showRoleState() {
System.out.println("角色当前状态:");
System.out.println("生命力:" + vit);
System.out.println("攻击力:" + atk);
System.out.println("防御力:" + def);
System.out.println("魔力:" + magic);
}
/**
* 角色死亡
*/
public void death() {
this.vit = 0;
this.atk = 0;
this.def = 0;
this.magic = 0;
}
/**
* 存档
* @return
*/
public RoleStateMemento archive() {
return new RoleStateMemento(vit, atk, def, magic);
}
/**
* 读档
* @param roleStateMemento
*/
public void load(RoleStateMemento roleStateMemento) {
this.vit = roleStateMemento.getVit();
this.atk = roleStateMemento.getAtk();
this.def = roleStateMemento.getDef();
this.magic = roleStateMemento.getMagic();
}
}
/**
* 备忘录 - 角色状态
*/
@Getter
@Setter
public class RoleStateMemento {
/**
* 生命力
*/
private int vit;
/**
* 攻击力
*/
private int atk;
/**
* 防御力
*/
private int def;
/**
* 魔力
*/
private int magic;
public RoleStateMemento(int vit, int atk, int def, int magic) {
this.vit = vit;
this.atk = atk;
this.def = def;
this.magic = magic;
}
}
/**
* 管理者 - 角色状态管理者
*/
public class RoleStateCaretaker {
private List<RoleStateMemento> list = new ArrayList<>();
public void add(RoleStateMemento roleStateMemento) {
list.add(roleStateMemento);
}
public RoleStateMemento get(int index) {
return list.get(index);
}
}
/**
* 备忘录模式测试
*/
public class MementoTest {
public static void main(String[] args) {
GameRole gameRole = new GameRole();
gameRole.initGameRole();
System.out.println("游戏初始化 ======> ");
gameRole.showRoleState();
System.out.println();
// 打 boss 前存档
RoleStateCaretaker roleStateCaretaker = new RoleStateCaretaker();
roleStateCaretaker.add(gameRole.archive());
System.out.println("打 boss 失败,死亡 ======> ");
gameRole.death();
gameRole.showRoleState();
System.out.println();
System.out.println("读档 ======>");
gameRole.load(roleStateCaretaker.get(0));
gameRole.showRoleState();
System.out.println();
}
}
运行程序,结果如下:
模式的应用场景
备忘录模式的应用场景如下:
- Memento 模式比较适用于功能比较复杂的,但需要维护或记录属性历史的类,或者需要保存的属性只是众多属性中的一小部分时,Originator 可以根据保存的 Memento 信息还原到前一状态。
- 如果在某个系统中使用命令模式时,需要实现命令的撤销功能,那么命令模式可以使用备忘录模式来存储可撤销操作的状态。
- 需要提供一个可回滚操作的场景。如:Notepad++、ps,idea 等软件在编辑时按
ctr+z
组合键可以撤回操作,还有数据库中事务操作。