軟件構(gòu)造|備忘錄模式

一、備忘錄模式(Memento Pattern):

也稱為快照模式(Snapshot Pattern)23種設(shè)計模式之一,屬于行為模式

定義:在不破壞封閉的前提下,捕獲一個對象的內(nèi)部狀態(tài),并在該對象之外保存這個狀態(tài)。這樣以后就可將該對象恢復(fù)到原先保存的狀態(tài)。

二、備忘錄模式的結(jié)構(gòu)

涉及角色

? 發(fā)起人:負(fù)責(zé)創(chuàng)建一個備忘錄Memento,用以記錄當(dāng)前時刻自身的內(nèi)部狀態(tài),并可使用備忘錄恢復(fù)內(nèi)部狀態(tài)。Originator可以根據(jù)需要決定Memento存儲自己的哪些內(nèi)部狀態(tài)。

? 備忘錄:負(fù)責(zé)存儲Originator對象的內(nèi)部狀態(tài),并可以防止Originator以外的其他對象訪問備忘錄。備忘錄有兩個接口:Caretaker只能看到備忘錄的窄接口,他只能將備忘錄傳遞給其他對象。Originator卻可看到備忘錄的寬接口,允許它訪問返回到先前狀態(tài)所需要的所有數(shù)據(jù)。

?? 為了控制對備忘錄對象的訪問,備忘錄模式中出現(xiàn)了窄接口寬接口的概念。

? ? ? ? ? ? 窄接口:管理者只能看到備忘錄的窄接口,窄接口的實現(xiàn)中通常沒有任何的方法,只是一個類型標(biāo)識。窄接口使得管理者只能將備忘錄傳遞給其他對象。

? ? ? ? ? ? 寬接口:原發(fā)器能夠看到備忘錄的寬接口,從而可以從備忘錄中獲取到所需的數(shù)據(jù),來將自己恢復(fù)到備忘錄中所保存的狀態(tài)。理想情況是:只允許生成備忘錄的原發(fā)器來訪問該備忘錄的內(nèi)部狀態(tài),通常實現(xiàn)成為原發(fā)器內(nèi)的一個私有內(nèi)部類。

? 管理者:負(fù)責(zé)備忘錄Memento,不能對Memento的內(nèi)容進行訪問或者操作。


備忘錄模式結(jié)構(gòu)圖


簡單實現(xiàn)備忘錄的基本結(jié)構(gòu):

備忘錄窄接口定義:


發(fā)起者(Originator):通過創(chuàng)建一個新的備忘錄對象來保存自己的內(nèi)部狀態(tài) 示例代碼如圖:??

Originator


備忘錄管理者(Caretaker):負(fù)責(zé)保存?zhèn)渫泴ο?,但是從不修改(甚至不查看)備忘錄對象的?nèi)容。

備忘錄管理者

創(chuàng)建一個客戶端測試 示例代碼如圖:

測試

運行程序打印結(jié)果如下:?

運行結(jié)果


備忘錄模式具有封閉性,對于狀態(tài)得存儲只有發(fā)起者知道。


三、備忘錄模式的使用場景

? 需要保存和恢復(fù)數(shù)據(jù)的相關(guān)狀態(tài)場景。

? 提供一個可回滾(rollback)的操作。

? 數(shù)據(jù)庫連接的事務(wù)管理就是用的備忘錄模式。

提出幾個實例方便我們理解:

?瀏覽器回退:瀏覽器一般有瀏覽記錄,當(dāng)我們在一個網(wǎng)頁上點擊幾次鏈接之后,可在左上角點擊左箭頭回退到上一次的頁面,然后也可以點擊右箭頭重新回到當(dāng)前頁面

? 數(shù)據(jù)庫備份與還原:一般的數(shù)據(jù)庫都支持備份與還原操作,備份即將當(dāng)前已有的數(shù)據(jù)或者記錄保留,還原即將已經(jīng)保留的數(shù)據(jù)恢復(fù)到對應(yīng)的表中

?編輯器撤銷與重做:在編輯器上編輯文字,寫錯時可以按快捷鍵 Ctrl + z 撤銷,撤銷后可以按 Ctrl + y 重做

? 虛擬機生成快照與恢復(fù):虛擬機可以生成一個快照,當(dāng)虛擬機發(fā)生錯誤時可以恢復(fù)到快照的樣子

?Git版本管理:Git是最常見的版本管理軟件,每提交一個新版本,實際上Git就會把它們自動串成一條時間線,每個版本都有一個版本號,使用 git reset --hard 版本號 即可回到指定的版本,讓代碼時空穿梭回到過去某個歷史時刻

