秒懂设计模式之备忘录模式（Memento Pattern）

Posted 2021-06-15 ShuSheng007

[版权申明] 非商业目的注明出处可自由转载
博文地址：https://blog.csdn.net/ShuSheng0007/article/details/117430604
出自：shusheng007

设计模式汇总篇，强烈建议要点赞收藏：

永不磨灭的设计模式（有这一篇真够了，拒绝标题党）

概述

备忘录模式听起来特别高深，其实可能写过几年代码的都不知不觉的用了很多次了。模式的名称其实已经很形象的反映出其作用了：就是为了在某一时刻把当前的状态记录下来，以后再恢复到那时的状态。

类型

行为型（behavioral）

难度

2颗星

定义

在不破坏封闭的前提下捕获一个对象的内部状态，并在该对象之外保存这个状态，从而可以将对象恢复到原先保存的状态

使用场景

当你正在开发一个功能，这个功能需要存档的时候就应该想到它。例如游戏，文档编辑器等等，都需要在你下次重新打开的时候恢复到你关闭它时候的状态。

实例

王二狗在享元模式那集帮他儿子开发了个五子棋游戏，儿子玩过几次后提出了一个痛点：

儿子：老爸，我经常玩到一半的时候妈妈就喊我去睡觉，然后我睡醒了打开它就变成新的了，你能不能在我睡觉的时候把它存起来，那样我玩的时候就能从上次停下来的地方开始了…balabala。

二狗：听着那小子一直巴巴，二狗陷入了沉思：养个儿子真费劲，这么小就使唤老子，长大了还的帮着娶媳妇，关键是房子tm那么贵，以后还的带孙子…这要是个闺女多好…

儿子：老爸，你干啥呢，你听见我说话了吗…

二狗：听见拉，听见啦，我这就给你弄，但是你以后拉粑粑让你妈擦屁股啊，不要叫我了，听见没？

二狗思索了一下，此情此景正是备忘录模式的用武之地。

备忘录模式有3个角色

• Originator

我们知道备忘录模式就是要完成保存状态，然后恢复状态的功能。那么保存和恢复谁的状态呢？对了，就是这个角色的状态。

• Memento

这个就比较简单了，就是一个存储状态的类，里面没有业务逻辑，一般是一个POJO。

• CareTaker

负责保存和恢复Originator的状态，状态是保存在这类里面的。

第一步：定义Originator

这个类是游戏类，我们就是要保存和恢复游戏进度。它内部提供了两个方法，一个对外提供备忘录，里面封装了其要恢复的内部状态。另一个是从外部接收备忘录，用来恢复内部状态。

可能有的同学要问了：为什么要这么搞呢？直接写个setter不香吗？其实核心思想还是为了封装。这里的currentScore是GameOriginator的内部状态，我们不愿意对外暴露，所以使用另一个对象包起来。这样的内部状态一般会有很多，这里做了简化。

public class GameOriginator {
    private int currentScore;
    
    //将需要保存的状态分装在Memento里对外提供
    public GameProgressMemento saveProcess() {
        return new GameProgressMemento(currentScore);
    }

    //通过从外部接收的Memento恢复状态
    public void restoreProcess(GameProgressMemento memento) {
        currentScore = memento.getScore();
    }

    //对内部状态的使用
    public void playGame() {
        System.out.println("------------------开始游戏------------------");
        System.out.println("当前分数为："+ currentScore);
        System.out.println("杀死一个小怪物得1分");
        currentScore++;
        System.out.println(String.format("总分为：%d", currentScore));
    }

    public void exitGame(){
        System.out.println("退出游戏");
        currentScore=0;
        System.out.println("-----------------退出游戏-------------------");
    }
}

构建备忘录Memento

这个类最简单，其基本上就是一个POJO。它不包含业务逻辑，只包含状态数据，结构由要保存的状态类决定。例如我们这里只保存一个内部状态，游戏分数。

public class GameProgressMemento {
    private int score;

    public GameProgressMemento(int score) {
        this.score = score;
    }

    public int getScore() {
        return score;
    }
}

构建CareTaker

如果说备忘录模式有一点点技巧的话，也就是这个类了。CareTaker相对于Originator来说是一个外部组件，它帮助Originator保存了状态，相当于Originator将自己某一个时刻的状态保存到了外部。

当我们要保存状态时，使用此类的saveMemento。当我们要恢复状态时，使用此类的getMemento

public class GameCareTaker {

    private List<GameProgressMemento> memento= new ArrayList<>();

    public void saveMemento(GameProgressMemento memento) {
        this.memento.add(memento);
    }

    public GameProgressMemento getMemento(int index) {
        return this.memento.get(index);
    }
}

客户端使用

public class MementoClient {
    public void replayGame() {
        GameOriginator originator = new GameOriginator();
        GameCareTaker careTaker = new GameCareTaker();
        //玩游戏
        originator.playGame();
        //保存进度
        careTaker.saveMemento(originator.saveProcess());
        //退出游戏
        originator.exitGame();

        //重新打开游戏，恢复进度
        originator.restoreProcess(careTaker.getMemento(0));
        originator.playGame();
    }
}

输出结果

------------------开始游戏------------------
当前分数为：0
杀死一个小怪物得1分
总分为：1
退出游戏
-----------------退出游戏-------------------
------------------开始游戏------------------
当前分数为：1
杀死一个小怪物得1分
总分为：2

技术要点

• 首先识别出Originator需要保存的状态，然后构建一个备忘录类Memento
• Originator需要提供两个方法，一个用于对外提供包含内部状态的备忘录，一个用于使用外部传递进来的备忘录恢复内部状态
• CareTaker 负责保存备忘录，并提供访问方法。

总结

设计模式值得你可以练习！

最近突然有想躺平的念头，然而月初银行催房贷的短信彻底打破了我的美好愿望，哎啥时候才能躺平啊，怕站着被镰刀从根部给割了…

希望待你老去之时，回顾你的IT生涯，脸上可以泛起一丝回念笑容…

GitHub源码地址：design-patterns