备忘录模式

备忘录模式是指在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，以便以后当需要时能将该对象恢复到原先保存的状态。该模式又叫快照模式。

进一步阐述：

备忘录模式能记录一个对象的内部状态，当用户后悔时能撤销当前操作，使数据恢复到它原先的状态。

备忘录模式有三种角色：

Originator（发起人角色）：记录当前时刻的内部状态信息，提供创建备忘录和恢复备忘录数据的功能，实现其他业务功能，它可以访问备忘录里的所有信息。
Memento（备忘录角色）：负责存储发起人的内部状态，在需要的时候提供这些内部状态给发起人。
Caretaker（管理者角色）：对备忘录进行管理，提供保存与获取备忘录的功能，但其不能对备忘录的内容进行访问与修改。

案例：我们用一个游戏来举例，在玩一个步骤游戏时，每走一步时步数都加一，遇到道具可以快速走几步，或者减几步，踩到屎了就游戏结束，但是可以读档到之前的一步。其中游戏Game类就是发起人角色，备份GameMemento类就是备忘录角色，备份信息管理GameMemento类就是管理者角色。

UML类图：

备忘录模式.jpg

客户端Client类：

/**
 * 使用备忘录模式的客户端
 */
public class Client {

    public static void main(String[] args) {
        Game game = new Game();
        System.out.println("游戏开始");
        game.play();

        System.out.println("捡到滑板，前进10步");
        game.setPlayerStep(10);

        System.out.println("存个档，创建存档");
        GameMemento gameMemento = game.createGameMemento();

        System.out.println("把存档交给存档器管理");
        Caretaker caretaker = new Caretaker();
        caretaker.saveMemento(gameMemento);
        System.out.println("存档完毕");

        System.out.println("继续前进1步");
        game.setPlayerStep(game.getPlayerStep() + 1);
        System.out.println("踩到屎了，当前步数为：" + game.getPlayerStep());

        System.out.println("读档，还原到之前一步");
        game.restore(caretaker.retrieveMemento());
        System.out.println("读档完毕，当前玩家步数是：" + game.getPlayerStep());
    }
}

游戏Game类：

/**
 * 游戏类（发起人角色）
 */
public class Game {

    //玩家走的步数
    private int playerStep;

    /**
     * 备份游戏
     */
    public GameMemento createGameMemento() {
        return new GameMemento(playerStep);
    }

    /**
     * 开始玩游戏
     */
    public void play() {
        playerStep = 0;
    }

    /**
     * 恢复备份
     */
    public void restore(GameMemento gameMemento) {
        this.playerStep = gameMemento.getPlayerSteps();
    }

    public int getPlayerStep() {
        return playerStep;
    }

    public void setPlayerStep(int playerStep) {
        this.playerStep = playerStep;
    }
}

备份GameMemento类：

/**
 * 备份（备忘录角色）
 */
public class GameMemento {

    //步数
    private int playerSteps;

    /**
     * 备份步数
     */
    public GameMemento(int playerSteps) {
        this.playerSteps = playerSteps;
    }

    public int getPlayerSteps() {
        return playerSteps;
    }
}

备份信息管理GameMemento类：

/**
 * 备份信息管理类（管理者角色）
 */
public class Caretaker {

    //备份
    private GameMemento gameMemento;

    /**
     * 恢复备份
     */
    public GameMemento retrieveMemento() {
        return this.gameMemento;
    }

    /**
     * 保存备份
     */
    public void saveMemento(GameMemento gameMemento) {
        this.gameMemento = gameMemento;
    }
}

运行结果：

备忘录模式运行结果.png

总结：

提供了一种可以恢复状态的机制。当用户需要时能够比较方便地将数据恢复到某个历史的状态。
实现了内部状态的封装。除了创建它的发起人之外，其他对象都不能够访问这些状态信息。
简化了发起人类，发起人不需要管理和保存其内部状态的各个备份，所有状态信息都保存在备忘录中，并由管理者进行管理，这符合单一职责原则。
资源消耗大，如果要保存的内部状态信息过多或者特别频繁，将会占用比较大的内存资源。

典型运用场景举例：

需要保存与恢复数据的场景，如玩游戏时的中间结果的存档功能。
需要提供一个可回滚操作的场景，如 Word、记事本、Photoshop，Eclipse 等软件在编辑时按 Ctrl+Z 组合键，还有数据库中事务操作。