备忘录模式

备忘录模式是一种软件设计模式，可以将一个物件内部私有的状态公开。可以使用此模式的一个例子是将物件回复到其先前的状态（撤消变更），还有的例子是版本控制，以及自定义序列化。
备忘录模式主要由三个角色来实现：发起者、管理员和备忘录。发起者是具有内部状态的角色。管理员可以对发起起者做一些操作，尤其是希望能够撤消变更的操作。竹管理员首先向发起者索要一件备忘录。然后它执行此操作（或操作序列）。为了可以回滚到操作之前的状态，它将备忘录返回给发起者。备忘录本身是一个不透明的物件（管理员不能或不应更改此物件）。使用此模式时，应注意发起者是否可能更改其他物件或资源——备忘录模式是对单一物件进行操作。
备忘录模式的经典范例有伪随机数生成器（PRNG）（每个消费者（管理员）在初始化伪随机数生成器（发起者）时，若使用相同的种子值（备忘录），可以产生相同的乱数序列），此外，还有有限状态机及其状态。
概述.
备忘录设计模式是著名的《"设计模式：可复用物件导向软体的基础"》所收录的二十三个之一。此书描述了如何解决常见的设计问题，以设计出弹性且异重用的物件导向软件（亦即更容易实现、更改、测试、维护和重用的物件）。备忘录模式是由 Noah Thompson、David Espiritu 和 Drew Clinkenbeard 博士为惠普早期产品创建的。
备忘录设计模式可以解决什么问题？.
问题在于，一个良好设计的物件会被封装起来，其表示（资料结构）是隐藏在物件内部，且无法从外部存取。
备忘录设计模式描述了什么解决方案？.
让一个物件（发起者）本身负责
只有产生此备忘录的发起者可以存取它。
客户端（管理员）可以向发起者请求备忘录（以保存发起者的内部状态）并将备忘录传递回发起者（以恢复到先前的状态）。
这使得外部能够在不破坏其封装的情况下，保存和回复发起者的内部状态。
请参考下面的 UML 类别图和序列图。
结构.
UML 类别图和序列图.
在上面的UML类图中， codice_1 类别指向向 codice_2 类别，用于保存（ codice_3 ）和恢复（ codice_4 ）始发者的内部状态。codice_2 类别实现了(1) codice_3 ，借由创建并返回 codice_7 物件，其记录了发起者当前内部状态，(2) codice_4，借由将 codice_7 物件传入，以回复状态。
UML序列图显示了运行时交动：(1) 保存发起者的内部状态： codice_1对象在codice_2对象上调用codice_3 ，创建一个codice_7对象，保存其当前的内部状态 ( codice_14 )，并将codice_7返回给codice_1 。(2) 恢复Originator的内部状态： codice_1对codice_2对象调用codice_4 ，并指定存储应恢复状态的codice_7对象。 codice_2从codice_7获取状态 ( codice_23 ) 以设置自己的状态。
Java 范例.
以下的 Java 程序说明了备忘录模式的“撤消变更”用法。<syntaxhighlight lang="java">
import java.util.List;
import java.util.ArrayList;
class Originator {
class Caretaker {
</syntaxhighlight>输出是：
本示例使用 String 作为状态，它是 Java 中的不可变物件。在现实生活中，状态几乎总是一个可变物件，在这种情况下，必须创建状态的副本。
必须指出的是，所展示的实现有一个缺点：它声明了一个内部类。如果备忘录可以适用于多个发起者，则会更好。
实现Memento 还有其他三种主要方式：
C# 示例.
备忘录模式允许人们在不违反封装的情况下捕获物件的内部状态，以便以后可以根据需求来撤消变更/回复变更。从这里可以看出，"备忘录物件"实际上用于"恢复"物件中所做的更改。<syntaxhighlight lang="csharp">
class Memento
class Caretaker
</syntaxhighlight>
Python 范例.
<syntaxhighlight lang="python">
备忘录模式范例
class Originator:
saved_states = []
originator = Originator()
originator.set("State1")
originator.set("State2")
saved_states.append(originator.save_to_memento())
originator.set("State3")
saved_states.append(originator.save_to_memento())
originator.set("State4")
originator.restore_from_memento(saved_states)
</syntaxhighlight>
JavaScript 范列.
<syntaxhighlight lang="javascript">
// The Memento pattern is used to save and restore the state of an object.
// A memento is a snapshot of an object's state.
var Memento = {// Namespace: Memento
// The Originator is the object that creates the memento.
// defines a method for saving the state inside a memento.
var Originator = {// Namespace: Originator
// The Caretaker stores mementos of the objects and
// provides operations to retrieve them.
var Caretaker = {// Namespace: Caretaker
var action_step = "Foo"; // The action to be executed/the object state to be stored.
var action_step_2 = "Bar"; // The action to be executed/the object state to be stored.
// 设置初始值
Originator.state = action_step;
Caretaker.addMemento(Originator.createMemento());// save the state to the history
console.log("Initial State: " + Originator.state); // Foo
// 改变初始值
Originator.state = action_step_2;
Caretaker.addMemento(Originator.createMemento()); // save the state to the history
console.log("State After Change: " + Originator.state); // Bar
// 回复到第一个状态——撤消变更
Originator.setMemento(Caretaker.getMemento(0));
console.log("State After Undo: " + Originator.state); // Foo
// 回复到第二个状态——重做变更
Originator.setMemento(Caretaker.getMemento(1));
console.log("State After Redo: " + Originator.state); // Bar
</syntaxhighlight>