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

xiaokantianse發表於2021-01-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、資料庫的事務管理
  • 為了節約記憶體，備忘錄模式可以和原型模式配合使用

相關文章