設(shè)計模式系列 — 備忘錄模式

點(diǎn)贊再看龙致，養(yǎng)成習(xí)慣，公眾號搜一搜【一角錢技術(shù)】關(guān)注更多原創(chuàng)技術(shù)文章萤厅。本文 GitHub org_hejianhui/JavaStudy 已收錄，有我的系列文章靴迫。

前言

23種設(shè)計模式速記
單例（singleton）模式
工廠方法（factory method）模式
抽象工廠（abstract factory）模式
建造者/構(gòu)建器（builder）模式
原型（prototype）模式
享元（flyweight）模式
外觀（facade）模式
適配器（adapter）模式
裝飾（decorator）模式
觀察者（observer）模式
策略（strategy）模式
橋接（bridge）模式
模版方法（template method）模式
責(zé)任鏈（chain of responsibility）模式
組合（composite）模式
代理（proxy）模式
持續(xù)更新中......

23種設(shè)計模式快速記憶的請看上面第一篇惕味，本篇和大家一起來學(xué)習(xí)備忘錄模式相關(guān)內(nèi)容。

模式定義

在不破壞封裝性的前提下玉锌，捕獲一個對象的內(nèi)部狀態(tài)名挥，并在該對象之外保存這個狀態(tài)，以便以后當(dāng)需要時能將該對象恢復(fù)到原先保存的狀態(tài)主守。該模式又叫快照模式禀倔。

模版實現(xiàn)如下：

package com.niuh.designpattern.memento.v1;

/**
 * <p>
 * 備忘錄模式
 * </p>
 */
public class MementoPattern {
    public static void main(String[] args) {
        Originator or = new Originator();
        Caretaker cr = new Caretaker();
        or.setState("S0");
        System.out.println("初始狀態(tài):" + or.getState());
        cr.setMemento(or.createMemento()); //保存狀態(tài)      
        or.setState("S1");
        System.out.println("新的狀態(tài):" + or.getState());
        or.restoreMemento(cr.getMemento()); //恢復(fù)狀態(tài)
        System.out.println("恢復(fù)狀態(tài):" + or.getState());
    }
}

//備忘錄
class Memento {
    private String state;

    public Memento(String state) {
        this.state = state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public String getState() {
        return state;
    }
}

//發(fā)起人
class Originator {
    private String state;

    public void setState(String state) {
        this.state = state;
    }

    public String getState() {
        return state;
    }

    public Memento createMemento() {
        return new Memento(state);
    }

    public void restoreMemento(Memento m) {
        this.setState(m.getState());
    }
}

//管理者
class Caretaker {
    private Memento memento;

    public void setMemento(Memento m) {
        memento = m;
    }

    public Memento getMemento() {
        return memento;
    }
}

輸出結(jié)果如下：

初始狀態(tài):S0
新的狀態(tài):S1
恢復(fù)狀態(tài):S0

解決的問題

備忘錄模式能記錄一個對象的內(nèi)部狀態(tài)，當(dāng)用戶后悔時能撤銷當(dāng)前操作参淫，使數(shù)據(jù)恢復(fù)到它原先的狀態(tài)救湖。

每個人都有犯錯誤的時候，都希望有種“后悔藥”能彌補(bǔ)自己的過失黄刚，讓自己重新開始捎谨，但現(xiàn)實是殘酷的。在計算機(jī)應(yīng)用中憔维，客戶同樣會常常犯錯誤涛救，能否提供“后悔藥”給他們呢？當(dāng)然是可以的业扒，而且是有必要的检吆。這個功能由“備忘錄模式”來實現(xiàn)。

模式組成

備忘錄模式的核心是設(shè)計備忘錄類以及用于管理備忘錄的管理者類程储。

組成（角色）	作用
發(fā)起人（Originator）角色	記錄當(dāng)前時刻的內(nèi)部狀態(tài)信息蹭沛，提供創(chuàng)建備忘錄和恢復(fù)備忘錄數(shù)據(jù)的功能，實現(xiàn)其他業(yè)務(wù)功能章鲤，它可以訪問備忘錄里的所有信息摊灭。
備忘錄（Memento）角色	負(fù)責(zé)存儲發(fā)起人的內(nèi)部狀態(tài)，在需要的時候提供這些內(nèi)部狀態(tài)給發(fā)起人败徊。
管理者（Caretaker）角色	對備忘錄進(jìn)行管理帚呼，提供保存與獲取備忘錄的功能，但其不能對備忘錄的內(nèi)容進(jìn)行訪問與修改。

實例說明

實例概況

以游戲存檔為例煤杀，看一下如何用備忘錄模式實現(xiàn)

使用步驟

步驟1：定義備忘錄角色眷蜈，用于存儲角色狀態(tài)。

class RoleStateMemento {

    private int vit;    //生命力
    private int atk;    //攻擊力
    private int def;    //防御力

    public RoleStateMemento(int vit, int atk, int def) {
        this.vit = vit;
        this.atk = atk;
        this.def = def;
    }

    public int getVit() {
        return vit;
    }

    public void setVit(int vit) {
        this.vit = vit;
    }

    public int getAtk() {
        return atk;
    }

    public void setAtk(int atk) {
        this.atk = atk;
    }

    public int getDef() {
        return def;
    }

    public void setDef(int def) {
        this.def = def;
    }
}

步驟2：定義發(fā)起人角色（當(dāng)前游戲角色）沈自，記錄當(dāng)前游戲角色的生命力酌儒、攻擊力、防御力枯途。通過saveState()方法來保存當(dāng)前狀態(tài)忌怎，通過recoveryState()方法來恢復(fù)角色狀態(tài)。

class GameRole {

