备忘录模式 (学习笔记2021.09.24)

备忘录模式 (学习笔记2021.09.24)

前言:

备忘录模式是一种行为模式，在不破坏封闭的前提下，将对象当前的内部状态保存在对象之外，之后可以再次恢复到此状态。典型的例子就是游戏存档和读档的这个行为。

**意图：**在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。

**主要解决：**所谓备忘录模式就是在不破坏封装的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态，这样可以在以后将对象恢复到原先保存的状态。

**何时使用：**很多时候我们总是需要记录一个对象的内部状态，这样做的目的就是为了允许用户取消不确定或者错误的操作，能够恢复到他原先的状态，使得他有"后悔药"可吃。

**如何解决：**通过一个备忘录类专门存储对象状态。

**关键代码：**客户不与备忘录类耦合，与备忘录管理类耦合。

应用实例： 1、后悔药。 2、打游戏时的存档。 3、Windows 里的 ctrl + z。 4、IE 中的后退。 4、数据库的事务管理。

优点： 1、给用户提供了一种可以恢复状态的机制，可以使用户能够比较方便地回到某个历史的状态。 2、实现了信息的封装，使得用户不需要关心状态的保存细节。

**缺点：**消耗资源。如果类的成员变量过多，势必会占用比较大的资源，而且每一次保存都会消耗一定的内存。

使用场景： 1、需要保存/恢复数据的相关状态场景。 2、提供一个可回滚的操作。

注意事项： 1、为了符合迪米特原则，还要增加一个管理备忘录的类。 2、为了节约内存，可使用原型模式+备忘录模式。

应用场景也比较明确和有限，主要是用来防丢失、撤销、恢复等

从类图可以看出有三个角色。

• Originator：发起者，负责创建一个备忘录，并且可以记录、恢复自身的内部状态。可以根据需要决定Memento保存自身的那些内部状态

• Memento：备忘录，用于存储Originator的状态，防止Originator以外的的对象访问Memento

• Caretaker：备忘录管理者，负责存储备忘录，不能对备忘录的内容进行操作和访问，只能够将备忘录传递给其他对象。

前提条件

我们需要实现一个游戏的一个设计漏洞, 游戏上线导致道具疯狂给别人白嫖, 导致了游戏的不公平, 并且看起来公司损失了蛮多钱的, 需要进行游戏回档到新功能未上线之前。

使用备忘录模式实现需求

1.0 游戏类

/**
 * @Author: ZhiHao
 * @Date: 2021/9/24 17:33
 * @Description: 游戏数据
 * @Versions 1.0
 **/
@Data
@ToString
public class Game {
    
    // 游戏数据
    private String data;
    // 游戏版本号
    private String versions;
}

2.0 创建Memento：备忘录

备忘录，将发起人对象传入的备份存储起来。

/**
 * @Author: ZhiHao
 * @Date: 2021/9/24 17:40
 * @Description: 游戏版本备忘录
 * @Versions 1.0
 **/
public class GameMemento {

    private Game game;

    public Game getGame() {
        return game;
    }

    public GameMemento(Game game) {
        this.game = game;
    }
}

3.0 Caretaker：备忘录管理者

备忘录管理者，负责保存备忘录对象，但是从不修改（甚至不查看）备忘录对象的内容。

备忘录的GameMemento存储数据结构可以设置为存储多个版本的备份, 使用List或者Map

/**
 * @Author: ZhiHao
 * @Date: 2021/9/24 17:42
 * @Description: 备忘录管理者
 * @Versions 1.0
 **/
public class MementoCaretaker {

    private GameMemento mMemento;

    // 恢复备忘录
    public GameMemento restoreMemento(){
        return mMemento;
    }

    // 存储快照备忘录
    public void storeMemengto(GameMemento memento){
        this.mMemento = memento;
    }
}

4.0 Originator：发起者

发起者通过创建一个新的备忘录对象来保存自己的内部状态

/**
 * @Author: ZhiHao
 * @Date: 2021/9/24 17:42
 * @Description: 备忘录发起人
 * @Versions 1.0
 **/
public class MementoOriginator {

    private Game game;

    public Game getRestore() {
        return game;
    }

    public void setRestore(Game game) {
        this.game = game;
    }
    
    /**
     * 创建备忘录
     */
    public GameMemento createMemento() {
        return new GameMemento(game);
    }
    
    /**
     * 将发起者的状态恢复到备忘录的状态
     */
    public void restoreFromMemento(GameMemento memento) {
        this.setRestore(memento.getGame());
    }
}

5.0 测试

public void applicationTest() throws Exception {
        // 创建v1.0版本游戏
        Game game = new Game();
        game.setData(" 我是个游戏数据 ");
        game.setVersions("v1.0");
        // 创建备忘录管理者
        MementoCaretaker mementoCaretaker = new MementoCaretaker();
        // 备忘录发起人进行备份
        MementoOriginator mementoOriginator = new MementoOriginator();
        mementoOriginator.setRestore(game);
        // 备忘录发起人创建备忘录
        GameMemento memento = mementoOriginator.createMemento();
        // 备忘录管理者保存备忘录快照
        mementoCaretaker.storeMemengto(memento);
        System.out.println("初始游戏版本：" + mementoOriginator.getRestore());
        // 创建v2.0版本游戏
        Game game2 = new Game();
        game2.setData(" 我是个游戏数据 ");
        game2.setVersions("v2.0");
        mementoOriginator.setRestore(game2);
        System.out.println("新的游戏版本：" + mementoOriginator.getRestore());
        // 从备忘录管理者中取出备忘录，并通过备忘录恢复状态
        mementoOriginator.restoreFromMemento(mementoCaretaker.restoreMemento());
        System.out.println("恢复上一个游戏版本：" + mementoOriginator.getRestore());
    }
//-------------------------------------------------
初始游戏版本：Game(data= 我是个游戏数据 , versions=v1.0)
新的游戏版本：Game(data= 我是个游戏数据 , versions=v2.0)
恢复上一个游戏版本：Game(data= 我是个游戏数据 , versions=v1.0)

1