《设计模式》备忘录模式

定义

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

介绍

• 备忘录模式属于行为型模式。
• 备忘录模式比较适合用于功能复杂，但是需要维护和纪录历史的地方，或者是需要保存一个或者多个属性的地方；在未来某个时刻需要时，将其还原到原来纪录的状态。

UML类图

备忘录模式UML类图

角色说明：

• Originator（发起人角色）：负责创建一个备忘录（Memento），能够记录内部状态，以及恢复原来记录的状态。并且能够决定哪些状态是需要备忘的。
• Memento（备忘录角色）：将发起人（Originator）对象的内部状态存储起来；并且可以防止发起人（Originator）之外的对象访问备忘录（Memento）。
• Caretaker（负责人角色）：负责保存备忘录（Memento），不能对备忘录（Memento）的内容进行操作和访问，只能将备忘录传递给其他对象。

实现（游戏存档）

1、创建发起人角色。这里则是游戏类，游戏类提供存档和读档的功能：

// 游戏类
public class Game {
  // 等级
  private int mLevel = 1;
  // 金币数量
  private int mCoin = 0;

  @Override
  public String toString() {
    return "game{" +
                "mLevel=" + mLevel +
                ", mCoin=" + mCoin +
                '}';
  }

  public void play() {
    System.out.println("升级了");
    mLevel++;
    System.out.println("当前等级为:" + mLevel);
    System.out.println("获得金币:32");
    mCoin += 32;
    System.out.println("当前金币数量为:" + mCoin);
  }

  public void exit() {
    System.out.println("退出游戏");
    System.out.println("退出游戏时的属性 : " + toString());
  }

  // 创建备忘录,即游戏存档
  public Memento createMemento() {
    Memento memento = new Memento();
    memento.setLevel(mLevel);
    memento.setCoin(mCoin);
    return memento;
  }

  // 游戏读档
  public void setMemento(Memento memento) {
    mLevel = memento.getLevel();
    mCoin = memento.getCoin();
    System.out.println("读取存档信息:" + toString());
  }
}

2、创建备忘录角色。负责将游戏类的内部状态存储起来：

// 备忘录类
public class Memento {
  // 等级
  public int level;
  // 金币数量
  public int coin;

  public void setLevel(int level) {
    this.level = level;
  }

  public void setCoin(int coin) {
    this.coin = coin;
  }

  public int getLevel() {
    return level;
  }

  public int getCoin() {
    return coin;
  }
}

3、创建负责人角色。负责保存备忘录，不能对备忘录的内容进行操作和访问，只能将备忘录传递给其他对象。

// 备忘录管理类
public class Caretaker {
  private Memento mMemento;

  public void setMemento(Memento memento) {
    mMemento = memento;
  }

  public Memento getMemento() {
    return mMemento;
  }
}

4、客户端测试

public void test() {
  System.out.println("首次进入游戏");
  Game game = new Game();
  // 玩游戏
  game.play();
  // 创建存档
  Memento memento = game.createMemento();
  Caretaker caretaker = new Caretaker();
  // 保存存档
  caretaker.setMemento(memento);
  // 退出游戏
  game.exit();

  System.out.println("-------------");
  System.out.println("二次进入游戏");
  Game secondGame = new Game();
  // 读取存档
  secondGame.setMemento(caretaker.getMemento());
  // 继续玩游戏
  secondGame.play();
  // 不存档
  secondGame.exit();
}

输出结果：

首次进入游戏
升级了
当前等级为:2
获得金币:32
当前金币数量为:32
退出游戏
退出游戏时的属性 : game{mLevel=2, mCoin=32}
-------------
二次进入游戏
读取存档信息:game{mLevel=2, mCoin=32}
升级了
当前等级为:3
获得金币:32
当前金币数量为:64
退出游戏
退出游戏时的属性 : game{mLevel=3, mCoin=64}

应用场景

需要保存对象的某一时刻的状态时

优缺点

优点

• 能够让状态回滚到某一时刻的状态。
• 实现了状态保存对象的封装，用户无需关心其实现细节。

缺点

• 要保存的对象如果成员变量过多的话，资源消耗也会相应增多。

Android中的源码分析

Android中的Activity就提供了状态保存机制来保证Activity在被系统回收后能够恢复当前Activity的数据。这一机制实际上就是onSaveInstanceState和onRestoreInstanceState。onSaveInstanceState就是用来保存当前Activity的状态，onRestoreInstanceState则是用来恢复Activity的状态。

1、onSaveInstanceState源码

// 保存各种状态
protected void onSaveInstanceState(Bundle outState) {
  // 1.保存Activity对应Window的状态信息
  outState.putBundle(WINDOW_HIERARCHY_TAG, mWindow.saveHierarchyState());

  // 2.如果存在Fragments,则保存所有Fragments的状态信息
  Parcelable p = mFragments.saveAllState();
  if (p != null) {
    outState.putParcelable(FRAGMENTS_TAG, p);
  }

  // 3.如果设置了ActivityLifecycleCallbacks回调,那么会调用ActivityLifecycleCallbacks的onSaveInstanceState来进行保存状态信息
  getApplication().dispatchActivitySaveInstanceState(this, outState);
}

2、onRestoreInstanceState源码

protected void onRestoreInstanceState(Bundle savedInstanceState) {
  if (mWindow != null) {
    // 获取保存过的window状态信息
    Bundle windowState = savedInstanceState.getBundle(WINDOW_HIERARCHY_TAG);
    // 如果存在状态信息，则window进行恢复
    if (windowState != null) {
      mWindow.restoreHierarchyState(windowState);
    }
  }
}

3、总结

• Activity的状态保存与恢复其实是个比较复杂的东西，很多细节这里都没说到，有兴趣的同学可以找相关资料研究下，这里主要还是讲设计模式在Android源码中的应用。
• 在上面的源码中，Activity实际上就是负责人角色（Caretaker），负责保存和恢复UI信息；Activity、View、ViewGroup、Fragment等都是发起人角色（Originator），他们各自负责需要保存的信息；而备忘录角色（Memento）则是Bundle类了，相关状态信息都是保存在Bundle中。
• 此外，Canvas中的Save()和Restore()也是使用到了备忘录模式，有兴趣的可以去看下。