后悔药，『备忘录模式』

目录：设计模式之小试牛刀
源码路径：Github-Design Pattern

---

定义：（Memento Pattern）

在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态。

类图：

备忘录模式

启示：

提到备忘录，你可能首先想到的是各种便签，用于记录待办事项或用来笔记摘录。目的只有一个：提醒备忘。
但我们今天要讲的备忘录模式，其用途不再是备忘，而是备份和还原。所以从用途上来说，我更倾向于叫它备份还原模式。
备份还原可以理解为我们程序中的后悔药。
比如我们软件中的撤销操作（ctrl+z）；
再比如下棋app的悔棋操作；
再比如手机上提供的数据备份还原操作。
那今天我们就拿我们手机通讯录的备份还原功能来举例说明吧。

代码：

如果我们要实现该模式，应如何着手？
首先分析下备份的是什么？
当然是通讯录。所以我们要首先抽象个通讯录出来，因为通讯录中都是联系人，所以我们首先来定义联系人。

/// 

/// 联系人
/// 
public class ContactPerson
{
    public string Name { get; set; }

    public string PhoneNumber { get; set; }

    public ContactPerson(string name, string phoneNumber)
    {
        Name = name;
        PhoneNumber = phoneNumber;
    }
}

接下来我们来思考手机通讯录备份在哪？
备份在云端啊，这个云端就是我们的备忘录角色：

/// 

/// 备忘录
/// 
public class ContactMemento
{
    private readonly List _backupContactPersons;

    public List GetMemento()
    {
        return _backupContactPersons;
    }

    public ContactMemento(List backupContactPersons)
    {
        _backupContactPersons = backupContactPersons;
    }
}

我们这次讲的是手机通讯录的备份还原，我们要定义个手机。
对备份还原通讯录来说，这个操作是手机发出的，所以我们需要定义备份还原方法。

 /// 

 /// 手机用户
 /// 
 public class Mobile
 {
     private List _contactPersons;

     public List GetPhoneBook()
     {
         return _contactPersons;
     }

     public Mobile(List contactPersons)
     {
         _contactPersons = contactPersons;
     }

     /// 

     /// 创建备份
     /// 
     /// 
     public ContactMemento CreateMemento()
     {
         //思考以下为什么要new List(_contactPersons)
         return new ContactMemento(new List(_contactPersons));
     }

     /// 

     /// 恢复备份
     /// 
     /// 
     public void RestoreMemento(ContactMemento memento)
     {
         this._contactPersons = memento.GetMemento();
     }

     public void DisplayPhoneBook()
     {
         Console.WriteLine($"共有{_contactPersons.Count}位联系人，联系人列表如下：");
         foreach (var contactPerson in _contactPersons)
         {
             Console.WriteLine($"姓名：{contactPerson.Name}，电话：{contactPerson.PhoneNumber}");
         }
     }
 }

手机通讯录有了备份还原功能，又有了云端（备忘录）来保存备份，但云端可能同时有几个备份版本，所以我们需要引入备份管理类来决定从哪个备份还原不是？

/// 

/// 备忘录管理
/// 
public class Caretaker
{
    // 存储多个备份
    public Dictionary ContactMementoes { get; set; }
    public Caretaker()
    {
        ContactMementoes = new Dictionary();
    }
}

最后我们看具体的场景类：

 static void Main(string[] args)
{
    Console.WriteLine("======备忘录模式======");

    List persons = new List()
    {
        new ContactPerson("张三","13513757890"),
        new ContactPerson("李四","18563252369"),
        new ContactPerson("王二","17825635486"),
    };

    Mobile mobile = new Mobile(persons);

    mobile.DisplayPhoneBook();

    //备份通讯录
    Console.WriteLine("===通讯录已备份===");
    Caretaker caretaker = new Caretaker();
    string key = DateTime.Now.ToString(CultureInfo.InvariantCulture);
    caretaker.ContactMementoes.Add(DateTime.Now.ToString(CultureInfo.InvariantCulture), mobile.CreateMemento());
    Console.WriteLine($"==={key}：通讯录已备份===");

    //移除第一个联系人
    Console.WriteLine("----移除联系人----");
    mobile.GetPhoneBook().RemoveAt(0);
    mobile.DisplayPhoneBook();

    Thread.Sleep(2000);
    string key2 = DateTime.Now.ToString(CultureInfo.InvariantCulture);
    caretaker.ContactMementoes.Add(DateTime.Now.ToString(CultureInfo.InvariantCulture), mobile.CreateMemento());
    Console.WriteLine($"==={key2}：通讯录已备份===");

    //再移除一个联系人
    Console.WriteLine("----移除联系人----");
    mobile.GetPhoneBook().RemoveAt(0);
    mobile.DisplayPhoneBook();

    //恢复通讯录
    Console.WriteLine($"----恢复到最后一次通讯录备份：{caretaker.ContactMementoes.LastOrDefault().Key}----");
    mobile.RestoreMemento(caretaker.ContactMementoes.LastOrDefault().Value);

    mobile.DisplayPhoneBook();

    Console.ReadLine();
}

运行结果

总结：

备忘录模式看似简单，但具体使用时会有多种变体。在对对象进行备份时，需要考虑到对象的深浅拷贝问题。

优缺点：

备忘录模式给我们程序以后悔药，完善了业务场景。
备份的状态数据由额外的备忘录管理，备忘录又由管理者管理，符合单一职责原则。
如果需要维护多个备份，可能会影响系统的性能。

应用场景：

• 需要保存和恢复数据的相关状态场景。
• 提供一个可回滚（rollback）的操作。
• 需要监控的副本场景中。