备忘录模式

定义

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

备忘录模式属于对象行为型模式。

要点

优点：

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

缺点：

1. 资源消耗大。如果要保存的内部状态信息过多或者特别频繁，将会占用比较大的内存资源。

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

场景

Memento

/**
 * 备忘录
 */
public class Memento {

    /**
     * 关卡
     */
    private Integer checkpoint;

    public Memento(Integer checkpoint) {
        this.checkpoint = checkpoint;
    }

    public Integer getCheckpoint() {
        return checkpoint;
    }

    public void setCheckpoint(Integer checkpoint) {
        this.checkpoint = checkpoint;
    }


    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;
        Memento memento = (Memento) o;
        return checkpoint.equals(memento.checkpoint);
    }

    @Override
    public int hashCode() {
        return Objects.hash(checkpoint);
    }

    @Override
    public String toString() {
        return "Memento{" +
                "关卡='" + checkpoint + '}';
    }

}

Caretaker

/**
 * 备忘录管理类（存档）
 */
public class Caretaker {

    /**
     * 存放的关卡
     */
    private Memento memento;

    /**
     * 保存关卡
     */
    public void archiveMemento(Memento memento) {
       this.memento = memento;
    }

    /**
     * 恢复存档
     */
    public Memento restoreMemento() {
        return memento;
    }

}

Game

/**
 * 游戏，相当于Originator
 */
public class Game {

    /**
     * 手势
     */
    private final String ROCK = "石头";
    private final String SCISSORS = "剪刀";
    private final String CLOTH = "布";
    private final String EXIT = "exit";

    /**
     * 当前关卡
     */
    private Memento memento;

    public Game() {
        this.memento = new Memento(1);
        System.out.println("================= 猜拳游戏开始 ================");
    }

    public Game(Memento memento) {
        this.memento = memento;
        System.out.println("================= 猜拳游戏开始 ================");
    }

    public void play() {
        System.out.println("\n============================================");
        System.out.println("当前游戏关卡：[" + memento.getCheckpoint() + "], 【输入 exit 退出游戏】");
        System.out.println("============================================");
        System.out.println("请输入【石头】【剪刀】【布】：");
        fingerGuess();
    }

    /**
     * 猜拳
     */
    private void fingerGuess() {
        String systemGesture = getSystemGesture();
        Scanner scanner = new Scanner(System.in);
        String userGesture = scanner.next();

        while (!ROCK.equals(userGesture) && !SCISSORS.equals(userGesture) && !CLOTH.equals(userGesture)) {
            if (EXIT.equals(userGesture)) {
            	System.out.println("正在退出游戏...");
                return;
            }
            System.out.println("你输入的手势有误，请重新输入：");
            userGesture = scanner.next();
        }

        // 用户手势和系统手势比较
        if (ROCK.equals(userGesture)) {
            switch (systemGesture) {
                case ROCK:
                    System.out.println("平局，继续执行该关卡...");
                    play();
                    break;
                case SCISSORS:
                    System.out.println("系统手势是：" + SCISSORS + ", 您赢了！进入下一关");
                    nextCheckPoint();
                    break;
                default:
                    System.out.println("系统手势是：" + CLOTH + ", 您输了！继续执行该关卡...");
                    play();
                    break;
            }
        } else if (SCISSORS.equals(userGesture)) {
            switch (systemGesture) {
                case ROCK:
                    System.out.println("系统手势是：" + ROCK + ", 您输了！继续执行该关卡...");
                    play();
                    break;
                case SCISSORS:
                    System.out.println("平局，继续执行该关卡...");
                    play();
                    break;
                default:
                    System.out.println("系统手势是：" + CLOTH + ", 您赢了！进入下一关");
                    nextCheckPoint();
                    break;
            }
        } else {
            switch (systemGesture) {
                case ROCK:
                    System.out.println("系统手势是：" + ROCK + ", 您赢了！进入下一关");
                    nextCheckPoint();
                    break;
                case SCISSORS:
                    System.out.println("系统手势是：" + SCISSORS + ", 您输了！继续执行该关卡...");
                    play();
                    break;
                default:
                    System.out.println("平局，继续执行该关卡...");
                    play();
                    break;
            }
        }
    }

    /**
     * 生成系统手势
     */
    private String getSystemGesture() {
        // 随机生成系统手势
        String systemGesture;
        switch (new Random().nextInt(3)) {
            case 0:
                systemGesture = ROCK;
                break;
            case 1:
                systemGesture = SCISSORS;
                break;
            default:
                systemGesture = CLOTH;
        }
        return systemGesture;
    }

    /**
     * 进入下一关
     */
    private void nextCheckPoint() {
        memento = new Memento(memento.getCheckpoint() + 1);
        play();
    }

    /**
     * 退出游戏并存档
     */
    public Memento quitAndArchive() {
    	System.out.println("正在为您存档...\n");
        return memento;
    }

    /**
     * 开始游戏并读取存档
     */
    public void beginAndRestore(Memento memento) {
        System.out.println("\n正在读取存档... 准备开始游戏");
        this.memento = Optional.ofNullable(memento).orElse(new Memento(1));
        play();
    }

}

Client

public class Client {

    public static void main(String[] args) {
        Game game = new Game();
        Caretaker caretaker = new Caretaker();
        // 开始游戏
        game.play();
        // 退出游戏并存档
        caretaker.archiveMemento(game.quitAndArchive());
        // 读取存档并开始游戏
        game.beginAndRestore(caretaker.restoreMemento());
    }

}

源码

Click here

总结

适用场景：

1. 需要保存与恢复数据的场景，如玩游戏时的中间结果的存档功能。
2. 需要提供一个可回滚操作的场景，如 Word、记事本、Photoshop，Eclipse 等软件在编辑时按 Ctrl+Z 组合键，还有数据库中事务操作。
3. 需要保证被保存的对象状态不能被外部访问，保证内部完整性，不向第三方透露。
4. 在不破坏封闭的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，以便恢复到原先保存的状态。