备忘录模式

<image>

备忘录模式（memento pattern），是一种软件设计模式，它在不违反封装的前提下，捕获并外部化一个物件的内部状态，使得以后可以将物件回复到其先前的状态（撤消变更），使用此模式的例子还有版本控制，以及自定义序列化。

## 概述

备忘录设计模式是著名的《设计模式：可复用物件导向软件的基础》所收录的二十三个模式之一。此书描述了如何解决常见的设计问题，以设计出弹性且异重用的物件导向软件（亦即更容易实现、更改、测试、维护和重用的物件）。备忘录模式是由Noah Thompson、David Espiritu和Drew Clinkenbeard博士为惠普早期产品创建的。

备忘录模式主要由三个角色来实现：发起者、看守员和备忘录。发起者是具有内部状态的角色。看守员可以对发起者做一些操作，尤其是希望能够撤消变更的操作。看守员首先向发起者索要一件备忘录。然后它执行此操作（或操作序列）。若要回滚到操作之前的状态，它可以将备忘录返回给发起者。备忘录本身是一个不透明的物件（看守员不能或不应更改此物件）。使用此模式时，应注意发起者是否可能更改其他物件或资源——备忘录模式是对单一物件进行操作。

备忘录设计模式可以解决如下问题：物件的内部状态须要保存在外部，以便之后可将物件回复到此状态，又不违反物件的封装性。问题在于，一个良好设计的物件会被封装起来，其表示（资料结构）是隐藏在物件内部，且无法从外部存取。

备忘录设计模式提供的解决方案：让一个物件（发起者）本身负责，将其内部状态保存到（备忘录）物件，并且从（备忘录）物件回复到以前的状态，只有产生此备忘录的发起者可以存取它；客户端（看守员）可以向发起者请求备忘录（以保存发起者的内部状态）并将备忘录传递回发起者（以恢复到先前的状态）。这使得外部能够在不破坏其封装的情况下，保存和回复发起者的内部状态。

备忘录模式的经典范例有伪随机数生成器（PRNG）（每个消费者（看守员）在初始化伪随机数生成器（发起者）时，若使用相同的种子值（备忘录），可以产生相同的乱数序列），此外，还有有限状态机及其状态。

## 结构

### UML 类别图和序列图

<image>

在上面的UML类图中， `Caretaker` 类别指向了 `Originator` 类别，用于保存（`createMemento()`）和恢复（`restore(memento)`）始发者的内部状态。`Originator` 类别实现了(1) `createMemento()`，借由创建并返回 `Memento` 物件，其记录了发起者当前内部状态，(2) `restore(memento)`，借由将 `Memento` 物件传入，以回复状态。

UML序列图显示了运行时交动：(1) 保存发起者的内部状态： `Caretaker`对象在`Originator`对象上调用`createMemento()`，创建一个`Memento`对象，保存其当前的内部状态 ( `setState()` )，并将`Memento`返回给`Caretaker`。(2) 恢复Originator的内部状态： `Caretaker`对`Originator`对象调用`restore(memento)`，并指定存储应恢复状态的`Memento`对象。`Originator`从`Memento`获取状态 ( `getState()` ) 以设置自己的状态。

## 范例

### Java

以下的Java程序说明了备忘录模式的“撤消变更”用法。

```java
import java.util.List;
import java.util.ArrayList;
class Originator {
    private String state;
    // 這個類別可以包含其它不用存在 State 中的備忘錄

    public void set(String state) {
        this.state = state;
        System.out.println("Originator: Setting state to " + state);
    }
 
    public Memento saveToMemento() {
        System.out.println("Originator: Saving to Memento.");
        return new Memento(this.state);
    }
 
    public void restoreFromMemento(Memento memento) {
        this.state = memento.getSavedState();
        System.out.println("Originator: State after restoring from Memento: " + state);
    }
 
    public static class Memento {
        private final String state;

        public Memento(String stateToSave) {
            state = stateToSave;
        }
 
        // accessible by outer class only
        private String getSavedState() {
            return state;
        }
    }
}
 
class Caretaker {
    public static void main(String[] args) {
        List<Originator.Memento> savedStates = new ArrayList<Originator.Memento>();
 
        Originator originator = new Originator();
        originator.set("State1");
        originator.set("State2");
        savedStates.add(originator.saveToMemento());
        originator.set("State3");
        // 我們可以要求多個備忘錄，並選擇要回復到那個狀態。
        savedStates.add(originator.saveToMemento());
        originator.set("State4");
 
        originator.restoreFromMemento(savedStates.get(1));   
    }
}
```

输出是：

```output
 Originator: Setting state to State1
 Originator: Setting state to State2
 Originator: Saving to Memento.
 Originator: Setting state to State3
 Originator: Saving to Memento.
 Originator: Setting state to State4
 Originator: State after restoring from Memento: State3
```

本示例使用 String 作为状态，它是 Java 中的不可变物件。在现实生活中，状态几乎总是一个可变物件，在这种情况下，必须创建状态的副本。

必须指出的是，所展示的实现有一个缺点：它声明了一个内部类。如果备忘录可以适用于多个发起者，则会更好。

