备忘录模式

一、定义

备忘录模式(Memento)：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样以后就可将该对象恢复到原先保存的状态。

 

二、备忘录模式结构图

备忘录模式中涉及的角色：

发起人(Originator)角色：负责创建一个备忘录Memento，用以记录当前时刻它的内部状态，并可使用备忘录恢复内部状态。Originator可根据需要决定Memento存储Originator的哪些内部状态。

备忘录(Memento)角色：负责存储Originator的内部状态，并可防止Originator以外的其他对象访问备忘录Memento。备忘录有两个接口，Caretaker只能看到备忘录的窄接口，他只能将备忘录传递给其他对象。Originator能够看到一个宽接口，允许它访问返回到先前状态所需的所有数据。

 管理者(Caretaker)角色：负责保存好备忘录Memento，不能对备忘录的内容进行操作或检查。

 

三、例子

备忘录模式模拟版本控制系统的工作流程。

/**
 * Document类代表需要被纳入版本控制系统的文档
 * 发起人角色
 * @author yikexin
 *
 */
public class Document {
	String content; // 需要备份的状态
	String otherContent; // 不需要备份的状态
	
	/**
	 * 保存一个备份
	 * @return 
	 */
	public BackUp save() {
		System.out.println("保存备份");
		return new BackUp(content);
	}
	
	/**
	 * 恢复为某个备份
	 * @param backUp
	 */
	public void resume(BackUp backUp) {
		System.out.println("恢复备份");
		content = backUp.getContent();
	}
 
	@Override
	public String toString() {
		return "Document [content=" + content + ", otherContent=" + otherContent + "]";
	}
 
}

/**
 * BackUp类代表版本控制系统中保存的每一个备份
 * 备忘录角色
 * @author yikexin
 *
 */
public class BackUp {
	private String content;
	int version;
	
	public BackUp(String content) {
		super();
		this.content = content;
	}
 
	public String getContent() {
		return content;
	}
 
	public void setContent(String content) {
		this.content = content;
	}
}

/**
 * VersionControlSystem 代表版本控制系统
 * 负责人角色
 * @author yikexin
 *
 */
public class VersionControlSystem {
	LinkedList<BackUp> backUps = new LinkedList<>();  // 所有备份
	int nextVersion = 0;  // 下一个版本
	
	public void add(BackUp backUp) {
		backUp.version = ++ nextVersion;
		backUps.add(backUp);
	}
	
	/**
	 * 获取某个版本的备份
	 * @param version 
	 * @return
	 */
	public BackUp get(int version) {
		for(BackUp backUp : backUps){
			if (backUp.version == version) {
				return backUp;
			}
		}
		return null;
	}
	
	/**
	 * 取得最后一个版本的备份
	 * @return
	 */
	public BackUp getLastVersion() {
		return backUps.getLast();		
	}
}

public class Client {
 
	public static void main(String[] args) {
		VersionControlSystem versionControl = new VersionControlSystem();
		
		Document document = new Document();
		document.content = "content1";
		document.otherContent = "otherContent1";
		System.out.println(document);
		versionControl.add(document.save());
		
		document.content = "content2";
		document.otherContent = "otherContent2";
		System.out.println(document);
		versionControl.add(document.save());
		
		document.content = "content3";
		document.otherContent = "otherContent3";
		System.out.println(document);
		versionControl.add(document.save());
		
		document.resume(versionControl.get(1));
		System.out.println(document);
		document.resume(versionControl.getLastVersion());
		System.out.println(document);
		
	}
 
}

输出结果：

Document [content=content1, otherContent=otherContent1]
保存备份
Document [content=content2, otherContent=otherContent2]
保存备份
Document [content=content3, otherContent=otherContent3]
保存备份
恢复备份
Document [content=content1, otherContent=otherContent3]
恢复备份
Document [content=content3, otherContent=otherContent3]

 

四、备忘录模式优缺点

优点：

1. 提供了一种状态恢复的实现机制，使得用户可以方便地回到一个特定的历史步骤，当新的状态无效或者存在问题时，可以使用先前存储起来的备忘录将状态复原。
2. 实现了信息的封装，一个备忘录对象是一种原发器对象的表示，不会被其他代码改动，这种模式简化了原发器对象，备忘录只保存原发器的状态，采用堆栈来存储备忘录对象可以实现多次撤销操作，可以通过在负责人中定义集合对象来存储多个备忘录。

缺点：

1. 资源消耗过大，如果类的成员变量太多，就不可避免占用大量的内存，而且每保存一次对象的状态都需要消耗内存资源，如果知道这一点大家就容易理解为什么一些提供了撤销功能的软件在运行时所需的内存和硬盘空间比较大了。

适用场景：

1. 保存一个对象在某一个时刻的状态或部分状态，这样以后需要时它能够恢复到先前的状态。
2. 如果用一个接口来让其他对象得到这些状态，将会暴露对象的实现细节并破坏对象的封装性，一个对象不希望外界直接访问其内部状态，通过负责人可以间接访问其内部状态。