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、数据库的事务管理
• 为了节约内存，备忘录模式可以和原型模式配合使用