    private int vit;    //生命力
    private int atk;    //攻擊力
    private int def;    //防御力

    public int getVit() {
        return vit;
    }

    public void setVit(int vit) {
        this.vit = vit;
    }

    public int getAtk() {
        return atk;
    }

    public void setAtk(int atk) {
        this.atk = atk;
    }

    public int getDef() {
        return def;
    }

    public void setDef(int def) {
        this.def = def;
    }

    //狀態(tài)顯示
    public void stateDisplay() {
        System.out.println("角色當(dāng)前狀態(tài)：");
        System.out.println("體力：" + this.vit);
        System.out.println("攻擊力：" + this.atk);
        System.out.println("防御力： " + this.def);
        System.out.println("-----------------");
    }

    //獲得初始狀態(tài)
    public void getInitState() {
        this.vit = 100;
        this.atk = 100;
        this.def = 100;
    }

    //戰(zhàn)斗后
    public void fight() {
        this.vit = 0;
        this.atk = 0;
        this.def = 0;
    }

    //保存角色狀態(tài)
    public RoleStateMemento saveState() {
        return (new RoleStateMemento(vit, atk, def));
    }

    //恢復(fù)角色狀態(tài)
    public void recoveryState(RoleStateMemento memento) {
        this.vit = memento.getVit();
        this.atk = memento.getAtk();
        this.def = memento.getDef();
    }
}

步驟3：定義管理者角色柔袁，角色狀態(tài)管理者

class RoleStateCaretaker {

    private RoleStateMemento memento;

    public RoleStateMemento getMemento() {
        return memento;
    }

    public void setMemento(RoleStateMemento memento) {
        this.memento = memento;
    }
}

步驟4：測試輸出

public class MementoPattern {

    // 邏輯大致為打boss前存檔呆躲，打boss失敗了
    public static void main(String[] args) {
        //打boss前
        GameRole gameRole = new GameRole();
        gameRole.getInitState();
        gameRole.stateDisplay();

        //保存進(jìn)度
        RoleStateCaretaker caretaker = new RoleStateCaretaker();
        caretaker.setMemento(gameRole.saveState());

        //打boss失敗
        gameRole.fight();
        gameRole.stateDisplay();

        //恢復(fù)狀態(tài)
        gameRole.recoveryState(caretaker.getMemento());
        gameRole.stateDisplay();
    }
}

輸出結(jié)果

角色當(dāng)前狀態(tài)：
體力：100
攻擊力：100
防御力： 100
-----------------
角色當(dāng)前狀態(tài)：
體力：0
攻擊力：0
防御力： 0
-----------------
角色當(dāng)前狀態(tài)：
體力：100
攻擊力：100
防御力： 100
-----------------

優(yōu)點(diǎn)

備忘錄模式是一種對象行為型模式，其主要優(yōu)點(diǎn)如下捶索。

提供了一種可以恢復(fù)狀態(tài)的機(jī)制插掂。當(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)信息都保存在備忘錄中，并由管理者進(jìn)行管理构回，這符合單一職責(zé)原則夏块。

缺點(diǎn)

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

注意事項

為了符合迪米特法則，需要有一個管理備忘錄的類
不要在頻繁建立備份的場景中使用備忘錄模式借跪。為了節(jié)約內(nèi)存政己，可使用原型模式+備忘錄模式

應(yīng)用場景

需要保存和恢復(fù)數(shù)據(jù)的相關(guān)場景
提供一個可回滾的操作，如ctrl+z掏愁、瀏覽器回退按鈕歇由、Backspace鍵等
需要監(jiān)控的副本場景

模式的擴(kuò)展

在備忘錄模式中，有單狀態(tài)備份的例子果港，也有多狀態(tài)備份的例子沦泌。可以結(jié)合原型模式混合使用辛掠。在備忘錄模式中谢谦，通過定義“備忘錄”來備份“發(fā)起人”的信息，而原型模式的 clone() 方法具有自備份功能，所以他宛，如果讓發(fā)起人實現(xiàn) Cloneable 接口就有備份自己的功能，這時可以刪除備忘錄類欠气，其結(jié)構(gòu)如下：

源碼中的應(yīng)用

#Spring
org.springframework.binding.message.StateManageableMessageContext

StateManageableMessageContext 部分源碼

public interface StateManageableMessageContext extends MessageContext {

   /**
    * Create a serializable memento, or token representing a snapshot of the internal state of this message context.
    * @return the messages memento
    */
   public Serializable createMessagesMemento();

   /**
    * Set the state of this context from the memento provided. After this call, the messages in this context will match
    * what is encapsulated inside the memento. Any previous state will be overridden.
    * @param messagesMemento the messages memento
    */
   public void restoreMessages(Serializable messagesMemento);

   /**
    * Configure the message source used to resolve messages added to this context. May be set at any time to change how
    * coded messages are resolved.
    * @param messageSource the message source
    * @see MessageContext#addMessage(MessageResolver)
    */
   public void setMessageSource(MessageSource messageSource);
}

PS：以上代碼提交在 Github ：https://github.com/Niuh-Study/niuh-designpatterns.git

文章持續(xù)更新厅各，可以公眾號搜一搜「一角錢技術(shù) 」第一時間閱讀，本文 GitHub org_hejianhui/JavaStudy 已經(jīng)收錄预柒，歡迎 Star队塘。