实现Memento 还有其他三种主要方式：

- 序列化。
- 在同一个包中声明的类别。
- 还可以通过代理来访问该物件，代理可以实现对物件的任何保存/恢复操作。

### C#

备忘录模式允许人们在不违反封装的情况下捕获物件的内部状态，以便以后可以根据需求来撤消变更/回复变更。从这里可以看出，备忘录物件实际上用于恢复物件中所做的更改。

```csharp
class Memento {
    private readonly string savedState;

    private Memento(string stateToSave) {
        savedState = stateToSave;
    }

    public class Originator {
        private string state;
        // The class could also contain additional data that is not part of the
        // state saved in the memento.

        public void Set(string state) {
            Console.WriteLine("Originator: Setting state to " + state);
            this.state = state;
        }

        public Memento SaveToMemento() {
            Console.WriteLine("Originator: Saving to Memento.");
            return new Memento(state);
        }

        public void RestoreFromMemento(Memento memento) {
            state = memento.savedState;
            Console.WriteLine("Originator: State after restoring from Memento: " + state);
        }
    }
}

class Caretaker {
    static void Main(string[] args) {
        var savedStates = new List<Memento>();

        var originator = new Memento.Originator();
        originator.Set("State1");
        originator.Set("State2");
        savedStates.Add(originator.SaveToMemento());
        originator.Set("State3");
        // We can request multiple mementos, and choose which one to roll back to.
        savedStates.Add(originator.SaveToMemento());
        originator.Set("State4");

        originator.RestoreFromMemento(savedStates[1]);
    }
}
```

### Python

下面是Python例子：

```python
from weakref import WeakKeyDictionary, ref

class Memento():
    def __init__(self, attr):
        assert isinstance(attr, str)
        self.attr = attr
        self.backup_dict = WeakKeyDictionary()
    def __get__(self, obj, objtype=None):
        mem = lambda:None
        self.backup_dict[mem] = obj.__dict__[self.attr]
        return mem
    def __set__(self, obj, mem):
        if mem in self.backup_dict:
            obj.__dict__[self.attr] = self.backup_dict[mem]
    def __call__(self, mem):
        return self.backup_dict[mem]
        
class Originator():
    __state = None
    __memento = Memento('_Originator__state')
    __ref_memento = ref(__memento)
    def set(self, state):
        print(f"Originator: Setting state to {state}")
        self.__state = state
    def get(self):
        print(f"Originator: Current state is {self.__state}")
        return self.__state
    def save(self):
        print("Originator: Saving to Memento")
        return self.__memento
    def restore(self, mem):
        print("Originator: Restoring from Memento")
        self.__memento = mem
    def view(self, mem):
        val = self.__ref_memento()(mem)
        print(f"Originator: Saved state is {val}")

class Caretaker():
    def __init__(self, originator):
        self.mementos = []
        self.originator = originator
    def __len__(self):
        return len(self.mementos)
    def __getitem__(self, index):
        return self.mementos[index]
    def __setitem__(self, index, value):
        self.mementos[index] = value
    def __delitem__(self, index):
        del self.mementos[index]
    def add_memento(self):
        self.mementos += [self.originator.save()]

def demo():
    originator = Originator()
    caretaker = Caretaker(originator)
    originator.set("State1")
    originator.set("State2")
    caretaker.add_memento()
    originator.set("State3")
    caretaker.add_memento()
    originator.set("State4")
    originator.view(caretaker[1])
    originator.restore(caretaker[1])
    val = originator.get()
```

这里的`Memento`类实例只能通过“纪念品”，来操作与纪念品关联的`Originator`类的特定属性的事件存储历史数据，用作纪念品的对象在例子中只拥有充当唯一标识符的一项简单功能。下面是其执行：

```pycon
>>> demo()
Originator: Setting state to State1
Originator: Setting state to State2
Originator: Saving to Memento
Originator: Setting state to State3
Originator: Saving to Memento
Originator: Setting state to State4
Originator: Saved state is State3
Originator: Restoring from Memento
Originator: Current state is State3
```

### JavaScript

```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
    savedState : null, // The saved state of the object.

    save : function(state) { // Save the state of an object.
        this.savedState = state;
    },

    restore : function() { // Restore the state of an object.
        return this.savedState;
    }
};

// The Originator is the object that creates the memento.
// defines a method for saving the state inside a memento.
var Originator = {// Namespace: Originator
    state : null, // The state to be stored

    // Creates a new originator with an initial state of null
    createMemento : function() { 
        return {
            state : this.state // The state is copied to the memento.
        };
    },
    setMemento : function(memento) { // Sets the state of the originator from a memento
        this.state = memento.state;
    }
};

// The Caretaker stores mementos of the objects and
// provides operations to retrieve them.
var Caretaker = {// Namespace: Caretaker
    mementos : [], // The mementos of the objects.
    addMemento : function(memento) { // Add a memento to the collection.
        this.mementos.push(memento);
    },
    getMemento : function(index) { // Get a memento from the collection.
        return this.mementos[index];
    }
};

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
```