第24章　備忘錄模式 24.1 如此追女孩子，你還不樂 大家有沒有看過尼古拉斯·凱奇主演的《Next》（中文譯名為《預見未來》）？尼古拉斯·凱奇飾演一個可以預視并且扭轉未來的人，其中有一個情節很是讓人心動——男女主角見面的那段情節：Cris Johnson（尼古拉斯·凱奇飾演）坐在咖啡吧臺前，看著離自己近在咫尺的Callie Ferris（朱莉安·摩爾飾演），計劃著怎么認識這個命中注定的女人，看Cris Johnson如何利用自己的特異功能： ● Cris Johnson端著一杯咖啡走過去，說“你好，可以認識你嗎？”被拒絕，恢復到坐在咖啡吧臺前的狀態。 ● 走過去詢問是否可以搭車，被拒絕，恢復原狀。 ● 幫助解決困境，被拒絕，恢復原狀。 ● 采用嬉皮士的方式解決困境，被拒絕，恢復原狀。 ● 幫助解決困境，被打傷，裝可憐，Callie Ferris憐惜，于是乎相識了。 看看這是一件多么幸福的事情，追求一個女生可以多次反復地實驗，直到找到好的方法和途徑為止，這估計是大多數男生都希望獲得的特異功能。想想看，看到一個心儀的女生，我們若反復嘗試，總會有一個方法打動她的，多美好的一件事。現在我們還得回到現實生活，我們來分析一下類似事情的經過： ● 復制一個當前狀態，保留下來，這個狀態就是等會兒搭訕女孩子失敗后要恢復的狀態，你不恢復原始狀態，這不就露餡兒了嗎？ ● 每次試探性嘗試失敗后，都必須恢復到這個原始狀態。 ● N次試探總有一次成功吧，成功以后即可走成功路線。 想想看，我們這里的場景中最重要的是哪一塊？對的，是原始狀態的保留和恢復這塊，如何保留一個原始，如何恢復一個原始狀態才是最重要的，那想想看，我們應該怎么實現呢？很簡單呀，我們可以定義一個中間變量，保留這個原始狀態。我們先看看類圖，如圖24-1所示。  圖24-1 男孩狀態類圖 太簡單的類圖了，我們來解釋一下圖中的狀態state是什么意思，在某一時間點的所有位置信息、心理信息、環境信息都屬于狀態，我們這里用了一個標識性的名詞state代表所有狀態，比如在追女孩子前心情是期待、心理是焦躁不安等。每一次去認識女孩子都是會發生狀態變化的，我們使用changeState方法來代替，由于程序比較簡單，就沒有編寫接口，我們來看實現，如代碼清單24-1所示。 代碼清單24-1 男孩狀態類 public?class?Boy?{ ?????//男孩的狀態 ?????private?String?state?=?""; ?????//認識女孩子后狀態肯定改變，比如心情、手中的花等 ?????public?void?changeState(){ ?????????????this.state?=?"心情可能很不好"; ?????} ?????public?String?getState()?{ ?????????????return?state; ?????} ?????public?void?setState(String?state)?{ ?????????????this.state?=?state; ?????} } 程序是很簡單，主要的業務邏輯是在場景類中，我們來看場景類是如何進行狀態的保留、恢復的，如代碼清單24-2所示。 代碼清單24-2 場景類 public?class?Client?{ ?????public?static?void?main(String[]?args)?{ ?????????????//聲明出主角 ?????????????Boy?boy?=?new?Boy(); ?????????????//初始化當前狀態 ?????????????boy.setState("心情很棒！"); ?????????????System.out.println("=====男孩現在的狀態======"); ?????????????System.out.println(boy.getState()); ?????????????//需要記錄下當前狀態呀 ?????????????Boy?backup?=?new?Boy(); ?????????????backup.setState(boy.getState()); ?????????????//男孩去追女孩，狀態改變 ?????????????boy.changeState(); ?????????????System.out.println("\n=====男孩追女孩子后的狀態======"); ?????????????System.out.println(boy.getState()); ?????????????//追女孩失敗，恢復原狀 ?????????????boy.setState(backup.getState()); ?????????????System.out.println("\n=====男孩恢復后的狀態======"); ?????????????System.out.println(boy.getState());????? ?????} } 程序運行結果如下所示： =====男孩現在的狀態====== 心情很棒！ =====男孩追女孩子后的狀態====== 心情可能很不好 =====男孩恢復后的狀態====== 心情很棒！ 程序運行正確，輸出結果也是我們期望的，但是結果正確并不表示程序是最優的，我們來看看場景類Client，它代表的是高層模塊，或者說是非“近親”模塊的調用者，注意看backup變量的使用，它對于高層模塊完全是多余的，為什么一個狀態的保存和恢復要讓高層模塊來負責呢？這應該是Boy類的職責，而不應該讓高層模塊來完成，也就是破壞了Boy類的封裝，或者說Boy類沒有封裝好，它應該是把backup的定義容納進來，而不應該讓高層模塊來定義。 問題我們已經知道了，就是Boy類封裝不夠，那我們應該如何修改呢？如果在Boy類中再增加一個方法或者其他的內部類來保存這個狀態，則對單一職責原則是一種破壞，想想看單一職責原則是怎么說的？一個類的職責應該是單一的，Boy類本身的職責是追求女孩子，而保留和恢復原始狀態則應該由另外一個類來承擔，那我們把這個類取名就叫做備忘錄，這和大家經常在桌面上貼的那個便簽是一個概念，分析到這里我們的思路已經非常清楚了，我們來修改一下類圖，如圖24-2所示。  圖24-2 完善后的男孩狀態類圖 改動很小，增加了一個新的類Memento，負責狀態的保存和備份；同時，在Boy類中增加了創建一份備忘錄createMemento和恢復一個備忘錄resotreMemento，我們先來看Boy類的變化，如代碼清單24-3所示。 代碼清單24-3 改進后的男孩狀態類 public?class?Boy?{ ?????//男孩的狀態 ?????private?String?state?=?""; ?????//認識女孩子后狀態肯定改變，比如心情、手中的花等 ?????public?void?changeState(){ ?????????????this.state?=?"心情可能很不好"; ?????} ?????public?String?getState()?{ ?????????????return?state; ?????} ?????public?void?setState(String?state)?{ ?????????????this.state?=?state; ?????} ?????//保留一個備份 ?????public?Memento?createMemento(){ ?????????????return?new?Memento(this.state); ?????} ?????//恢復一個備份 ?????public?void?restoreMemento(Memento?_memento){ ??????????this.setState(_memento.getState()); ?????} } 注意看，確實只增加了兩個方法創建備份和恢復備份，至于在什么時候創建備份和恢復備份則是由高層模塊決定的。我們再來看備忘錄模塊，如代碼清單24-4所示。 代碼清單24-4 備忘錄 public?class?Memento?{ ?????//男孩的狀態 ?????private?String?state?=?""; ?????//通過構造函數傳遞狀態信息 ?????public?Memento(String?_state){ ?????????????this.state?=?_state; ?????} ?????public?String?getState()?{ ?????????????return?state; ?????} ?????public?void?setState(String?state)?{ ?????????????this.state?=?state; ?????} } 這就是一個簡單的JavaBean，保留男孩當時的狀態信息。我們再來看場景類，稍做修改，如代碼清單24-5所示。 代碼清單24-5 改進后的場景類 public?class?Client?{ ?????public?static?void?main(String[]?args)?{ ?????????????//聲明出主角 ?????????????Boy?boy?=?new?Boy(); ?????????????//初始化當前狀態 ?????????????boy.setState("心情很棒！"); ?????????????System.out.println("=====男孩現在的狀態======"); ?????????????System.out.println(boy.getState()); ?????????????//需要記錄下當前狀態呀 ?????????????Memento?mem?=?boy.createMemento(); ?????????????//男孩去追女孩，狀態改變 ?????????????boy.changeState(); ?????????????System.out.println("\n=====男孩追女孩子后的狀態======"); ?????????????System.out.println(boy.getState()); ?????????????//追女孩失敗，恢復原狀 ?????????????boy.restoreMemento(mem); ?????????????System.out.println("\n=====男孩恢復后的狀態======"); ?????????????System.out.println(boy.getState()); ?????} } 運行結果保持相同，雖然程序中不再重復定義Boy類的對象了，但是我們還是要關心備忘錄，這對迪米特法則是一個褻瀆，它告訴我們只和朋友類通信，那這個備忘錄對象是我們必須要通信的朋友類嗎？對高層模塊來說，它最希望要做的就是創建一個備份點，然后在需要的時候再恢復到這個備份點就成了，它不用關心到底有沒有備忘錄這個類。那根據這一指導思想，我們就需要把備忘錄類再包裝一下，怎么包裝呢？建立一個管理類，就是管理這個備忘錄，如圖24-3所示。  圖24-3 完整的男孩追女生類圖 又增加了一個JavaBean，Boy類和Memento沒有任何改變，不再贅述。我們來看增加的備忘錄管理類，如代碼清單24-6所示。 代碼清單24-6 備忘錄管理者 public?class?Caretaker?{ ?????//備忘錄對象 ?????private?Memento?memento; ?????public?Memento?getMemento()?{ ?????????????return?memento; ?????} ?????public?void?setMemento(Memento?memento)?{ ?????????????this.memento?=?memento; ?????} } 這個太簡單了，非常純粹的一個JavaBean，甭管它多簡單，只要有用就成，我們來看場景類如何調用，如代碼清單24-7所示。 代碼清單24-7 進一步改進后的場景類 public?class?Client?{ ?????public?static?void?main(String[]?args)?{ ?????????????//聲明出主角 ?????????????Boy?boy?=?new?Boy(); ?????????????//聲明出備忘錄的管理者 ?????????????Caretaker?caretaker?=?new?Caretaker(); ?????????????//初始化當前狀態 ?????????????boy.setState("心情很棒！"); ?????????????System.out.println("=====男孩現在的狀態======"); ?????????????System.out.println(boy.getState()); ?????????????//需要記錄下當前狀態呀 ?????????????caretaker.setMemento(boy.createMemento()); ?????????????//男孩去追女孩，狀態改變 ?????????????boy.changeState(); ?????????????System.out.println("\n=====男孩追女孩子后的狀態======"); ?????????????System.out.println(boy.getState()); ?????????????//追女孩失敗，恢復原狀 ?????????????boy.restoreMemento(caretaker.getMemento()); ?????????????System.out.println("\n=====男孩恢復后的狀態======"); ?????????????System.out.println(boy.getState()); ?????} } 注意看黑體部分，就修改了這么多，看看程序的邏輯是不是清晰了很多，需要備份的時候就創建一個備份，然后丟給備忘錄管理者進行管理，要取的時候再從管理者手中拿到這個備份。這個備份者就類似于一個備份的倉庫管理員，創建一個丟進去，需要的時候再拿出來。這就是備忘錄模式。