?棋牌游戲悔棋:在棋牌游戲中,有時下快了可以悔棋,回退到上一步重新下。

示例1:在棋牌游戲中可以悔棋,即重新退回到上一步重新下棋。

棋子類 Chessman原發(fā)器角色:

@Data

@AllArgsConstructor

class Chessman {

? ? private String label;

? ? private int x;

? ? private int y;

? ? //保存狀態(tài)

? ? public ChessmanMemento save() {

? ? ? ? return new ChessmanMemento(this.label, this.x, this.y);

? ? }

? ? //恢復(fù)狀態(tài)

? ? public void restore(ChessmanMemento memento) {

? ? ? ? this.label = memento.getLabel();

? ? ? ? this.x = memento.getX();

? ? ? ? this.y = memento.getY();

? ? }

? ? public void show() {

? ? ? ? System.out.println(String.format("棋子<%s>:當(dāng)前位置為:<%d, %d>", this.getLabel(), this.getX(), this.getY()));

? ? }

}

備忘錄角色 ChessmanMemento:

@Data

@AllArgsConstructor

class ChessmanMemento {

? ? private String label;

? ? private int x;

? ? private int y;

}

負(fù)責(zé)人角色 MementoCaretaker:

class MementoCaretaker {

?? //定義一個集合來存儲備忘錄

? ? private ArrayList mementolist = new ArrayList();

? ? public ChessmanMemento getMemento(int i) {

? ? ? ? return (ChessmanMemento) mementolist.get(i);

? ? }

? ? public void addMemento(ChessmanMemento memento) {

? ? ? ? mementolist.add(memento);

? ? }

}

棋子客戶端,維護MementoCaretaker 對象:

class Client{

? ? private static int index = -1;

? ? private static MementoCaretaker mc = new MementoCaretaker();

? ? public static void main(String args[]) {

? ? ? ? Chessman chess = new Chessman("車", 1, 1);

? ? ? ? play(chess);

? ? ? ? chess.setY(4);

? ? ? ? play(chess);

? ? ? ? chess.setX(5);

? ? ? ? play(chess);

? ? ? ? undo(chess, index);

? ? ? ? undo(chess, index);

? ? ? ? redo(chess, index);

? ? ? ? redo(chess, index);

? ? }

? ? //下棋,同時保存?zhèn)渫?/p>

? ? public static void play(Chessman chess) {

? ? ? ? mc.addMemento(chess.save());

? ? ? ? index++;

? ? ? ? chess.show();

? ? }

? ? //悔棋,撤銷到上一個備忘錄

? ? public static void undo(Chessman chess, int i) {

? ? ? ? System.out.println("******悔棋******");

? ? ? ? index--;

? ? ? ? chess.restore(mc.getMemento(i - 1));

? ? ? ? chess.show();

? ? }

? ? //撤銷悔棋,恢復(fù)到下一個備忘錄

? ? public static void redo(Chessman chess, int i) {

? ? ? ? System.out.println("******撤銷悔棋******");

? ? ? ? index++;

? ? ? ? chess.restore(mc.getMemento(i + 1));

? ? ? ? chess.show();

? ? }

}

運行結(jié)果:

輸出如下,悔棋成功,撤銷悔棋成功

程序類圖:

程序類圖

示例2:備份電話本

聯(lián)系人:需要備份的數(shù)據(jù),是狀態(tài)數(shù)據(jù),沒有操作

public sealed class ContactPerson

{

? ? //姓名? ? public string Name { get; set; }

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

}

發(fā)起人:

public sealed class MobileBackOriginator

{

? ? // 發(fā)起人需要保存的內(nèi)部狀態(tài)? ? private List<ContactPerson> _personList;

? ? public List<ContactPerson> ContactPersonList

? ? {

? ? ? ? get? ? ? ? {

? ? ? ? ? ? return this._personList;

? ? ? ? }

? ? ? ? set? ? ? ? {

? ? ? ? ? ? this._personList = value;

? ? ? ? }

? ? }

? ? //初始化需要備份的電話名單? ? public MobileBackOriginator(List<ContactPerson> personList)

? ? {

? ? ? ? if (personList != null)

? ? ? ? {

? ? ? ? ? ? this._personList = personList;

? ? ? ? }

? ? ? ? else? ? ? ? {

? ? ? ? ? ? throw new ArgumentNullException("參數(shù)不能為空!");

? ? ? ? }

? ? }

? ? // 創(chuàng)建備忘錄對象實例,將當(dāng)期要保存的聯(lián)系人列表保存到備忘錄對象中? ? public ContactPersonMemento CreateMemento()

? ? {

? ? ? ? return new ContactPersonMemento(new List<ContactPerson>(this._personList));

? ? }

? ? // 將備忘錄中的數(shù)據(jù)備份還原到聯(lián)系人列表中? ? public void RestoreMemento(ContactPersonMemento memento)

? ? {

? ? ? ? this.ContactPersonList = memento.ContactPersonListBack;

? ? }

? ? public void Show()

? ? {

? ? ? ? Console.WriteLine("聯(lián)系人列表中共有{0}個人,他們是:", ContactPersonList.Count);

? ? ? ? foreach (ContactPerson p in ContactPersonList)

? ? ? ? {

? ? ? ? ? ? Console.WriteLine("姓名: {0} 號碼: {1}", p.Name, p.MobileNumber);

? ? ? ? }

? ? }

}

