簡說設計模式——備忘錄模式

一、什麼是備忘錄模式

　　備忘錄這個詞彙大家應該都不陌生，我就經常使用備忘錄來記錄一些比較重要的或者容易遺忘的資訊，與之相關的最常見的應用有許多，比如遊戲存檔，我們玩遊戲的時候肯定有存檔功能，旨在下一次登入遊戲時可以從上次退出的地方繼續遊戲，或者對復活點進行存檔，如果掛掉了則可以讀取復活點的存檔資訊重新開始。與之相類似的就是資料庫的事務回滾，或者重做日誌redo log等。

　　備忘錄模式（Memento），在不破壞封裝性的前提下，捕獲一個物件的內部狀態，並在該物件之外儲存著這個狀態。這樣以後就可將該物件恢復到原先儲存的狀態。UML結構圖如下：

　　其中，Originator是發起人，負責建立一個備忘錄Memento，用以記錄當前時刻它的內部狀態，並可使用備忘錄恢復內部狀態；Memento是備忘錄，負責儲存Originator物件的內部狀態，並可防止Originator以外的其他物件訪問備忘錄Memento；Caretaker是管理者，負責儲存好備忘錄的Memento，不能對備忘錄的內容進行操作或檢查。

　　1. 發起人角色

　　記錄當前時刻的內部狀態，並負責建立和恢復備忘錄資料，允許訪問返回到先前狀態所需的所有資料。

public class Originator {
    
    private String state;

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
    
    public Memento createMento() {
        return (new Memento(state));
    }
    
    public void setMemento(Memento memento) {
        state = memento.getState();
    }
    
    public void show() {
        System.out.println("state = " + state);
    }
    
}

　　2. 備忘錄角色

　　負責儲存Originator發起人物件的內部狀態，在需要的時候提供發起人需要的內部狀態。

public class Memento {
    
    private String state;
    
    public Memento(String state) {
        this.state = state;
    }
    
    public String getState() {
        return state;
    }

}

　　3. 備忘錄管理員角色

　　對備忘錄進行管理、儲存和提供備忘錄，只能將備忘錄傳遞給其他角色。

public class Caretaker {
    
    private Memento memento;

    public Memento getMemento() {
        return memento;
    }

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

　　4. Client客戶端

　　下面編寫一小段程式碼測試一下，即先將狀態置為On，儲存後再將狀態置為Off，然後通過備忘錄管理員角色恢復初始狀態。

public class Client {
    
    public static void main(String[] args) {
        Originator originator = new Originator();
        originator.setState("On");    //Originator初始狀態
        originator.show();
        
        Caretaker caretaker = new Caretaker();
        caretaker.setMemento(originator.createMento());
        
        originator.setState("Off");    //Originator狀態變為Off
        originator.show();
        
        originator.setMemento(caretaker.getMemento());    //回覆初始狀態
        originator.show();
    }

}

　　執行結果如下：

　　

二、備忘錄模式的應用

　　1. 何時使用

• 需要記錄一個物件的內部狀態時，為了允許使用者取消不確定或者錯誤的操作，能夠恢復到原先的狀態

　　2. 方法

• 通過一個備忘錄類專門儲存物件狀態

　　3. 優點

• 給使用者提供了一種可以恢復狀態的機制，可以使用能夠比較方便地回到某個歷史的狀態
• 實現了資訊的封裝，使得使用者不需要關心狀態的儲存細節

　　4. 缺點

• 消耗資源

　　5. 使用場景

• 需要儲存和恢復資料的相關場景
• 提供一個可回滾的操作，如ctrl+z、瀏覽器回退按鈕、Backspace鍵等
• 需要監控的副本場景

　　6. 應用例項

• 遊戲存檔
• ctrl+z鍵、瀏覽器回退鍵等（撤銷/還原）
• 棋盤類遊戲的悔棋
• 資料庫事務的回滾

　　7. 注意事項

• 為了符合迪米特法則，需要有一個管理備忘錄的類
• 不要在頻繁建立備份的場景中使用備忘錄模式。為了節約記憶體，可使用原型模式+備忘錄模式

三、備忘錄模式的實現

　　下面以遊戲存檔為例，看一下如何用備忘錄模式實現。UML圖如下：

　　1. 遊戲角色

　　簡單記錄了遊戲角色的生命力、攻擊力、防禦力，通過saveState()方法來儲存當前狀態，通過recoveryState()方法來恢復角色狀態。

public 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;
    }
    
    //狀態顯示
    public void stateDisplay() {
        System.out.println("角色當前狀態：");
        System.out.println("體力：" + this.vit);
        System.out.println("攻擊力：" + this.atk);
        System.out.println("防禦力： " + this.def);
        System.out.println("-----------------");
    }
    
    //獲得初始狀態
    public void getInitState() {
        this.vit = 100;
        this.atk = 100;
        this.def = 100;
    }
    
    //戰鬥後
    public void fight() {
        this.vit = 0;
        this.atk = 0;
        this.def = 0;
    }
    
    //儲存角色狀態
    public RoleStateMemento saveState() {
        return (new RoleStateMemento(vit, atk, def));
    }
    
    //恢復角色狀態
    public void recoveryState(RoleStateMemento memento) {
        this.vit = memento.getVit();
        this.atk = memento.getAtk();
        this.def = memento.getDef();
    }

}

　　2. 角色狀態儲存箱

　　備忘錄類，用於儲存角色狀態。

public 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;
    }
    
}

　　3. 角色狀態管理者

　　備忘錄管理者。

public class RoleStateCaretaker {
    
    private RoleStateMemento memento;

    public RoleStateMemento getMemento() {
        return memento;
    }

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

}

　　4. Client客戶端

　　下面編寫一個簡單的程式測試一下，編寫邏輯大致為打boss前存檔，打boss失敗了，讀檔。

public class Client {
    
    public static void main(String[] args) {
        //打boss前
        GameRole gameRole = new GameRole();
        gameRole.getInitState();
        gameRole.stateDisplay();
        
        //儲存進度
        RoleStateCaretaker caretaker = new RoleStateCaretaker();
        caretaker.setMemento(gameRole.saveState());
        
        //打boss失敗
        gameRole.fight();
        gameRole.stateDisplay();
        
        //恢復狀態
        gameRole.recoveryState(caretaker.getMemento());
        gameRole.stateDisplay();
    }

}

　　執行結果如下：

　　

 

　　原始碼地址：https://gitee.com/adamjiangwh/GoF