C#設計模式學習筆記：(22)備忘錄模式

    本筆記摘抄自：https://www.cnblogs.com/PatrickLiu/p/8176974.html，記錄一下學習過程以備後續查用。

    一、引言

    今天我們要講行為型設計模式的第十個模式--備忘錄模式，先從名稱上來看。備忘錄模式可以理解為對某個對象的狀態進行保存，等到需要恢復的時

候，可以從備忘錄中進行恢復。生活中這樣的例子也能經常看到，如備份電話通訊錄、操作系統、資料庫等。如果我們想恢復對象的狀態，那麼我們可

能首先想到的是把對象保存下來，但是這樣會破壞對象的封裝性。因為對象有狀態有操作，如果我們為了保存狀態而留著原來的對象，做一個深拷貝，

那麼其它對象也能通過這個對象的介面來訪問這個對象狀態，這並不是我們所希望的。我們需要它的職責只是保存和恢復對象狀態，而不應在上面支持

對對象狀態訪問的介面，這就產生了Memento模式。

    看上圖，一個對象會有很多狀態。這些狀態會相互轉變而促進對象的發展，如果要想在某一時刻把當前對象恢復到以前某一時刻的狀態，這個情況用

“備忘錄模式”就能很好解決。

    二、備忘錄模式介紹

    備忘錄模式：英文名稱--Memento Pattern；分類--行為型。

    二、備忘錄模式的詳細介紹

    2.1、動機（Motivate）

    在軟體構建過程中，某些對象的狀態在轉換的過程中，可能由於某種需要，要求程式能夠回溯到對象之前處於某個點時的狀態。如果使用一些公有接

口來讓其它對象得到對象的狀態，便會暴露對象的細節實現。如何實現對象狀態的良好保存與恢復，但同時又不會因此而破壞對象本身的封裝性？

    2.2、意圖（Intent）

    在不破壞封裝性的前提下，捕獲一個對象的內部狀態，併在該對象之外保存這個狀態（如果沒有這個關鍵點，其實深拷貝就可以解決問題）。這樣以

後就可以將該對象恢復到原先保存的狀態。——《設計模式》GoF

    2.3、結構圖（Structure）

    2.4、模式的組成

    可以看出，在備忘錄模式的結構圖有以下角色：

    1）發起人角色（Originator）：記錄當前時刻的內部狀態，負責創建和恢復備忘錄數據。負責創建一個備忘錄Memento，用以記錄當前時刻自身的內

部狀態，並可使用備忘錄恢復內部狀態。Originator(發起人)可以根據需要決定Memento(備忘錄)存儲自己的哪些內部狀態。

    2）備忘錄角色（Memento）：負責存儲發起人對象的內部狀態，在進行恢復時提供給發起人需要的狀態，並可以防止Originator以外的其它對象訪問

備忘錄。備忘錄有兩個介面：Caretaker(管理角色)只能看到備忘錄的窄介面，它只能將備忘錄傳遞給其它對象。Originator(發起人)卻可看到備忘錄的寬

