定义
Memento pattern is used to restore state of an object to a previous state.
备忘录模式被用来恢复对象之前的状态,而不破坏其封装性。
实列
生活中,一张照片、一段录音都记录着某一对象某一时刻的状态信息,照片会被保存在相册中,录音会保存在某个文件夹中,
如果某一天因为某些原因,需要回到该对象之前的某一个状态,那么我们只需从相册或文件夹中将某张照片或某段录音取出来,就可以"恢复"对象当时的状态。
对象、照片、相册形成的关系和备忘录模式中各角色形成的关系非常的相似,这有助于我们理解程序中如何使用备忘录模式来恢复一个对象的状态。
故事
前不久,我为公司开发了一款简单的文本编器(TextEditor),用户可以用它来写文章,编辑器中有两个view分别用来输入文章标题和文章内容。
最近,用户期望这款编辑器可以有撤销功能。也就说文本编辑器需要记录历史状态,当用户点击撤销按钮时,可以回到之前的状态。
我想这也不是很难,只需在用户输入的内容变化之前,将文本器当前的状态即文章标题与正文作为一张快照保存在一个集合容器中,等用户点撤销时再从容器中取出合适的快照并恢复就可以了。
/**响应用户事件的上下文*/
public class Context {
/**内容改变之前的回调操作*/
public void beforeTextEditorChanging(TextEditor textEditor,SnapshotContainer container) {
//快照
HashMap<String,String> snapshot = new HashMap<>();
snapshot.put("title",textEditor.getTitleView().getText());
snapshot.put("content",textEditor.getContentView().getText());
//保存快照
container.add(snapshot);
}
/**撤销按钮被点击*/
public void undo(TextEditor textEditor,SnapshotContainer container){
HashMap<String, String> lastSnapshot = container.getAndRemoveLast();
textEditor.getTitleView().setText(lastSnapshot.get("title"));
textEditor.getContentView().setText(lastSnapshot.get("content"));
}
}
问题
故事中,上下文类在生成和恢复快照内容时,都需要了解编辑器中的组成部分,比如:从标题视图中获取内容。
这不但使上下文耦合了编辑器的实现细节还耦合了生成与恢复快照的行为,一旦编辑器视图变化或者操作快照的行为有所变化就需要修改依赖它的上下文。
比如说,替换编辑器的视图或者给快照增加创建时间和字数等信息,那么生成和恢复快照的行为就会发送变化。
还有,如果我们要求文本编辑器不能破坏封装,而向外部暴露它的视图以及内容,那应该如何办呢?
所以,有没有一种方式既可以在快照内容变化时不影响上下文类,也可以不破坏封装呢?这便是备忘录模式。
方案
备忘录模式首先通过被称为备忘录(Memento)的POJO对象,将发起者(编辑器)的快照信息封装到这个POJO对象中;
然后由发起者(Originator)封装生成快照以及从快照恢复状态的行为,并对外暴露这两个操作。
这样便将编辑器的状态以及快照的创建和恢复行为统统的封装到了发起者对象中,从而使快照的变化不会影响到外部类也没有破坏发起者对状态的封装。
在备忘录模式中,保存历史快照信息的对象被称之为管理者(CareTaker)。
实现
接下来,我们使用备忘录模式实现一下故事中的程序。
首先,创建一个Memento类,用它来保存发起者的快照信息。
/**备忘录*/
@Data
public class Memento {
protected String title;
protected String content;
}
然后,我们的编辑器TextEditor,需要封装生成快照以及从快照恢复状态的行为。
/**文本编辑器*/
public class TextEditor {
//标题输入框
private TextView titleView;
//内容输入框
private TextView contentView;
/**创建快照*/
public Memento createMemento(){
Memento memento = new Memento();
String title = titleView.getText();
String content = contentView.getText();
memento.setTitle(title);
memento.setContent(content);
return memento;
}
/**从快照恢复状态*/
public void reconvert(Memento memento){
titleView.setText(memento.getTitle());
contentView.setText(memento.getContent());
}
}
现在,我们还有一个快照管理者CareTaker,它负责保存快照并维护快照信息。
/**快照管理者*/
public class CareTaker {
protected List<Memento> mementos = new LinkedList<>();
public void add(Memento memento){
mementos.add(memento);
}
public Memento getAndRemoveLast(){
Memento memento = mementos.remove(0);
return memento;
}
}
最后,让我们在看看上下文对象如何触发编辑器从快照恢复之前的状态。
/**伪代码*/
public class Context {
//编辑内容变化前会触发该方法
public void beforeTextEditorChanging(TextEditor textEditor, CareTaker careTaker) {
Memento memento = textEditor.createMemento();
careTaker.add(memento);
}
//撤销按钮被点击
public void undo(TextEditor textEditor, CareTaker careTaker){
Memento memento = careTaker.getAndRemoveLast();
textEditor.reconvert(memento);
}
}
结构
avatar发起者角色(Originator):它是一个内部状态需要保存的对象,它负责生成快照以及从快照恢复状态。
备忘录角色(Memento):它是一个简单的值对象,存储着发起者某一时刻的快照信息。
管理者角色(caretaker):它是一个快照容器维护着发起者的历史快照信息。
总结
当期望一个状态变化的对象可以恢复到之前的状态时,为了避免保存快照时破坏该对象的封装性,应该考虑使用备忘录模式。
这样不仅不破坏对象的封装性,而且解藕它与上下文之间的耦合,当快照信息变化时可以更容易的维护程序。
最后是题外话,作者认为给这个模式取的名称"备忘录"实在难以让人产生任何有作用的联想,而且其角色的命名更不知所云。
作者建议读者将其理解为快照模式或者相册模式,方便记忆。
网友评论