设计模式之备忘录模式

本文根据尚硅谷韩顺平老师的设计模式课程编写设计模式

游戏角色状态回复问题

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

基本介绍

1. 备忘录模式(Memento Pattern) 在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态
2. 可以这样理解备忘录模式:现实生活中的备忘录是用来记录某些要去做的事情，或者是记录已经达成的共同意见的事情，以防忘记了。而在软件层面，备忘录模式有着相同的含义，备忘录对象主要用来记录一个对象的某种状态，或者某些数据，当要做回退时，可以从备忘录对象里获取原来的数据进行恢复操作
3. 备忘录模式属于行为型模式

代码

public class Caretaker {
    private List<Memento> mementoList = new ArrayList<>();

    public void add(Memento memento){
        mementoList.add(memento);
    }

    public Memento get(int index){
        return mementoList.get(index);
    }
}

public class Originator {
    private String state; //状态信息

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

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

public class Memento {
    private String state; //状态信息

    public String getState() {
        return state;
    }

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

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

        Caretaker caretaker = new Caretaker();

        originator.setState("状态一 LV 1");
        caretaker.add(originator.saveStateMemento());

        originator.setState("状态二 LV 2");
        caretaker.add(originator.saveStateMemento());

        originator.setState("状态三 LV 1");
        caretaker.add(originator.saveStateMemento());

        System.out.println("当前状态"+originator.getState());
        //希望回到状态二
        originator.getStartFromMemento(caretaker.get(1));
        System.out.println("恢复到状态二："+originator.getState());

    }
}

角色

1. originator：对象(需要保存状态的对象)
2. Memento: 备忘录对象，负责保存好记录，即originator内部状态
3. caretaker: 守护者对象，负责保存多个备忘录对象，使用集合存储，提高效率

游戏角色恢复实例代码

public class Memento {
    //攻击力
    private int vit;
    //防御力
    private int def;

    public Memento(int vit, int def) {
        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;
    }
}

//守护者对象，保存游戏角色状态
public class Caretaker {
    //如果只保存一次状态
    private Memento memento;
    //对GameRole 保存对此状态
    private ArrayList<Memento> mementos;
    //对多个游戏角色保存多个状态
    private HashMap<String, ArrayList<Memento>> listHashMap;

    public Memento getMemento() {
        return memento;
    }

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

    public ArrayList<Memento> getMementos() {
        return mementos;
    }

    public void setMementos(ArrayList<Memento> mementos) {
        this.mementos = mementos;
    }

    public HashMap<String, ArrayList<Memento>> getListHashMap() {
        return listHashMap;
    }

    public void setListHashMap(HashMap<String, ArrayList<Memento>> listHashMap) {
        this.listHashMap = listHashMap;
    }
}

public class GameRole {
    private int vit;
    private int def;

    //创建Memento 即根据当前的状态得到Memento
    public Memento createMemento(){
        return new Memento(vit,def);
    }

    //从备忘录对象恢复状态
    public void recoverGameRoleFromMemento(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;
    }
}

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

        System.out.println("干架前");
        gameRole.display();

        //保存当前状态到caretaker
        Caretaker caretaker = new Caretaker();
        caretaker.setMemento(gameRole.createMemento());

        System.out.println("干架后");
        gameRole.setVit(30);
        gameRole.setDef(30);
        gameRole.display();

        System.out.println("恢复到干架前");
        gameRole.recoverGameRoleFromMemento(caretaker.getMemento());
        gameRole.display();
    }
}

注意事项和细节

1. 给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态
2. 实现了信息的封装，使得用户不需要关心状态的保存细节
3. 如果类的成员变量过多，势必会占用比较大的资源，而且每一次保存都会消耗一定的内存，这个需要注意
4. 适用的应用场景: 1、后悔药。2、 打游戏时的存档。3、 Windows里的ctri +Z,。4、IE中的后退。4、 数据库的事务管理
5. 为了节约内存，备忘录模式可以和原型模式配合使用