备忘录设计模式示例

本文是我们名为“ Java设计模式 ”的学院课程的一部分。

在本课程中，您将深入研究大量的设计模式，并了解如何在Java中实现和利用它们。 您将了解模式如此重要的原因，并了解何时以及如何应用模式中的每一个。 在这里查看 ！

1.简介

有时有必要记录对象的内部状态。 在实施检查点和“撤消”机制时，这是必需的，该机制使用户退出尝试性操作或从错误中恢复。 您必须将状态信息保存在某处，以便可以将对象还原到其先前的状态。 但是对象通常封装了部分或全部状态，使得其他对象无法访问它，并且无法在外部保存。 暴露此状态将违反封装，这可能会损害应用程序的可靠性和可扩展性。

可以使用Memento模式完成此操作，而无需暴露对象的内部结构。 需要捕获其状态的对象称为始发者。

为了说明Memento模式的用法，我们来看一个示例。 我们将创建一个包含两个双精度类型字段的类，并在其上运行一些数学运算。 我们将为用户提供撤消操作。 如果用户不满意某些操作后的结果，则用户可以调用撤消操作，该操作会将对象的状态恢复到最后保存的点。

该示例还包括一个保存点机制，用户可以使用该机制保存对象的状态。 我们还将提供各种撤消操作。 一个简单的撤消操作会将对象状态恢复到先前的保存点。 具有指定保存点的撤消将还原对象的特定状态，而全部撤消将删除对象的所有已保存状态，并在创建对象时将其恢复为初始化状态。

在实施模式之前，让我们进一步了解Memento设计模式。

2.什么是Memento设计模式

Memento模式的目的是在不违反封装的情况下捕获并外部化对象的内部状态，以便以后可以将对象恢复为该状态。

图1

纪念品

• 存储原始对象的内部状态。 纪念品可以根据原始创建者的判断存储尽可能多的原始内部状态。
• 防止发起者以外的对象访问。 备忘录有效地具有两个接口。 Caretaker看到与Memento的接口很狭窄-它只能将Memento传递给其他对象。 相反，Originator看到了一个广泛的接口，该接口使它可以访问将自身恢复到先前状态所需的所有数据。 理想情况下，仅允许产生纪念品的始发者访问纪念品的内部状态。

鼻祖

• 创建一个包含其当前内部状态快照的纪念品。
• 使用纪念品恢复其内部状态。

看守人

• 负责纪念品的保管。
• 切勿操作或检查纪念品的内容。

当客户端想要保存发起者的状态时，它向发起者请求当前状态。 发起方将恢复其状态所需的所有那些属性存储在称为Memento的单独对象中，并将其返回给客户端。 因此，在给定的时间点，可以将Memento视为包含另一个对象的内部状态的对象。 一个Memento对象必须对除原始者之外的所有对象隐藏原始者变量值。 换句话说，它应该保护其内部状态，以防止除原始方以外的其他对象访问。 为此，在允许始发者访问其内部状态的同时，应将Memento设计为提供对其他对象的受限访问。

当客户希望将发起者恢复到其先前的状态时，它只是将备忘录传递回发起者。 始发者使用包含在memento中的状态信息，并将自身返回到存储在Memento对象中的状态。

3.实施Memento设计模式

package com.javacodegeeks.patterns.mementopattern;

public class Originator {

	private double x;
	private double y;

	private String lastUndoSavepoint;
	CareTaker careTaker;

	public Originator(double x, double y,CareTaker careTaker){
		this.x = x;
		this.y = y;

		this.careTaker = careTaker;

		createSavepoint("INITIAL");
	}

	public double getX(){
		return x;
	}

	public double getY(){
		return y;
	}

	public void setX(double x) {
		this.x = x;
	}

	public void setY(double y) {
		this.y = y;
	}

	public void createSavepoint(String savepointName){
		careTaker.saveMemento(new Memento(this.x, this.y), savepointName);
		lastUndoSavepoint = savepointName;
	}

	public void undo(){
		setOriginatorState(lastUndoSavepoint);
	}

	public void undo(String savepointName){
		setOriginatorState(savepointName);
	}

	public void undoAll(){
		setOriginatorState("INITIAL");
		careTaker.clearSavepoints();
	}

	private void setOriginatorState(String savepointName){
		Memento mem = careTaker.getMemento(savepointName);
		this.x = mem.getX();
		this.y = mem.getY();
	}

	@Override
	public String toString(){
		return "X: "+x+", Y: "+y;
	}

}

上面是Originator类，其对象状态应保存在内存中。 该类包含两个double类型的字段x和y ，并且还引用了CareTaker 。 的CareTaker用来保存和检索代表该状态的纪念品对象Originator对象。

在构造函数中，我们使用createSavepoint方法保存了对象的初始状态。 此方法创建一个memento对象，并请求看护者照顾该对象。 我们使用了lastUndoSavepoint变量，该变量用于存储上次保存的lastUndoSavepoint的键名，以实现undo操作。

