备忘录模式

备忘录模式（Memento Pattern）是一种行为型设计模式，它用于捕获一个对象的内部状态，并在不破坏对象封装性的情况下将状态保存到外部，以便将来可以恢复对象到先前的状态。

备忘录模式的核心思想是将状态保存和恢复的责任分离开来，以确保对象的封装性。这允许在不破坏对象封装性的情况下，实现状态的保存和恢复，从而提高了系统的可维护性和灵活性。

结构

备忘录模式的主要角色包括：

1. 发起者（Originator）： 发起者是需要保存和恢复状态的对象。它创建一个备忘录对象以保存其内部状态，并可以使用备忘录对象来还原到先前的状态。

2. 备忘录（Memento）： 备忘录是用于存储发起者对象的内部状态的对象。备忘录通常包含了所有需要保存的状态信息，但它应该对外部对象保持封装，以确保只有发起者可以访问状态信息。

3. 负责人（Caretaker）： 负责人是用于管理备忘录对象的对象。它可以存储备忘录对象，但不应该修改或检查备忘录的内容。它的主要任务是将备忘录对象存储起来以及在需要时将其还原到发起者对象。

示例

以下是一个 Java 示例，演示了如何实现备忘录模式来保存和恢复对象的状态。在这个示例中，将创建一个文本编辑器，用户可以输入文本并执行撤销操作以还原文本的历史状态。

import java.util.ArrayList;
import java.util.List;

// 备忘录类，用于保存文本的状态
class TextMemento {
    private String text;

    public TextMemento(String text) {
        this.text = text;
    }

    public String getText() {
        return text;
    }
}

// 文本编辑器类，充当发起者
class TextEditor {
    private StringBuilder text = new StringBuilder();
    private List<TextMemento> history = new ArrayList<>();

    // 添加文本
    public void addText(String newText) {
        history.add(new TextMemento(text.toString())); // 保存当前状态到历史
        text.append(newText);
    }

    // 撤销操作，恢复到前一个状态
    public void undo() {
        if (!history.isEmpty()) {
            int lastIndex = history.size() - 1;
            text = new StringBuilder(history.get(lastIndex).getText());
            history.remove(lastIndex);
        }
    }

    // 获取当前文本
    public String getText() {
        return text.toString();
    }
}

public class MementoPatternExample {
    public static void main(String[] args) {
        TextEditor editor = new TextEditor();

        editor.addText("Hello, ");
        editor.addText("world!");
        System.out.println("Current Text: " + editor.getText());

        editor.undo();
        System.out.println("After Undo: " + editor.getText());
    }
}

在这个示例中，TextEditor 充当发起者，用户可以使用 addText 方法添加文本，并使用 undo 方法执行撤销操作。每次添加文本时，当前文本的状态会保存到历史中，以备将来恢复。TextMemento 是备忘录类，用于保存文本的状态。

运行示例代码后，将看到文本编辑器在执行撤销操作后能够还原到之前的状态。这演示了备忘录模式的基本概念，可以用于实现状态的保存和恢复功能。

适用场景

以下是备忘录模式的一些使用场景：

使用场景：

1. 需要实现对象状态的撤销和恢复功能，例如文本编辑器中的撤销/恢复操作。
2. 需要保存和恢复对象的状态，以实现对象的快照或版本控制。
3. 需要在不破坏对象封装性的情况下，实现状态的保存和还原。

优点

1. 状态保存和恢复： 主要优点是允许对象保存其内部状态，并在需要时将其还原。这对于实现撤销、恢复、版本控制等功能非常有用。
2. 封装性： 备忘录模式遵循了封装性原则，因为备忘录对象将状态封装在内部，不允许外部对象直接访问或修改状态，从而提高了对象的封装性。
3. 灵活性： 备忘录模式允许在运行时捕获和恢复对象的状态，因此具有很高的灵活性。对象的状态可以在任何时间点保存和还原，而无需影响其它部分的代码。

缺点

1. 内存消耗： 如果频繁保存对象的状态，可能会导致内存消耗较大。每个备忘录对象都需要存储一份状态副本，如果对象有大量状态数据，可能会占用大量内存。
2. 性能开销： 在保存和还原状态时可能涉及复制大量数据，这可能导致性能开销较大。在某些情况下，备忘录模式可能不适合要求高性能的应用。
3. 复杂性： 在实现备忘录模式时，需要创建备忘录类、发起者类和负责人类，这增加了代码的复杂性。特别是在需要支持多个发起者和多个备忘录对象的情况下，可能需要更多的管理和协调。

备忘录模式的一个经典应用是实现撤销功能，其中用户可以逐步撤销操作，恢复到之前的状态。此外，备忘录模式还在需要实现历史记录、版本控制等功能时非常有用。

拓展

备忘录模式有两种主要的变体：白箱备忘录模式和黑箱备忘录模式。它们在如何处理备忘录对象的可见性和封装性方面有所不同。

1. 白箱备忘录模式（White-box Memento Pattern）：

   • 在白箱备忘录模式中，备忘录对象的状态是对外可见的，即备忘录对象的内部状态可以被发起者（Originator）直接访问和修改。
   • 发起者（Originator）和备忘录对象之间有较高的耦合，因为发起者需要了解备忘录对象的内部结构以保存和还原状态。
   • 这种模式的优点是实现简单，但破坏了备忘录对象的封装性。

2. 黑箱备忘录模式（Black-box Memento Pattern）：

   • 在黑箱备忘录模式中，备忘录对象的状态对外是不可见的，发起者无法直接访问备忘录对象的内部状态。
   • 发起者和备忘录对象之间的耦合较低，发起者只需知道如何保存和还原状态，而无需了解备忘录对象的内部结构。
   • 这种模式遵循了对象的封装性原则，但可能需要一些额外的工作来实现。

下面是两种备忘录模式的示例说明：

白箱备忘录模式示例：

// 白箱备忘录模式中，备忘录对象的内部状态对外可见
class WhiteBoxMemento {
    private String state;

    public WhiteBoxMemento(String state) {
        this.state = state;
    }

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }
}

// 发起者
class Originator {
    private String state;

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public WhiteBoxMemento saveStateToMemento() {
        return new WhiteBoxMemento(state);
    }

    public void restoreStateFromMemento(WhiteBoxMemento memento) {
        state = memento.getState();
    }
}

黑箱备忘录模式示例：

// 黑箱备忘录模式中，备忘录对象的内部状态对外不可见
class BlackBoxMemento {
    private String state;

    public BlackBoxMemento(String state) {
        this.state = state;
    }
}

// 发起者
class Originator {
    private String state;

    public String getState() {
        return state;
    }

    public void setState(String state) {
        this.state = state;
    }

    public BlackBoxMemento saveStateToMemento() {
        return new BlackBoxMemento(state);
    }

    public void restoreStateFromMemento(BlackBoxMemento memento) {
        state = memento.getState();
    }
}

总之，白箱备忘录模式允许备忘录对象的内部状态对外可见和可修改，而黑箱备忘录模式将备忘录对象的内部状态封装得更加严格，对外不可见。

如果需要更高的可见性和直接访问备忘录对象的状态，可以选择白箱备忘录模式；如果需要更好的封装性和低耦合性，可以选择黑箱备忘录模式。