介面，允許它訪問返回到先前狀態時所需要的所有數據。

    3）管理者角色（Caretaker）：負責保存備忘錄對象。負責備忘錄Memento，不能對Memento的內容進行訪問或者操作。

    2.5、備忘錄模式的具體實現

    今天我們就用備份電話本的實例來說明備忘錄模式的實現，實現代碼如下：

    class Program
    {
        /// <summary>
        /// 聯繫人--需要備份的數據，是狀態數據，沒有操作。
        /// </summary>
        public sealed class ContactPerson
        {
            //姓名
            public string Name { get; set; }

            //電話號碼
            public string MobileNumber { get; set; }
        }

        /// <summary>
        /// 發起人--相當於發起人角色
        /// </summary>
        public sealed class MobileBackOriginator
        {
            //發起人需要保存的內部狀態
            public List<ContactPerson> ContactPersonList { get; set; }

            //初始化需要備份的電話名單
            public MobileBackOriginator(List<ContactPerson> contactPeopleList)
            {
                if (contactPeopleList != null)
                {
                    ContactPersonList = contactPeopleList;
                }
                else
                {
                    throw new ArgumentNullException("參數不能為空。");
                }
            }

            //創建備忘錄對象實例，將當期要保存的聯繫人列表保存到備忘錄對象中。
            public ContactPersonMemento CreateMemento()
            {
                return new ContactPersonMemento(new List<ContactPerson>(ContactPersonList));
            }

            //將備忘錄中的數據備份還原到聯繫人列表中
            public void RestoreMemento(ContactPersonMemento memento)
            {
                ContactPersonList = memento.ContactPersonListBack;
            }

            public void Show()
            {
                Console.WriteLine("聯繫人列表中共有{0}個人，他們分別是:", ContactPersonList.Count);
                foreach (ContactPerson p in ContactPersonList)
                {
                    Console.WriteLine("姓名: {0} 號碼: {1}", p.Name, p.MobileNumber);
                }
            }
        }

        /// <summary>
        /// 備忘錄對象，用於保存狀態數據，保存的是當時對象具體狀態數據--相當於備忘錄角色
        /// </summary>
        public sealed class ContactPersonMemento
        {
            //保存發起人創建的電話名單數據，就是所謂的狀態。
            public List<ContactPerson> ContactPersonListBack { get; private set; }

            public ContactPersonMemento(List<ContactPerson> contactPeopleList)
            {
                ContactPersonListBack = contactPeopleList;
            }
        }

        /// <summary>
        /// 管理角色，它可以管理備忘錄對象。如果是保存多個備忘錄對象，可以對其進行增、刪除等處理--相當於管理者角色
        /// </summary>
        public sealed class MementoManager
        {
            //如果想保存多個備忘錄對象，可以通過字典或者堆棧來保存，堆棧對象可以反映保存對象的先後順序。
            //比如：public Dictionary<string, ContactPersonMemento> ContactPersonMementoDictionary { get; set; }
            public ContactPersonMemento ContactPersonMemento { get; set; }
        }

        static void Main(string[] args)
        {
            #region 備忘錄模式
            List<ContactPerson> persons = new List<ContactPerson>()
            {
                new ContactPerson() { Name="黃飛鴻", MobileNumber = "15111111111"},
                new ContactPerson() { Name="方世玉", MobileNumber = "15122222222"},
                new ContactPerson() { Name="洪熙官", MobileNumber = "15133333333"}
            };

            //手機名單發起人
            MobileBackOriginator mobileOriginator = new MobileBackOriginator(persons);
            mobileOriginator.Show();
            Console.WriteLine();

            //創建備忘錄並保存備忘錄對象
            MementoManager manager = new MementoManager
            {
                ContactPersonMemento = mobileOriginator.CreateMemento()
            };

            //更改發起人聯繫人列表
            Console.WriteLine("移除最後一個聯繫人。");
            mobileOriginator.ContactPersonList.RemoveAt(2);
            mobileOriginator.Show();
            Console.WriteLine();

            //恢復到原始狀態
            Console.WriteLine("恢復聯繫人列表。");
            mobileOriginator.RestoreMemento(manager.ContactPersonMemento);
            mobileOriginator.Show();

            Console.Read();
            #endregion
        }
    }

    運行結果如下：

    三、備忘錄模式的實現要點

    備忘錄（Memento）存儲原發器（Originator）對象的內部狀態，在需要時恢複原發器狀態。Memento模式適用於“由原發器管理，卻又必須存儲在原

發器之外的信息”。

    在實現Memento模式中，要防止原發器以外的對象訪問備忘錄對象。備忘錄對象有兩個介面，一個為原發器使用的寬介面；一個為其他對象使用的窄

介面。在實現Memento模式時，要考慮拷貝對象狀態的效率問題，如果對象開銷比較大，可以採用某種增量式改變來改進Memento模式。

    我們也可以用序列化的方式實現備忘錄。序列化之後，我們可以把它臨時性保存到資料庫、文件、進程內、進程外等地方。

    3.1、備忘錄模式的主要優點

    1）如果某個操作錯誤地破壞了數據的完整性，此時可以使用備忘錄模式將數據恢覆成原來正確的數據。

    2）備份的狀態數據保存在發起人角色之外，這樣發起人就不需要對各個備份的狀態進行管理，而是由備忘錄角色進行管理，而備忘錄角色又是由管理

者角色管理，符合單一職責原則。

    3）提供了一種狀態恢復的實現機制，使得用戶可以方便地回到一個特定的歷史步驟。當新的狀態無效或者存在問題時，可以使用之前存儲起來的備忘

