22.备忘录模式

1、角色状态恢复问题

游戏角色有攻击力和防御力，

在大战Boss前保存自身的状态(攻击力防御力)，

当大战Boss后攻击力和防御力下降，

从备忘录对象恢复到大战前的状态

2、传统方案问题

• 一个对象，就对应一个保存对象状态的对象，这样当我们游戏的对象很多时，不利于管理，开销也很大.

• 传统的方式是简单地做备份，

  • new出另外一个对象出来，
  • 再把需要备份的数据放到这个新对象，
  • 但这就暴露了对象内部的细节

• 解决方案:

  • =>备忘录模式

3、基本介绍

备忘录模式（Memento Pattern)

• 在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。
• 这样以后就可将该对象恢复到原先保存的状态

可以这里理解备忘录模式:

• 现实生活中的备忘录是
  • 用来记录某些要去做的事情
  • 或者是记录已经达成的共同意见的事情，以防忘记了。
• 而在软件层面，备忘录模式有着相同的含义，
  • 备忘录对象主要用来记录一个对象的某种状态，或者某些数据，
  • 当要做回退时，可以从备忘录对象里获取原来的数据进行恢复操作

备忘录模式属于行为型模式

4、原理类图

Originator：

• 对象（需要保存状态的对象）

Memento：

• 备忘录对象，负责保存号记录，即Originator内部状态

Caretaker：

• 守护者对象，负责保存多个备忘录对象，使用集合管理，提高效率

说明：

• 若希望保存多个originato对象的不同时间的状态，也可以，比如Map

public class Client {
    public static void main(String[] args) {
        Originator originator = new Originator();
        Caretaker caretaker = new Caretaker();

        originator.setState("状态#1,攻击力 100");
        //保存了当前的状态
        caretaker.add(originator, originator.saveStateMemento());

        originator.setState("状态#2,攻击力 80");
        caretaker.add(originator, originator.saveStateMemento());

        originator.setState("状态#3,攻击力 50");
        caretaker.add(originator, originator.saveStateMemento());

        System.out.println("当前的状态是: " + originator.getState());

        //希望恢复到状态1
        Memento memento = caretaker.get(originator, 0);
        originator.getStateFromMemento(memento);
        System.out.println("恢复后的状态，当前的状态是: " + originator.getState());
    }
    /*
        当前的状态是: 状态#3,攻击力 50
        恢复后的状态，当前的状态是: 状态#1,攻击力 100
    */
    
}

---

//管理者
public class Caretaker {
    /**
     * 存放第几个Originator对象
     */
    private Map<Originator, List<Memento>> originatorMap = new HashMap();

    public void add(Originator originator, Memento memento) {
        List<Memento> mementos = originatorMap.get(originator);
        if (null != mementos && mementos.size() != 0) {
            mementos.add(memento);
        } else {
            mementos = new ArrayList<>();
            mementos.add(memento);
            originatorMap.put(originator, mementos);
        }
    }

    /**
     * 获取到第 index 个Originator 的备忘录对象(即保存状态)
     *
     * @param index
     * @return
     */
    public Memento get(Originator originator, int index) {
        return originatorMap.get(originator).get(index);
    }
}

---

//备忘录
public class Memento {
    private String state;

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

    public String state() {
        return state;
    }
}

//发起者，需要被记录的对象
public class Originator {
    public void setState(String state) {
        this.state = state;
    }

    public String getState() {
        return state;
    }

    /**
     * 状态信息
     */
    private String state;

    /**
     *
     * 编写一个方法，可以保存一个状态对象 Memento
     */
    public Memento saveStateMemento(){
        return new Memento(state);
    }

    /**
     * 通过备忘录对象,恢复状态
     */
    public void getStateFromMemento(Memento memento){
        state = memento.state();
    }

}

5、案例解决

游戏角色有攻击力和防御力，

在大战Boss前保存自身的状态(攻击力防御力)，

当大战Boss后攻击力和防御力下降，

从备忘录对象恢复到大战前的状态

public class Client {

    public static void main(String[] args) {
        //创建游戏角色
        GameRole gameRole = new GameRole();
        gameRole.setAtk(100);
        gameRole.setDef(100);

        System.out.println("大战前的状态");
        gameRole.disPlay();

        //把当前的状态保存到caretaker
        Caretaker caretaker = new Caretaker();
        caretaker.setMemento(gameRole.createMemento());
        System.out.println("大战");
        gameRole.setDef(30);
        gameRole.setAtk(30);
        gameRole.disPlay();

        System.out.println("大战后的恢复原先的状态");
        gameRole.recoverGameRoleFromMemento(caretaker.getMemento());
        System.out.println("恢复后的状态");
        gameRole.disPlay();
    }
    /*
        大战前的状态
        角色当前状态:atk:100def:100
        大战
        角色当前状态:atk:30def:30
        大战后的恢复原先的状态
        恢复后的状态
        角色当前状态:atk:100def:100
    */
}

---

@Data
public class GameRole {
    private int atk;
    private int def;

    /**
     * 创建Memento，即根据游戏角色的当前状态得到Memento
     */
    public Memento createMemento() {
        return new Memento(atk, def);
    }

    /**
     * 从备忘录对象，恢复GameRole的状态
     */
    public void recoverGameRoleFromMemento(Memento memento) {
        atk = memento.getAtk();
        def = memento.getDef();
    }

    /**
     * 显示当前游戏角色的状态
     */
    public void disPlay() {
        System.out.println("角色当前状态:atk:" + atk + "def:" + def);
    }


}

---

@Data
public class Caretaker {
    /**
     * 如果只保存一次状态
     */
    private Memento memento;
    /**
     * 如果保存多个角色的多次状态
     */
//    private Map<String,List<Memento>> rolesMementos;

}

---

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Memento {
    /**
     * 攻击力
     */
    private int atk;
    /**
     * 防御力
     */
    private int def;


}

6、注意事项与细节

• 给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态

• 实现了信息的封装，使得用户不需要关心状态的保存细节

• 如果类的成员变量过多，势必会占用比较大的资源，而且每一次保存都会消耗一定的内存,这个需要注意

• 适用的应用场景:

  • 1、后悔药。2、打游戏时的存档。3、Windows里的ctrl+z。4、IE中的后退。4、数据库的事务管理

• 为了节约内存，备忘录模式可以和原型模式配合使用