后悔药,『备忘录模式』

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


定义:(Memento Pattern)

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

类图:

备忘录模式

启示:

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

代码:

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

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

    public string PhoneNumber { get; set; }

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

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

/// <summary>
/// 备忘录
/// </summary>
public class ContactMemento
{
    private readonly List<ContactPerson> _backupContactPersons;

    public List<ContactPerson> GetMemento()
    {
        return _backupContactPersons;
    }

    public ContactMemento(List<ContactPerson> backupContactPersons)
    {
        _backupContactPersons = backupContactPersons;
    }
}

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

 /// <summary>
 /// 手机用户
 /// </summary>
 public class Mobile
 {
     private List<ContactPerson> _contactPersons;

     public List<ContactPerson> GetPhoneBook()
     {
         return _contactPersons;
     }

     public Mobile(List<ContactPerson> contactPersons)
     {
         _contactPersons = contactPersons;
     }

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

     /// <summary>
     /// 恢复备份
     /// </summary>
     /// <param name="memento"></param>
     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}");
         }
     }
 }

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

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

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

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

    List<ContactPerson> persons = new List<ContactPerson>()
    {
        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)的操作。
  • 需要监控的副本场景中。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,117评论 4 360
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,963评论 1 290
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 107,897评论 0 240
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,805评论 0 203
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,208评论 3 286
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,535评论 1 216
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,797评论 2 311
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,493评论 0 197
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,215评论 1 241
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,477评论 2 244
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,988评论 1 258
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,325评论 2 252
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,971评论 3 235
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,055评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,807评论 0 194
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,544评论 2 271
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,455评论 2 266

推荐阅读更多精彩内容