錄將狀態複原。

    4）實現了信息的封裝，一個備忘錄對象是一種原發器對象的表示，不會被其它代碼改動。這種模式簡化了原發器對象，備忘錄只保存原發器的狀態，

採用堆棧來存儲備忘錄對象可以實現多次撤銷操作，可以通過在管理者角色中定義集合對象來存儲多個備忘錄。

    5）本模式簡化了發起人類。發起人不再需要管理和保存其內部狀態的一個個版本，客戶端可以自行管理他們所需要的這些狀態的版本。

    6）當發起人角色的狀態改變的時候，有可能這個狀態無效，這時候就可以使用暫時存儲起來的備忘錄將狀態複原。

　3.2、備忘錄模式的主要缺點

    1）在實際的系統中，可能需要維護多個備份，需要額外的資源，這樣對資源的消耗比較嚴重。如果類的成員變數太多，就不可避免占用大量的記憶體，而

且每保存一次對象的狀態都需要消耗記憶體。如果知道這一點，大家就容易理解為什麼一些提供了撤銷功能的軟體在運行時所需的記憶體和硬碟空間比較大了。

    2）如果發起人角色的狀態需要完整地存儲到備忘錄對象中，那麼在資源消耗上面備忘錄對象會很昂貴。

    3）當管理者角色將一個備忘錄存儲起來的時候，管理者可能並不知道這個狀態會占用多大的存儲空間，從而無法提醒用戶一個操作是否很昂貴。

    4）當發起人角色的狀態改變的時候，有可能這個協議無效。

    3.3、在下麵的情況下可以考慮使用備忘錄模式

    1）如果系統需要提供回滾操作時，使用備忘錄模式非常合適。例如文本編輯器的Ctrl+Z撤銷操作、資料庫中事務操作。

    2）保存一個對象在某一個時刻的狀態或部分狀態，這樣以後需要時它能夠恢復到之前的狀態。

    3）如果用一個介面來讓其它對象得到這些狀態，將會暴露對象的實現細節並破壞對象的封裝性。一個對象不希望外界直接訪問其內部狀態，通過管理者

可以間接訪問其內部狀態。

    4）有時一些發起人對象的內部信息必須保存在發起人對象以外的地方，但是必須要由發起人對象自己讀取。這時，使用備忘錄模式可以把複雜的發起人

內部信息對其它的對象屏蔽起來，從而可以恰當地保持封裝的邊界。

    3.4、備忘錄的封裝性

    1）為了確保備忘錄的封裝性，除了原發器外，其它類是不能也不應該訪問備忘錄類。在實際開發中，原發器與備忘錄之間的關係是非常特殊的，它們要

分享信息而不讓其它類知道，實現的方法因編程語言的不同而不同。

    3.5、多備份實現

    1）在管理者中定義一個集合對象來存儲多個狀態，而且可以方便地返回到某一歷史狀態。

    2）在備份對象時可以做一些記號，這些記號稱為檢查點(Check Point)，在使用HashMap等實現時可以使用Key來設置檢查點。

    四、.NET中備忘錄模式的實現

    在現在的.Net框架裡面，還沒有找到備忘錄模式的實現，看來還是自己的功力不夠，還需努力。個人的理解，這種模式似乎在業務系統裡面使用的更多，

類似Word、Excel等工具可以有撤銷功能。其實很多軟體都有這個功能，軟體執行的時候，時時刻刻在把自己的狀態存儲，如果發生錯誤，或者需要撤銷的

時候就可以進行相關的操作。

    五、總結

    備忘錄模式剛開始理解起來還是挺麻煩的，但是，如果我們多看幾個實例代碼，完全掌握也不是問題。我們是不是感覺Memento模式和Command模式有

些類似？我們要仔細把握模式之間的異同，否則使用模式的時候就會出現張冠李戴的情況或者不能確定使用哪個模式好。Memento備忘錄模式和Command

命令模式其實還是有些細微的差別的，那就讓我們來看看它們的異同：雖然兩者都支持Undo操作，但是Command是對行為的封裝，Memento是對對象狀態

的保留，這是目的上的不同；它們支持的也是Undo操作的不同層面，Command是對行為序列的操作，Memento是對行為狀態的操作；命令模式保存的是發

起人的具體命令（命令對應的是行為），而備忘錄模式保存的是發起人的狀態（而狀態對應的數據結構，如屬性）。

    把握細節，理解模式的應用場景，這樣可以讓模式更好的為我們服務。