每日学一个设计模式18——备忘录模式

备忘录模式（保存对象状态）

用处

事先将某个时间点的实例状态保存下来，之后在有必要时，再将实例恢复至当时的状态。

角色

• Originator（生成者）
  该角色会再保存在自己的最新状态时生成Memento角色。当把以前保存的Memento角色传递给Originator角色时，它会将自己恢复至生成该Memento角色时的状态。
• Memento（纪念品）
  该角色会将Originator角色的内部信息整合在一起。在Memento角色中虽然保存了Originator角色的信息，但它不会像外部公开这些信息。
  • 宽接口（API）：Memento角色提供的“宽接口”使指用于获取回复对象信息状态的方法的集合。由于宽接口（API）会暴露所有Memento角色的内部信息，因此能够使用宽接口（API）的只有Originator角色
  • 宅接口（API）：Memento角色位外部Caretaker角色提供了“窄接口”，可以通过窄接口（API）获取的Memento角色的内部信息非常有限，因此可以有效地防止信息泄露。
• Caretaker（负责人）
  当Caretaker角色想要保存当前的Originator角色的状态时，会通知Originator角色。Originator角色在接受到通知后会生成Memento角色的实例并将其返回给Caretaker角色。由于以后可能会用Memento实例来将Originator恢复至原来的状态，因此Caretaker角色会一直保存Memento实例。
  不过，Caretaker角色只能使用两种接口中的窄接口（API），也就是说它无法访问Memento角色内部的所有信息。

类图

由类图我们可以看出

• Caretaker角色中聚合一个Memento的实例
• Caretaker的方法restore的参数依赖一个Originator实例，在该方法中获取Memento的数据，并将Originator的数据恢复。

举例

//caretaker角色
public class Main {
    public static void main(String[] args) {
        Gamer gamer = new Gamer(100);
        Memento memento = gamer.createMemento();
        for(int i = 0 ;i<100;i++){
            System.out.println("=== " + i);
            System.out.println("当前状态："+gamer);
            gamer.bet();
            System.out.println("所持金钱为"+gamer.getMoney()+"元。");
            if(gamer.getMoney() > memento.getMoney()){
                System.out.println("所持金钱增加了许多，因此保存当前游戏状态");
                memento = gamer.createMemento();
            }else if(gamer.getMoney() <= memento.getMoney() / 2){
                System.out.println("所持金钱减少了许多，因此游戏将恢复至以前的状态");
                gamer.restoreMemento(memento);
            }
            try{
                Thread.sleep(1000);
            }catch(InterruptedException e){

            }
            System.out.println("");
        }
    }
}

/*
* 这是一个收集水果和获取金钱数的掷骰子游戏，规则如下
* - 游戏是自动进行的
* - 游戏的主人公通过掷骰子来决定下一个状态
* - 当骰子点数为1的时候，主人公的金钱会增加
* - 当骰子点数为2的时候，主人公的金钱会减少
* - 当骰子点数为6的时候，主人公会得到水果
* - 当主人公没有钱时，游戏就会结束
* */

//Memento类
class Memento{
    int money;
    ArrayList fruits;
    public int getMoney(){
        return money;
    }
    Memento(int money){
        this.money = money;
        this.fruits = new ArrayList();
    }

    void addFruits(String fruit){
        fruits.add(fruit);
    }
    List getFruits(){
       return (List)fruits.clone();
    }
}

//Originator类
class Gamer{
    private int money;
    private List fruits = new ArrayList();
    private Random random = new Random();
    private static String[]  fruitsname = {"苹果","葡萄","香蕉","橘子"};
    public Gamer(int money){
        this.money = money;
    }
    public  int getMoney(){
        return money;
    }
    public void bet(){
        int dice = random.nextInt(6)+1;
        if(dice == 1 ){
            money += 100;
        }else if(dice == 2){
            money /= 2;
            System.out.println("所持金钱减半了。");
        }else if(dice == 6){
            String f = getFruit();
            System.out.println("获得了水果（" + f +"）。");
            fruits.add(f);
        }else{
            System.out.println("什么都没有发生");
        }
    }
    public Memento createMemento(){
        Memento m = new Memento(money);
        Iterator it = fruits.iterator();
        while(it.hasNext()){
            String f = (String)it.next();
            if(f.startsWith("好吃的")){
                m.addFruits(f);
            }
        }
        return m;
    }

    public void restoreMemento(Memento memento){
        this.money = memento.money;
        this.fruits = memento.getFruits();
    }

    public String toString(){
        return "[money = "+money+",fruits = "+ fruits + "]";
    }

    private String getFruit(){
        String prefix = "";
        if(random.nextBoolean()){
            prefix="好吃的";
        }
        return prefix + fruitsname[random.nextInt(fruitsname.length)];
    }
}

总结

• 增加功能需要改动caretaker和Memento，因此不符合开闭原则。
• Caretaker角色决定何时备份，撤销Memento角色，Originator角色负责生成Memento角色和使用接收到Memento角色来恢复自己的状态，因此做到了职责分担，符合单一职责原则。