本文节选自《设计模式就该这样学》
1 使用备忘录模式实现草稿箱功能
大家都用过网页中的富文本编辑器，编辑器通常都会附带草稿箱、撤销等操作。下面用一段代码来实现一个这样的功能。假设，我们在GPer社区中发布一篇文章，文章编辑的过程需要花很长时间，中间也会不停地撤销、修改，甚至可能要花好几天才能写出一篇精品文章，因此可能会将已经编辑好的内容实时保存到草稿箱。
首先创建发起人角色编辑器Editor类。
public class Editor {
private String title;
private String content;
private String imgs;
public Editor(String title, String content, String imgs) {
this.title = title;
this.content = content;
this.imgs = imgs;
}
public String getTitle() {
return title;
}
public void setTitle(String title) {
this.title = title;
}
public String getContent() {
return content;
}
public void setContent(String content) {
this.content = content;
}
public String getImgs() {
return imgs;
}
public void setImgs(String imgs) {
this.imgs = imgs;
}
public ArticleMemento saveToMemento() {
ArticleMemento articleMemento = new ArticleMemento(this.title,this.content,this.imgs);
return articleMemento;
}
public void undoFromMemento(ArticleMemento articleMemento) {
this.title = articleMemento.getTitle();
this.content = articleMemento.getContent();
this.imgs = articleMemento.getImgs();
}
@Override
public String toString() {
return "Editor{" +
"title='" + title + '\'' +
", content='" + content + '\'' +
", imgs='" + imgs + '\'' +
'}';
}
}
然后创建备忘录角色ArticleMemento类。
public class ArticleMemento {
private String title;
private String content;
private String imgs;
public ArticleMemento(String title, String content, String imgs) {
this.title = title;
this.content = content;
this.imgs = imgs;
}
public String getTitle() {
return title;
}
public String getContent() {
return content;
}
public String getImgs() {
return imgs;
}
@Override
public String toString() {
return "ArticleMemento{" +
"title='" + title + '\'' +
", content='" + content + '\'' +
", imgs='" + imgs + '\'' +
'}';
}
}
接着创建备忘录管理角色草稿箱DraftsBox类。
public class DraftsBox {
private final Stack STACK = new Stack();
public ArticleMemento getMemento() {
ArticleMemento articleMemento= STACK.pop();
return articleMemento;
}
public void addMemento(ArticleMemento articleMemento) {
STACK.push(articleMemento);
}
}
草稿箱中定义的Stack类是Vector的一个子类，它实现了一个标准的后进先出的栈。如下表所示，主要定义了以下方法。
| 方法定义 | 方法描述 |
|---|---|
| boolean empty() | 测试堆栈是否为空 |
| Object peek( ) | 查看堆栈顶部的对象，但不从堆栈中移除它 |
| Object pop( ) | 移除堆栈顶部的对象，并作为此函数的值返回该对象 |
| Object push(Object element) | 把对象压入堆栈顶部 |
| int search(Object element) | 返回对象在堆栈中的位置，以1为基数 |
最后编写客户端测试代码。
public static void main(String[] args) {
DraftsBox draftsBox = new DraftsBox();
Editor editor = new Editor("我是这样手写Spring的，麻雀虽小五脏俱全",
"本文节选自《Spring5核心原理与30个类手写实战》一书，Tom著，电子工业出版社出版。",
"35576a9ef6fc407aa088eb8280fb1d9d.png");
ArticleMemento articleMemento = editor.saveToMemento();
draftsBox.addMemento(articleMemento);
System.out.println("标题：" + editor.getTitle() + "\n" +
"内容：" + editor.getContent() + "\n" +
"插图：" + editor.getImgs() + "\n暂存成功");
System.out.println("完整的信息" + editor);
System.out.println("==========首次修改文章===========");
editor.setTitle("【Tom原创】我是这样手写Spring的，麻雀虽小五脏俱全");
editor.setContent("本文节选自《Spring5核心原理与30个类手写实战》一书，Tom著");
System.out.println("==========首次修改文章完成===========");
System.out.println("完整的信息" + editor);
articleMemento = editor.saveToMemento();
draftsBox.addMemento(articleMemento);
System.out.println("==========保存到草稿箱===========");
System.out.println("==========第2次修改文章===========");
editor.setTitle("手写Spring");
editor.setContent("本文节选自《Spring5核心原理与30个类手写实战》一书，Tom著");
System.out.println("完整的信息" + editor);
System.out.println("==========第2次修改文章完成===========");
System.out.println("==========第1次撤销===========");
articleMemento = draftsBox.getMemento();
editor.undoFromMemento(articleMemento);
System.out.println("完整的信息" + editor);
System.out.println("==========第1次撤销完成===========");
System.out.println("==========第2次撤销===========");
articleMemento = draftsBox.getMemento();
editor.undoFromMemento(articleMemento);
System.out.println("完整的信息" + editor);
System.out.println("==========第2次撤销完成===========");
}
运行结果如下图所示。
2 备忘录模式在Spring源码中的应用
备忘录模式在框架源码中的应用也是比较少的，主要还是结合具体的应用场景来使用。笔者在JDK源码里一顿找，目前为止还是没找到具体的应用，包括在MyBatis中也没有找到对应的源码。在Spring的Webflow源码中还是找到一个StateManageableMessageContext接口，源码如下。
public interface StateManageableMessageContext extends MessageContext {
public Serializable createMessagesMemento();
public void restoreMessages(Serializable messagesMemento);
public void setMessageSource(MessageSource messageSource);
}
我们看到有一个createMessagesMemento()方法，创建一个消息备忘录。可以打开它的实现类，代码如下。
public class DefaultMessageContext implements StateManageableMessageContext {
private static final Log logger = LogFactory.getLog(DefaultMessageContext.class);
private MessageSource messageSource;
@SuppressWarnings("serial")
private Map> sourceMessages =
new AbstractCachingMapDecorator>(
new LinkedHashMap>()) {
protected List create(Object source) {
return new ArrayList();
}
};
...
public void clearMessages() {
sourceMessages.clear();
}
// implementing state manageable message context
public Serializable createMessagesMemento() {
return new LinkedHashMap>(sourceMessages);
}
@SuppressWarnings("unchecked")
public void restoreMessages(Serializable messagesMemento) {
sourceMessages.putAll((Map>) messagesMemento);
}
public void setMessageSource(MessageSource messageSource) {
if (messageSource == null) {
messageSource = new DefaultTextFallbackMessageSource();
}
this.messageSource = messageSource;
}
...
}
我们看到其主要逻辑就相当于给Message留一个备份，以备恢复之用。
关注微信公众号『 Tom弹架构 』回复“设计模式”可获取完整源码。
【推荐】Tom弹架构：30个设计模式真实案例（附源码），挑战年薪60W不是梦
本文为“Tom弹架构”原创，转载请注明出处。技术在于分享，我分享我快乐！
如果本文对您有帮助，欢迎关注和点赞；如果您有任何建议也可留言评论或私信，您的支持是我坚持创作的动力。关注微信公众号『 Tom弹架构 』可获取更多技术干货！