设计模式(七)--备忘录模式

1 游戏角色状态恢复问题
游戏角色有攻击力和防御力，在大战 Boss 前保存自身的状态(攻击力和防御力)，当大战 Boss 后攻击力和防御力下降，从备忘录对象恢复到大战前的状态
2 传统方案解决游戏角色恢复

3 传统的方式的问题分析

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

2. 传统的方式是简单地做备份，new 出另外一个对象出来，再把需要备份的数据放到这个新对象，但这就暴露了对象内部的细节

3. 解决方案： => 备忘录模式

4 备忘录模式基本介绍
基本介绍

1. 备忘录模式（Memento Pattern）在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态

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

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

类图如下：

1. originator : 对象(需要保存状态的对象)

2. Memento ： 备忘录对象,负责保存好记录，即 Originator 内部状态

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

4. 说明：如果希望保存多个 originator 对象的不同时间的状态，也可以，只需要要 HashMap <String, 集合>

package com.lin.memento;

public class Originator {

    private String state;

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
    
    
    // 编写一个方法，可以保存一个状态对象Memento
    // 因此编写一个方法，返回Memento
    public Memento saveStateMemento() {
        return new Memento(state);
    }
    
    // 通过备忘录对象，恢复状态
    public void getStateFromMemento(Memento memento) {
        state = memento.getState();
    }
}

package com.lin.memento;

public class Memento {

    private String state;

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

    public String getState() {
        return state;
    }
    
    
}

package com.lin.memento;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Caretaker {

    // 多个备忘录对象
     private List<Memento> mementoList = new ArrayList<Memento>();
//    private Map<String, ArrayList> mementoMap = new HashMap<String, ArrayList>();
    
    
    
    public void add(Memento memento) {
        mementoList.add(memento);
    }
    
    public Memento get(int index) {
        return mementoList.get(index);
    }
    
    
    
}

package com.lin.memento;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

public class Caretaker {

    // 多个备忘录对象
     private List<Memento> mementoList = new ArrayList<Memento>();
//    private Map<String, ArrayList> mementoMap = new HashMap<String, ArrayList>();
    
    
    
    public void add(Memento memento) {
        mementoList.add(memento);
    }
    
    public Memento get(int index) {
        return mementoList.get(index);
    }
    
    
    
}

package com.lin.memento;

public class Client {

    public static void main(String[] args) {
        
        Originator originator = new Originator();
        Caretaker caretaker = new Caretaker();
        
        // 状态1
        originator.setState("状态#1（20210209 11：47）：");
        caretaker.add(originator.saveStateMemento());
        System.out.println(originator.getState());
        // 状态2
        originator.setState("状态#2（20210209 11：50）：");
        caretaker.add(originator.saveStateMemento());
        System.out.println(originator.getState());
        
        // 恢复状态1
        originator.getStateFromMemento(caretaker.get(0));
        System.out.println(originator.getState());
        

    }
}

6 游戏角色恢复状态实例

1. 应用实例要求

游戏角色有攻击力和防御力，在大战 Boss 前保存自身的状态(攻击力和防御力)，当大战 Boss 后攻击力和防御力下降，从备忘录对象恢复到大战前的状态

package com.lin.memento.game;

public class GameRole {

    private int vit;
    private int def;
    // 创建memento，即根据当前的状态得到memento
    public Memento createMemento() {
        return new Memento(this.vit, this.def);
    }
    
    // 从备忘录对象，恢复gamerole的状态
    public void recoverGameRoleMemento(Memento memento) {
        this.vit = memento.getVit();
        this.def = memento.getDef();
    }
    
    // 显示当前游戏角色的状态
    public void display() {
        System.out.println("游戏角色当前的攻击力："+this.vit+" 防御力：" + this.def);
    }

    public int getVit() {
        return vit;
    }

    public void setVit(int vit) {
        this.vit = vit;
    }

    public int getDef() {
        return def;
    }

    public void setDef(int def) {
        this.def = def;
    }
    
}

package com.lin.memento.game;

public class Memento {

    // 攻击力
    private int vit;
    // 防御力
    private int def;
    
    public Memento(int vit, int def) {
        super();
        this.vit = vit;
        this.def = def;
    }

    

    public int getVit() {
        return vit;
    }

    public void setVit(int vit) {
        this.vit = vit;
    }

    public int getDef() {
        return def;
    }

    public void setDef(int def) {
        this.def = def;
    }
    
    
}

package com.lin.memento.game;
// 守护者对象，保持游戏角色的状态

import java.util.ArrayList;
import java.util.HashMap;

public class Caretaker {

    //如果只是保存一次
    private Memento memento;
    // 对gamerole保存多次状态
//    private ArrayList<Memento> mementos;
    // 对多个游戏角色保存多个状态
//    private HashMap<String, ArrayList<Memento>> rolesMementos;

    public Memento getMemento() {
        return memento;
    }

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

package com.lin.memento.game;

public class Client {

    public static void main(String[] args) {
        
        GameRole gameRole = new GameRole();
        gameRole.setDef(100);
        gameRole.setVit(100);
        System.out.println("大战前的状态");
        gameRole.display();
        
        // 大战前保存角色状态
        Caretaker caretaker = new Caretaker();
        caretaker.setMemento(gameRole.createMemento());
        
        System.out.println("大战开始！");
        gameRole.setDef(90);
        gameRole.setVit(87);
        gameRole.display();
        
        System.out.println("恢复原来状态");
        gameRole.recoverGameRoleMemento(caretaker.getMemento());
        gameRole.display();
    
    }
}