该类提供三种类型的undo操作。 不带任何参数的undo方法将还原最后保存的状态，以保存点名称作为参数的undo将还原使用该特定保存点名称保存的状态。 undoAll方法要求看护者清除所有保存点并将其设置为初始状态（创建对象时的状态）。

package com.javacodegeeks.patterns.mementopattern;

public class Memento {

	private double x;
	private double y;

	public Memento(double x, double y){
		this.x = x;
		this.y = y;
	}

	public double getX(){
		return x;
	}

	public double getY(){
		return y;
	}
}

该Memento类用于存储的状态Originator和照顾接受者存储。 该类没有任何设置方法，仅用于获取对象的状态。

package com.javacodegeeks.patterns.mementopattern;

import java.util.HashMap;
import java.util.Map;

public class CareTaker {

	private final Map<String, Memento>savepointStorage = new HashMap<String, Memento>();

	public void saveMemento(Memento memento,String savepointName){
		System.out.println("Saving state..."+savepointName);
		savepointStorage.put(savepointName, memento);
	}

	public Memento getMemento(String savepointName){
		System.out.println("Undo at ..."+savepointName);
		return savepointStorage.get(savepointName);
	}

	public void clearSavepoints(){
		System.out.println("Clearing all save points...");
		savepointStorage.clear();
	}

}

上面的类是用于存储和提供请求的memento对象的看护者类。 该类包含saveMemento方法用于保存memento对象， getMemento方法用于返回请求memento对象，以及clearSavepoints方法用于清除所有保存点，并删除所有已保存的memento对象。

现在，让我们测试示例。

package com.javacodegeeks.patterns.mementopattern;

public class TestMementoPattern {

	public static void main(String[] args) {

		CareTaker careTaker = new CareTaker();
		Originator originator = new Originator(5, 10, careTaker);

		System.out.println("Default State: "+originator);

		originator.setX(originator.getY()*51);

		System.out.println("State: "+originator);
		originator.createSavepoint("SAVE1");

		originator.setY(originator.getX()/22);
		System.out.println("State: "+originator);

		originator.undo();
		System.out.println("State after undo: "+originator);

		originator.setX(Math.pow(originator.getX(),3));
		originator.createSavepoint("SAVE2");
		System.out.println("State: "+originator);
		originator.setY(originator.getX()-30);
		originator.createSavepoint("SAVE3");
		System.out.println("State: "+originator);
		originator.setY(originator.getX()/22);
		originator.createSavepoint("SAVE4");
		System.out.println("State: "+originator);

		originator.undo("SAVE2");
		System.out.println("Retrieving at: "+originator);

		originator.undoAll();
		System.out.println("State after undo all: "+originator);
	}

}

上面的代码将导致以下输出。

Saving state...INITIAL
Default State: X: 5.0, Y: 10.0
State: X: 510.0, Y: 10.0
Saving state...SAVE1
State: X: 510.0, Y: 23.181818181818183
Undo at ...SAVE1
State after undo: X: 510.0, Y: 10.0
Saving state...SAVE2
State: X: 1.32651E8, Y: 10.0
Saving state...SAVE3
State: X: 1.32651E8, Y: 1.3265097E8
Saving state...SAVE4
State: X: 1.32651E8, Y: 6029590.909090909
Undo at ...SAVE2
Retrieving at: X: 1.32651E8, Y: 10.0
Undo at ...INITIAL
Clearing all save points...
State after undo all: X: 5.0, Y: 10.0

在上面的代码中，我们创建了一个CareTaker对象，然后将其分配给Originator对象。 然后，将x和y的值分别设置为5和10。然后，对x一些运算并将对象的状态保存为“ SAVE1”。

经过更多的操作后，我们调用了undo方法来恢复对象的最后状态，该状态在输出中会清楚显示。 然后，我们进行了一些操作，然后再次将对象的状态保存为“ SAVE2，SAVE3和SAVE4”。

然后，我们问Originator恢复SAVE2状态和呼叫undoAll方法，设置对象的初始状态，并删除所有保存点。

请注意，在以上示例中， Originator负责将其纪念品提供给看护者。 原因是我们不想将这种责任赋予用户。 在我们的示例中，用户只需要请求保存点和对象状态的恢复。 在许多情况下，看护人会由其他类别的人在发起人外部进行操作（如上图所示）。

4.何时使用纪念图案

在以下情况下，请使用Memento模式：

• 必须保存对象状态（部分状态）的快照，以便以后可以将其恢复到该状态，并且
• 获取状态的直接接口将公开实现细节并破坏对象的封装。

5. JDK中的Memento模式

• java.util.Date
• java.io.Serializable

6.下载源代码

这是关于Memento设计模式的课程。 您可以在此处下载源代码： MementoDesignPattern-Project

翻译自: https://www.javacodegeeks.com/2015/09/memento-design-pattern.html