備忘錄對象:用于保存狀態(tài)數(shù)據(jù),保存的是當(dāng)時對象具體狀態(tài)數(shù)據(jù)>>相當(dāng)于備忘錄角色(Memeto)

publicsealedclass ContactPersonMemento

{

? ? // 保存發(fā)起人創(chuàng)建的電話名單數(shù)據(jù),就是所謂的狀態(tài)publicList ContactPersonListBack {get;privateset; }

? ? publicContactPersonMemento(List personList)

? ? {

? ? ? ? ContactPersonListBack = personList;

? ? }

}

管理角色:它可以管理備忘錄對象,如果是保存多個備忘錄對象,可以對保存的對象進行增、刪等管理處理>>相當(dāng)于管理者角色(Caretaker)

public sealed class MementoManager

{

? ? //如果想保存多個備忘錄對象,可以通過字典或者堆棧來保存,堆棧對象可以反映保存對象的先后順序

? ? //比如:public Dictionary<string, ContactPersonMemento> ContactPersonMementoDictionary { get; set; }? ? public ContactPersonMemento ContactPersonMemento { get; set; }

}

客戶端代碼:

class Program

{

? ? static void Main(string[] args)

? ? {

? ? ? ? List<ContactPerson> persons = new List<ContactPerson>()

? ? ? ? ? ? {

? ? ? ? ? ? ? ? new ContactPerson() { Name="小明", MobileNumber = "11111111"},

? ? ? ? ? ? ? ? new ContactPerson() { Name="小紅", MobileNumber = "22222222"},

? ? ? ? ? ? ? ? new ContactPerson() { Name="小華", MobileNumber = "33333333"}

? ? ? ? ? ? };

? ? ? ? //手機名單發(fā)起人? ? ? ? MobileBackOriginator mobileOriginator = new MobileBackOriginator(persons);

? ? ? ? mobileOriginator.Show();

? ? ? ? // 創(chuàng)建備忘錄并保存?zhèn)渫泴ο? ? ? ? MementoManager manager = new MementoManager();

? ? ? ? manager.ContactPersonMemento = mobileOriginator.CreateMemento();

? ? ? ? // 更改發(fā)起人聯(lián)系人列表? ? ? ? Console.WriteLine("----移除最后一個聯(lián)系人--------");

? ? ? ? mobileOriginator.ContactPersonList.RemoveAt(2);

? ? ? ? mobileOriginator.Show();

? ? ? ? // 恢復(fù)到原始狀態(tài)? ? ? ? Console.WriteLine("-------恢復(fù)聯(lián)系人列表------");

? ? ? ? mobileOriginator.RestoreMemento(manager.ContactPersonMemento);

? ? ? ? mobileOriginator.Show();

? ? ? ? Console.Read();

? ? }

}



、備忘錄模式的適用性

在以下條件下可以考慮使用備忘錄模式:

? ? ? ? ? ? 如果必須保存一個對象在某一個時刻的全部或部分狀態(tài),方便在以后需要的時候,可以把該對象恢復(fù)到先前的狀態(tài)。

? ? ? ? ? ? 如果需要保存一個對象的內(nèi)部狀態(tài),但是如果用接口來讓其它對象直接得到這些需要保存的狀態(tài),將會暴露對象的實現(xiàn)細(xì)節(jié)并破壞對象的封裝性,這時可以使用備忘錄模式,把備忘錄對象實現(xiàn)成為原發(fā)器對象的私有內(nèi)部類,從而保證只有原發(fā)器對象才能訪問該備忘錄對象。這樣既保存了需要保存的狀態(tài),又不會暴露原發(fā)器對象的內(nèi)部實現(xiàn)細(xì)節(jié)。 ?

主要優(yōu)點

?? 提供了一種可以恢復(fù)狀態(tài)的機制。當(dāng)用戶需要時能夠比較方便地將數(shù)據(jù)恢復(fù)到某個歷史的狀態(tài)。

