Java设计模式之 [18] 行为型模式 - 备忘录模式

简介

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

原理类图

原理类图

说明 角色和职责

1.Originator 对象(需要保存状态的对象)
2.Memento 备忘录对象 负责保存好记录 即 Originator 的内部状态
3.Caretaker 守护者对象,负责保护多个备忘录对象,使用集合管理,提高效率
4.说明:如果需要保存多个 Originator 对象的不同事件的备忘录对象,也可以,只需要 HashMap

需求案例 游戏角色恢复的问题

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

传统方式的问题分析

1.一个对象就对应一个对象状态的对象,当我们的游戏对象很多的时候,不利于管理,开销也很大
2.传统的方式是简单的做备份,new 出来另外一个对象,再把需要备份的数据放到这个新对象 ,但是这就暴漏了对象的内部细节
3.解决方案: ==>> 备忘录模式

实现代码

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 getStateFromMementor(Memento memento) {
        state = memento.getState();
    }
}

public class Memento {
    private String state;

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

    public String getState() {
        return state;
    }

}

public class Caretaker {
    // 在List集合中,有很多的备忘录
    private List mementoList;

    public Caretaker() {
        mementoList = new ArrayList();
    }

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

public class Client {

    public static void main(String[] args) {
        Originator originator = new Originator();
        Caretaker caretaker = new Caretaker();
        
        originator.setState("状态是 #1 G 100 F 200");
        caretaker.add(originator.saveStateMemento());
        originator.setState("状态是 #2 G 200 F 300");
        caretaker.add(originator.saveStateMemento());
        originator.setState("状态是 #3 G 50 F 90");
        caretaker.add(originator.saveStateMemento());
        
        //希望恢复到状态1
        System.out.println("当前状态是:"+originator.getState());
        originator.getStateFromMementor(caretaker.get(0));
        System.out.println("恢复状态之后是:"+originator.getState());
    }

}

测试结果

当前状态是:状态是 #3 G 50 F 90
恢复状态之后是:状态是 #1 G 100 F 200

游戏角色恢复实现

1.类图分析

类图分析

2.代码实现

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;
    }

}

//守护者对象,保存游戏的状态
public class Caretaker {

    // 如果只保存一次状态
    private Memento memento;

    // 对 GameRole 保存多次状态
//  private ArrayList mementos;
    // 对多个游戏角色保存多个状态
//  private HashMap> hashMap;
    public Memento getMemento() {
        return memento;
    }

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

}

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

    public GameRole(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;
    }

    // 创造Memento
    public Memento createMemento() {
        return new Memento(vit, def);
    }

    public void recoverGameRoleFromMemento(Memento memento) {
        this.def = memento.getDef();
        this.vit = memento.getVit();
    }

    // 显示当前游戏状态
    public void display() {
        System.out.println("vit:" + this.vit);
        System.out.println("def:" + this.def);
    }
}

测试

public class Client {

    public static void main(String[] args) {
        GameRole gameRole = new GameRole(100, 100);
        
        System.out.println("打架之前");
        gameRole.display();
        //把状态保存
        Caretaker caretaker = new Caretaker();
        caretaker.setMemento(gameRole.createMemento());
        System.out.println("打架之后");
        gameRole.setDef(50);
        gameRole.setVit(60);
        gameRole.display();
        //恢复状态
        System.out.println("体力恢复");
        gameRole.recoverGameRoleFromMemento(caretaker.getMemento());
        gameRole.display();
    }   

}

打印结果

打架之前
vit:100
def:100
打架之后
vit:60
def:50
体力恢复
vit:100
def:100

备忘录模式的注意事项和细节

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