设计模式-备忘录模式在Java中使用示例-象棋悔棋

场景

备忘录模式

备忘录模式提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效

或者存在问题时，可以使用暂时存储起来的备忘录将状态复原，当前很多软件都提供了撤销(Undo)操作，

其中就使用了备忘录模式。

备忘录模式结构图

在备忘录模式结构图中包含如下几个角色：

Originator（原发器）：

它是一个普通类，可以创建一个备忘录，并存储它的当前内部状态，也可以使用备忘录来恢复其内部状态，

一般将需要保存内部状态的类设计为原发器。

Memento（备忘录)：

存储原发器的内部状态，根据原发器来决定保存哪些内部状态。备忘录的设计一般可以参考原发器的设计，

根据实际需要确定备忘录类中的属性。需要注意的是，除了原发器本身与负责人类之外，

备忘录对象不能直接供其他类使用，原发器的设计在不同的编程语言中实现机制会有所不同。

Caretaker（负责人）：

负责人又称为管理者，它负责保存备忘录，但是不能对备忘录的内容进行操作或检查。

在负责人类中可以存储一个或多个备忘录对象，它只负责存储对象，而不能修改对象，

也无须知道对象的实现细节。

注：

博客：
霸道流氓气质_C#,架构之路,SpringBoot-CSDN博客

实现

使用备忘录模式实现象棋悔棋功能。

1、新建象棋旗子类作为原发器

import lombok.Data;

//象棋旗子类：原发器
@Data
public class Chessman {
    private String label;
    private int x;
    private int y;

    public Chessman(String label, int x, int y) {
        this.label = label;
        this.x = x;
        this.y = y;
    }

    //保存状态
    public ChessmanMemento save(){
        return new ChessmanMemento(this.label,this.x,this.y);
    }

    //恢复状态
    public void restore(ChessmanMemento memento){
        this.label = memento.getLabel();
        this.x = memento.getX();
        this.y = memento.getY();
    }
}

2、新建象棋棋子备忘录类

import lombok.Data;

//象棋棋子备忘录类:备忘录
@Data
public class ChessmanMemento {

    private String label;
    private int x;
    private int y;

    public ChessmanMemento(String label, int x, int y) {
        this.label = label;
        this.x = x;
        this.y = y;
    }
}

3、新建象棋棋子备忘录管理类

//象棋棋子备忘录管理类:负责人
public class MementoCaretaker {

    private ChessmanMemento memento;

    public ChessmanMemento getMemento(){
        return memento;
    }

    public void setMemento(ChessmanMemento memento){
        this.memento = memento;
    }
}

4、客户端调用方式

public class Client {
    public static void main(String[] args) {
        MementoCaretaker mc = new MementoCaretaker();
        Chessman chess = new Chessman("车",1,1);
        display(chess);
        //保存状态
        mc.setMemento(chess.save());
        chess.setY(4);
        display(chess);
        //保存状态
        mc.setMemento(chess.save());
        chess.setX(5);
        display(chess);
        System.out.println("悔棋");
        //恢复状态
        chess.restore(mc.getMemento());
        display(chess);
    }

    public static void display(Chessman chessman){
        System.out.println("棋子"+chessman.getLabel()+"当前位置为:第"+chessman.getX()+"行，第"+chessman.getY()+"列");
    }
}

5、总结

备忘录模式的主要优点如下：

(1)它提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效

或者存在问题时，可以使用暂时存储起来的备忘录将状态复原。

(2)备忘录实现了对信息的封装，一个备忘录对象是一种原发器对象状态的表示，不会被其他代码所改动。

备忘录保存了原发器的状态，采用列表、堆栈等集合来存储备忘录对象可以实现多次撤销操作。

备忘录模式的主要缺点如下：

资源消耗过大，如果需要保存的原发器类的成员变量太多，就不可避免需要占用大量的存储空间，每

保存一次对象的状态都需要消耗一定的系统资源。

在以下情况下可以考虑使用备忘录模式：

(1)保存一个对象在某一个时刻的全部状态或部分状态，这样以后需要时它能够恢复到先前的状态，实现撤销操作。

(2)防止外界对象破坏一个对象历史状态的封装性，避免将对象历史状态的实现细节暴露给外界对象。