?? 實現(xiàn)了內(nèi)部狀態(tài)的封裝。除了創(chuàng)建它的發(fā)起人之外,其他對象都不能夠訪問這些狀態(tài)信息。

?? 簡化了發(fā)起人類。發(fā)起人不需要管理和保存其內(nèi)部狀態(tài)的各個備份,所有狀態(tài)信息都保存在備忘錄中,并由管理者進行管理,這符合單一職責(zé)原則。

?? 更好的封裝性:備忘錄模式通過使用備忘錄對象,來封裝原發(fā)器對象的內(nèi)部狀態(tài),雖然這個對象是保存在原發(fā)器對象的外部,但是由于備忘錄對象的窄接口并不提供任何方法。這樣有效地保證了對原發(fā)器對象內(nèi)部狀態(tài)的封裝,不把原發(fā)器對象的內(nèi)部實現(xiàn)細(xì)節(jié)暴露給外部。

?? 簡化了原發(fā)器:在備忘錄模式中,原發(fā)器不再需要管理和保存其內(nèi)部狀態(tài)的一個個版本,而是交由管理者或客戶端對這些狀態(tài)的版本進行管理,從而讓原發(fā)器對象得到簡化。

??? 窄接口和寬接口:備忘錄模式,通過引入窄接口和寬接口,使得不同的地方,對備忘錄對象的訪問是不一樣的。窄接口保證了只有原發(fā)器才可以訪問備忘錄對象存儲的狀態(tài)。

主要缺點

?? 資源消耗大。如果要保存的內(nèi)部狀態(tài)信息過多或者特別頻繁,將會占用比較大的內(nèi)存資源。

?? 如果發(fā)起人角色的狀態(tài)需要完整地存儲到備忘錄對象中,那么在資源消耗上面?zhèn)渫泴ο髸馨嘿F。

?? 當(dāng)負(fù)責(zé)人角色將一個備忘錄 存儲起來的時候,負(fù)責(zé)人可能并不知道這個狀態(tài)會占用多大的存儲空間,從而無法提醒用戶一個操作是否很昂貴。

?? 當(dāng)發(fā)起人角色的狀態(tài)改變的時候,有可能這個協(xié)議無效。如果狀態(tài)改變的成功率不高的話,不如采取“假如”協(xié)議模式。


五、備忘錄模式的實現(xiàn)

? ? ? ? 增量存儲: 如果需要頻繁地創(chuàng)建備忘錄對象,而且創(chuàng)建和應(yīng)用備忘錄對象來恢復(fù)狀態(tài)的順序是可控的,那么可以讓備忘錄進行增量存儲,也就是備忘錄可以僅僅存儲原發(fā)器內(nèi)部相對于上一次存儲狀態(tài)后的增量改變。

? ? ?? 結(jié)合原型模式:在原發(fā)器對象創(chuàng)建備忘錄對象的時候,如果原發(fā)器對象中全部或者大部分的狀態(tài)都需要保存,一個簡潔的方式就是直接克隆一個原發(fā)器對象。

? ?? ?? 離線存儲:備忘錄的數(shù)據(jù)可以實現(xiàn)成為離線存儲,除了存儲在內(nèi)存中,還可以把備忘錄數(shù)據(jù)存儲到文件中、XML中、數(shù)據(jù)庫中,從而支持跨越會話的備份和恢復(fù)功能。 ?


六、總結(jié)

? ? ?? 備忘錄模式的功能,首先是在不破壞封裝性的前提下,捕獲一個對象的內(nèi)部狀態(tài)。同時注意:一個是不破壞封裝性,即對象不能暴露它不應(yīng)該暴露的細(xì)節(jié);另外一個是捕獲的是對象的內(nèi)部狀態(tài),而且通常還是運行期間某個時刻對象的內(nèi)部狀態(tài)。

? ? ?? 之所以要捕獲這些內(nèi)部狀態(tài),是為了在以后的某個時候,可以將該對象的狀態(tài)恢復(fù)到備忘錄所保存的狀態(tài),這才是備忘錄真正的目的。前面保存狀態(tài)就是為了后面恢復(fù),雖然不是一定要恢復(fù),但是目的是為了恢復(fù)。

? ? ? ? 在備忘錄模式中,備忘錄對象通常用來記錄原發(fā)器中需要保存的內(nèi)部狀態(tài),為了不破壞原發(fā)器對象的封裝性,一般只讓原發(fā)器自己來操作它的備忘錄對象。為了保證這一點,通常會把備忘錄對象作為原發(fā)器對象的內(nèi)部類來實現(xiàn),而且實現(xiàn)成私有的,這樣就斷了外部來訪問這個備忘錄對象的途徑。?

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

友情鏈接更多精彩內(nèi)容