19.java設計模式之備忘錄模式

基本需求

  • 遊戲的角色有攻擊力和防禦力,在大戰Boss之前保存自身的狀態(攻擊力和防禦力),當大戰Boss之後攻擊力和防禦力下降,從備忘錄對象恢復到大戰前的狀態

傳統方案

  • 一個對象,就對應一個保存對象狀態的對象

  • 說明

    • 一個對象,就對應一個保存對象狀態的對象,這樣當我們遊戲的對象很多時,不利於管理,開銷也很大
    • 傳統的方式是簡單的做備份,new出來另外一個對象出來,再把需要備份的數據放到這個新對象,但這就暴露了對象內部的細節
    • 可以使用備忘錄模式進行解決

基本介紹

  • 備忘錄模式(Memento)在 不破壞封裝性的前提下,捕獲 一個對象的內部狀態,並在該對象之外保存這個狀態。這樣以後就可將該對象恢復到原先保存的狀態

  • 可以這裡理解備忘錄模式:現實生活中的備忘錄是用來記錄某些要去做的事情,或者是記錄已經達成的共同意見的事情,以防忘記了。而在軟體層面,備忘錄模式有著相同的含義,備忘錄對象主要用來記錄一個對象的某
    種狀態,或者某些數據,當要做回退時,可以從備忘錄對象里獲取原來的數據進行恢復操作

  • 備忘錄模式屬於行為型模式

  • UML類圖(原理)

    • 說明

      • Originator:對象,需要保存狀態的對象
      • Memento:備忘錄對象,保存目標對象Originator的內部狀態
      • Caretaker:守護者對象,保存多個備忘錄對象,使用集合管理,提高效率
      • 如果希望保存多個Originator對象不同時間的狀態,可使用Map<String,List>進行管理
    • 程式碼實現

      • // 備忘錄對象
        @Data
        @NoArgsConstructor
        @AllArgsConstructor
        public class Memento {
        
           private String state;
        
        }
        
        // 目標對象
        @Data
        public class Originator {
        
           private String state;
        
           // 創建備忘錄對象,用戶備份
           public Memento createMemento() {
               return new Memento(this.state);
           }
        
           // 從備忘錄對象恢復對象
           public void restoreFromMemento(Memento memento) {
               this.state = memento.getState();
           }
        }
        
        // 守護者對象
        public class Caretaker {
        
           // 使用集合對備忘錄對象進行管理
           private List<Memento> mementos;
        
           public Caretaker() {
               this.mementos = new ArrayList<>();
           }
        
           // 添加備忘錄對象
           public void add(Memento memento) {
               mementos.add(memento);
           }
        
           // 根據索引在集合中獲取備忘錄對象
           public Memento getMementoByIndex(int index) {
               Memento memento = null;
               if (index >= 0 && index < mementos.size()) {
                   memento = mementos.get(index);
               }
               return memento;
           }
        }
        
        // 測試
        public class Client {
           public static void main(String[] args) {
               // 創建守護者對象
               Caretaker caretaker = new Caretaker();
               // 創建目標對象 並設置狀態1
               Originator originator = new Originator();
               originator.setState("狀態1 -> 開心");
               // 保存狀態1 -> 獲取備忘錄對象,並交由守護者管理
               caretaker.add(originator.createMemento());
               // 給目標狀態設置狀態2
               originator.setState("狀態2 -> 悲傷");
               // 保存狀態2 -> 獲取備忘錄對象,並交由守護者管理
               caretaker.add(originator.createMemento());
               // 給目標狀態設置狀態3
               originator.setState("狀態3 -> 笑哭");
               // 保存狀態3 -> 獲取備忘錄對象,並交由守護者管理
               caretaker.add(originator.createMemento());
               // 目標對象當前的狀態
               System.out.println("目標對象當前的狀態是:" + originator.getState());
               // 從守護者對象中獲取備忘錄對象,恢複目標對象狀態至狀態1
               originator.restoreFromMemento(caretaker.getMementoByIndex(0));
               System.out.println("目標對象狀態恢復到狀態1:" + originator.getState());
           }
        }
        
  • UML類圖(案例)

    • 程式碼實現

      • // 備忘錄對象
        @Data
        @NoArgsConstructor
        @AllArgsConstructor
        public class Memento {
        
           // 攻擊力
           private int attack;
        
           // 防禦力
           private int defense;
        
        }
        
        // 遊戲角色 亦目標對象
        @Data
        public class GameRole {
        
           // 攻擊力
           private int attack;
        
           // 防禦力
           private int defense;
        
           // 創建目標對象當前狀態的備忘錄對象
           public Memento createMemento() {
               return new Memento(this.attack, this.defense);
           }
        
           // 從備忘錄對象中恢複目標對象
           public void restoreFromMemento(Memento memento) {
               this.attack = memento.getAttack();
               this.defense = memento.getDefense();
           }
        
           // 顯示目標對象當前狀態
           public void display() {
               System.out.println("目標對象當前狀態,攻擊力 -> " + this.attack + "、防禦力 -> " + this.defense);
           }
        }
        
        // 守護者對象 對備忘錄對象進行管理
        @Data
        public class Caretaker {
        
           // 只保存一次狀態 根據本次需求 只需保存一次
           private Memento memento;
           // 保存一個目標對象的多次狀態
           // private List<Memento> mementos;
           // 保存多個目標對象的多次狀態
           // private Map<String, List<Memento>> listMap;
        
        }
        
        // 測試
        public class Client {
           public static void main(String[] args) {
               // 創建守護者對象 管理備忘錄對象
               Caretaker caretaker = new Caretaker();
               // 創建目標對象 並設置初始值
               GameRole gameRole = new GameRole();
               gameRole.setAttack(100);
               gameRole.setDefense(100);
               // 獲取目標對象當前狀態的備忘錄對象,並保存至守護者對象中
               caretaker.setMemento(gameRole.createMemento());
               // 和boss大戰前 輸出目標對象狀態
               System.out.println("和boss大戰前");
               gameRole.display();
               // 和boss大戰中 輸出目標對象狀態
               System.out.println("和boss大戰中");
               gameRole.setAttack(50);
               gameRole.setDefense(50);
               gameRole.display();
               // 和boss大戰後 使用備忘錄對象恢複目標對象狀態至初始狀態
               gameRole.restoreFromMemento(caretaker.getMemento());
               System.out.println("和boss大戰後,恢復至初始狀態");
               gameRole.display();
           }
        }
        

注意事項

  • 給用戶提供了一種可以恢復狀態的機制,可以使用戶能夠比較方便的回到某個歷史狀態
  • 實現了資訊封裝,使得用戶不需要關心狀態的保存細節
  • 如果類的成員變數過多,勢必會佔用比較大的資源,而且每一次保存都會消耗一定的記憶體
  • 應用場景:1、後悔葯,2、遊戲存檔,3、ctrl+z,4、ie中的後退,5、資料庫的事務管理
  • 為了節約記憶體,備忘錄模式可以和原型模式配合使用