设计模式之备忘录模式

备忘录模式（Memento Pattern）保存一个对象的某个状态，以便在适当的时候恢复对象。备忘录模式属于行为型模式。

意图：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。

主要解决：所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。

何时使用：很多时候我们总是需要记录一个对象的内部状态，这样做的目的就是为了允许用户取消不确定或者错误的操作，能够恢复到他原先的状态，使得他有"后悔药"可吃。

如何解决：通过一个备忘录类专门存储对象状态。

关键代码：客户不与备忘录类耦合，与备忘录管理类耦合。

应用实例： 

• 后悔药。
• 打游戏时的存档。
• Windows 里的 ctrl + z。
• IE 中的后退。
• 数据库的事务管理。

优点： 

• 给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态。
• 实现了信息的封装，使得用户不需要关心状态的保存细节。

缺点：消耗资源。如果类的成员变量过多，势必会占用比较大的资源，而且每一次保存都会消耗一定的内存。

使用场景： 

• 需要保存/恢复数据的相关状态场景。
• 提供一个可回滚的操作。

注意事项： 

• 为了符合迪米特原则，还要增加一个管理备忘录的类。
• 为了节约内存，可使用原型模式+备忘录模式。

实现：

备忘录模式使用三个类 Memento、Originator 和 CareTaker。

Memento 包含了要被恢复的对象的状态。

namespace Memento
{
    public class Memento
    {
        private readonly string _state;

        public Memento(string state)
        {
            _state = state;
        }

        public string GetState()
        {
            return _state;
        }
    }
}

Originator 创建并在 Memento 对象中存储状态。

namespace Memento
{
    public class Originator
    {
        private string _state;

        public void SetState(string state)
        {
            _state = state;
        }

        public string GetState()
        {
            return _state;
        }

        public Memento SaveStateToMemento()
        {
            return new Memento(_state);
        }

        public void GetStateFromMemento(Memento memento)
        {
            _state = memento.GetState();
        }
    }
}

Caretaker 对象负责从 Memento 中恢复对象的状态。

using System.Collections.Generic;

namespace Memento
{
    public class CareTaker
    {
        private readonly List<Memento> _mementoList = new List<Memento>();

        public void Add(Memento state)
        {
            _mementoList.Add(state);
        }

        public Memento Get(int index)
        {
            return _mementoList[index];
        }
    }
}

使用 CareTaker 和 Originator 对象来显示对象的状态恢复。

        Originator originator = new Originator();
        CareTaker careTaker = new CareTaker();
        
        originator.SetState("State #1");
        originator.SetState("State #2");
        careTaker.Add(originator.SaveStateToMemento());
        originator.SetState("State #3");
        careTaker.Add(originator.SaveStateToMemento());
        originator.SetState("State #4");
        
        Debug.Log($"Current State :{originator.GetState()}");
        originator.GetStateFromMemento(careTaker.Get(0));
        Debug.Log($"First saved State :{originator.GetState()}");
        originator.GetStateFromMemento(careTaker.Get(1));
        Debug.Log($"Second saved State :{originator.GetState()}");

设计类图如下：