【C#设计模式-备忘录模式】

一.备忘录模式的定义：

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

二.备忘录模式的结构和角色：

1.Originator(发起人)：负责创建一个备忘录Memento，用以记录当前时刻自身的内部状态，并可使用备忘录恢复内部状态。Originator可以根据需要决定Memento存储自己的哪些内部状态。
2.Memento(备忘录)：负责存储Originator对象的内部状态，并可以防止Originator以外的其他对象访问备忘录。备忘录有两个接口：Caretaker只能看到备忘录的窄接口，他只能将备忘录传递给其他对象。Originator却可看到备忘录的宽接口，允许它访问返回到先前状态所需要的所有数据。
3.Caretaker(管理者):负责备忘录Memento，不能对Memento的内容进行访问或者操作。

三.备忘录模式的实现：

以备份手机通讯录的例子进行实现。

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

    /// <summary>
    /// 备忘录
    /// </summary>
    public class Memento
    {
        // 保存发起人的内部状态
        public List<ContactPerson> contactPersonBack;
        public Memento(List<ContactPerson> persons)
        {
            this.contactPersonBack = persons;
        }
    }

    /// <summary>
    /// 发起人
    /// </summary>
    public class Originator
    {
        //内部状态
        public List<ContactPerson> person;

        public Originator(List<ContactPerson> person)
        {
            this.person = person;
        }

        /// <summary>
        /// 创建备忘录
        /// </summary>
        /// <returns></returns>
        public Memento CreateMemento()
        {
            // 这里也应该传递深拷贝，new List方式传递的是浅拷贝，
            // 因为ContactPerson类中都是string类型,所以这里new list方式对ContactPerson对象执行了深拷贝
            // 如果ContactPerson包括非string的引用类型就会有问题，所以这里也应该用序列化传递深拷贝
            return new Memento(new List<ContactPerson>(this.person));
        }

        /// <summary>
        /// 将备忘录中的数据备份导入到联系人列表中
        /// </summary>
        /// <param name="memento"></param>
        public void RestoreMemento(Memento memento)
        {
            if (memento != null)
            {
                // 下面这种方式是错误的，因为这样传递的是引用，
                // 则删除一次可以恢复，但恢复之后再删除的话就恢复不了.
                // 所以应该传递contactPersonBack的深拷贝，深拷贝可以使用序列化来完成
                this.person = memento.contactPersonBack;
            }    
        }

        /// <summary>
        /// 显示信息
        /// </summary>
        public void Gethow()
        {
            Console.WriteLine("联系人列表中有{0}个人，他们是:", person.Count);
            for (int i = 0; i < person.Count; i++)
            {
                Console.WriteLine("姓名: {0} 号码为: {1}", person[i].name, person[i].tel);
            }
        }
    }

    /// <summary>
    /// 管理者
    /// </summary>
    public class Caretaker
    {
        // 使用多个备忘录来存储多个备份点
        public Dictionary<string, Memento> ContactMementoDic { get; set; }

        public Caretaker()
        {
            ContactMementoDic = new Dictionary<string, Memento>();
        }
    }

    /// <summary>
    /// C#设计模式-备忘录模式
    /// </summary>
    class Program
    {
        static void Main(string[] args)
        {
            int num = 0;

            List<ContactPerson> persons = new List<ContactPerson>()
            {
                new ContactPerson() { name=  "张三", tel = "111111111"},
                new ContactPerson() { name = "李四", tel = "000000000"},
                new ContactPerson() { name = "王五", tel = "333333333"}
            };
            Console.WriteLine("第【{0}】阶段",num);
            Originator admin = new Originator(persons);
            admin.Gethow();

            // 创建备忘录并保存备忘录对象
            Caretaker caretaker = new Caretaker();
            caretaker.ContactMementoDic.Add(num.ToString(), admin.CreateMemento());

            // 更改发起人联系人列表
            num += 1;
            Console.WriteLine("第【{0}】阶段", num);
            Console.WriteLine("----移除最后一个联系人--------");
            admin.person.RemoveAt(2);
            admin.Gethow();

            //创建第二个备份  
            Thread.Sleep(1000);
       
            caretaker.ContactMementoDic.Add(num.ToString(), admin.CreateMemento());

            //回复到默认状态
            var keycollection = caretaker.ContactMementoDic.Keys;

             while (true)
            {
                Console.Write("请输入数字，表示要回滚的阶段:");
                int index = -1;
                try
                {
                    index = Int32.Parse(Console.ReadLine());
                }
                catch
                {
                    Console.WriteLine("输入的格式错误");
                    continue;
                }
                Memento contactMentor = null;
                if (index < keycollection.Count && caretaker.ContactMementoDic.TryGetValue(keycollection.ElementAt(index), out contactMentor))
                {
                    admin.RestoreMemento(contactMentor);
                    admin.Gethow();
                }
                else
                {
                    Console.WriteLine("输入的索引大于集合长度！");
                }
            }     
        }
    }

四.备忘录模式的优缺点：

优点:
1、有时一些发起人对象的内部信息必须保存在发起人对象以外的地方，但是必须要由发起人对象自己读取，这时使用备忘录模式可以把复杂的发起人内部信息对其他的对象屏蔽起来，从而可以恰当地保持封装的边界。
2、本模式简化了发起人类。发起人不再需要管理和保存其内部状态的一个个版本，客户端可以自行管理他们所需要的这些状态的版本。
3、当发起人角色的状态改变的时候，有可能这个状态无效，这时候就可以使用暂时存储起来的备忘录将状态复原。
缺点：
1、如果发起人角色的状态需要完整地存储到备忘录对象中，那么在资源消耗上面备忘录对象会很昂贵。
2、当负责人角色将一个备忘录 存储起来的时候，负责人可能并不知道这个状态会占用多大的存储空间，从而无法提醒用户一个操作是否很昂贵。
3、当发起人角色的状态改变的时候，有可能这个协议无效。如果状态改变的成功率不高的话，不如采取“假如”协议模式。