23种设计模式（15）：备忘录模式

文章来源：http://blog.csdn.net/zhengzhb/article/details/7697549

定义：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样就可以将该对象恢复到原先保存的状态

类型：行为类

类图：

我们在编程的时候，经常需要保存对象的中间状态，当需要的时候，可以恢复到这个状态。比如，我们使用Eclipse进行编程时，假如编写失误（例如不小心误删除了几行代码），我们希望返回删除前的状态，便可以使用Ctrl+Z来进行返回。这时我们便可以使用备忘录模式来实现。

备忘录模式的结构

• 发起人：记录当前时刻的内部状态，负责定义哪些属于备份范围的状态，负责创建和恢复备忘录数据。
• 备忘录：负责存储发起人对象的内部状态，在需要的时候提供发起人需要的内部状态。
• 管理角色：对备忘录进行管理，保存和提供备忘录。

通用代码实现

[java] view plain copy

1. classOriginator{
2. privateStringstate="";
4. publicStringgetState(){
5. returnstate;
6. }
7. publicvoidsetState(Stringstate){
8. this.state=state;
9. }
10. publicMementocreateMemento(){
11. returnnewMemento(this.state);
12. }
13. publicvoidrestoreMemento(Mementomemento){
14. this.setState(memento.getState());
15. }
16. }
18. classMemento{
19. privateStringstate="";
20. publicMemento(Stringstate){
21. this.state=state;
22. }
23. publicStringgetState(){
24. returnstate;
25. }
26. publicvoidsetState(Stringstate){
27. this.state=state;
28. }
29. }
30. classCaretaker{
31. privateMementomemento;
32. publicMementogetMemento(){
33. returnmemento;
34. }
35. publicvoidsetMemento(Mementomemento){
36. this.memento=memento;
37. }
38. }
39. publicclassClient{
40. publicstaticvoidmain(String[]args){
41. Originatororiginator=newOriginator();
42. originator.setState("状态1");
43. System.out.println("初始状态:"+originator.getState());
44. Caretakercaretaker=newCaretaker();
45. caretaker.setMemento(originator.createMemento());
46. originator.setState("状态2");
47. System.out.println("改变后状态:"+originator.getState());
48. originator.restoreMemento(caretaker.getMemento());
49. System.out.println("恢复后状态:"+originator.getState());
50. }
51. }

代码演示了一个单状态单备份的例子，逻辑非常简单：Originator类中的state变量需要备份，以便在需要的时候恢复；Memento类中，也有一个state变量，用来存储Originator类中state变量的临时状态；而Caretaker类就是用来管理备忘录类的，用来向备忘录对象中写入状态或者取回状态。

多状态多备份备忘录

通用代码演示的例子中，Originator类只有一个state变量需要备份，而通常情况下，发起人角色通常是一个javaBean，对象中需要备份的变量不止一个，需要备份的状态也不止一个，这就是多状态多备份备忘录。实现备忘录的方法很多，备忘录模式有很多变形和处理方式，像通用代码那样的方式一般不会用到，多数情况下的备忘录模式，是多状态多备份的。其实实现多状态多备份也很简单，最常用的方法是，我们在Memento中增加一个Map容器来存储所有的状态，在Caretaker类中同样使用一个Map容器才存储所有的备份。下面我们给出一个多状态多备份的例子：

[java] view plain copy

1. classOriginator{
2. privateStringstate1="";
3. privateStringstate2="";
4. privateStringstate3="";
6. publicStringgetState1(){
7. returnstate1;
8. }
9. publicvoidsetState1(Stringstate1){
10. this.state1=state1;
11. }
12. publicStringgetState2(){
13. returnstate2;
14. }
15. publicvoidsetState2(Stringstate2){
16. this.state2=state2;
17. }
18. publicStringgetState3(){
19. returnstate3;
20. }
21. publicvoidsetState3(Stringstate3){
22. this.state3=state3;
23. }
24. publicMementocreateMemento(){
25. returnnewMemento(BeanUtils.backupProp(this));
26. }
28. publicvoidrestoreMemento(Mementomemento){
29. BeanUtils.restoreProp(this,memento.getStateMap());
30. }
31. publicStringtoString(){
32. return"state1="+state1+"state2="+state2+"state3="+state3;
33. }
34. }
35. classMemento{
36. privateMap<String,Object>stateMap;
38. publicMemento(Map<String,Object>map){
39. this.stateMap=map;
40. }
42. publicMap<String,Object>getStateMap(){
43. returnstateMap;
44. }
46. publicvoidsetStateMap(Map<String,Object>stateMap){
47. this.stateMap=stateMap;
48. }
49. }
50. classBeanUtils{
51. publicstaticMap<String,Object>backupProp(Objectbean){
52. Map<String,Object>result=newHashMap<String,Object>();
53. try{
54. BeanInfobeanInfo=Introspector.getBeanInfo(bean.getClass());
55. PropertyDescriptor[]descriptors=beanInfo.getPropertyDescriptors();
56. for(PropertyDescriptordes:descriptors){
57. StringfieldName=des.getName();
58. Methodgetter=des.getReadMethod();
59. ObjectfieldValue=getter.invoke(bean,newObject[]{});
60. if(!fieldName.equalsIgnoreCase("class")){
61. result.put(fieldName,fieldValue);
62. }
63. }
65. }catch(Exceptione){
66. e.printStackTrace();
67. }
68. returnresult;
69. }
71. publicstaticvoidrestoreProp(Objectbean,Map<String,Object>propMap){
72. try{
73. BeanInfobeanInfo=Introspector.getBeanInfo(bean.getClass());
74. PropertyDescriptor[]descriptors=beanInfo.getPropertyDescriptors();
75. for(PropertyDescriptordes:descriptors){
76. StringfieldName=des.getName();
77. if(propMap.containsKey(fieldName)){
78. Methodsetter=des.getWriteMethod();
79. setter.invoke(bean,newObject[]{propMap.get(fieldName)});
80. }
81. }
82. }catch(Exceptione){
83. e.printStackTrace();
84. }
85. }
86. }
87. classCaretaker{
88. privateMap<String,Memento>memMap=newHashMap<String,Memento>();
89. publicMementogetMemento(Stringindex){
90. returnmemMap.get(index);
91. }
93. publicvoidsetMemento(Stringindex,Mementomemento){
94. this.memMap.put(index,memento);
95. }
96. }
97. classClient{
98. publicstaticvoidmain(String[]args){
99. Originatorori=newOriginator();
100. Caretakercaretaker=newCaretaker();
101. ori.setState1("中国");
102. ori.setState2("强盛");
103. ori.setState3("繁荣");
104. System.out.println("===初始化状态===\n"+ori);
106. caretaker.setMemento("001",ori.createMemento());
107. ori.setState1("软件");
108. ori.setState2("架构");
109. ori.setState3("优秀");
110. System.out.println("===修改后状态===\n"+ori);
112. ori.restoreMemento(caretaker.getMemento("001"));
113. System.out.println("===恢复后状态===\n"+ori);
114. }
115. }

备忘录模式的优缺点和适用场景

备忘录模式的优点有：

• 当发起人角色中的状态改变时，有可能这是个错误的改变，我们使用备忘录模式就可以把这个错误的改变还原。
• 备份的状态是保存在发起人角色之外的，这样，发起人角色就不需要对各个备份的状态进行管理。

备忘录模式的缺点：

• 在实际应用中，备忘录模式都是多状态和多备份的，发起人角色的状态需要存储到备忘录对象中，对资源的消耗是比较严重的。

如果有需要提供回滚操作的需求，使用备忘录模式非常适合，比如jdbc的事务操作，文本编辑器的Ctrl+Z恢复等。

文章来源：http://blog.csdn.net/zhengzhb/article/details/7697549

定义：在不破坏封装性的前提下，捕获一个对象的内部状态，并在该对象之外保存这个状态。这样就可以将该对象恢复到原先保存的状态

类型：行为类

类图：

我们在编程的时候，经常需要保存对象的中间状态，当需要的时候，可以恢复到这个状态。比如，我们使用Eclipse进行编程时，假如编写失误（例如不小心误删除了几行代码），我们希望返回删除前的状态，便可以使用Ctrl+Z来进行返回。这时我们便可以使用备忘录模式来实现。

备忘录模式的结构

• 发起人：记录当前时刻的内部状态，负责定义哪些属于备份范围的状态，负责创建和恢复备忘录数据。
• 备忘录：负责存储发起人对象的内部状态，在需要的时候提供发起人需要的内部状态。
• 管理角色：对备忘录进行管理，保存和提供备忘录。

通用代码实现

[java] view plain copy

1. classOriginator{
2. privateStringstate="";
4. publicStringgetState(){
5. returnstate;
6. }
7. publicvoidsetState(Stringstate){
8. this.state=state;
9. }
10. publicMementocreateMemento(){
11. returnnewMemento(this.state);
12. }
13. publicvoidrestoreMemento(Mementomemento){
14. this.setState(memento.getState());
15. }
16. }
18. classMemento{
19. privateStringstate="";
20. publicMemento(Stringstate){
21. this.state=state;
22. }
23. publicStringgetState(){
24. returnstate;
25. }
26. publicvoidsetState(Stringstate){
27. this.state=state;
28. }
29. }
30. classCaretaker{
31. privateMementomemento;
32. publicMementogetMemento(){
33. returnmemento;
34. }
35. publicvoidsetMemento(Mementomemento){
36. this.memento=memento;
37. }
38. }
39. publicclassClient{
40. publicstaticvoidmain(String[]args){
41. Originatororiginator=newOriginator();
42. originator.setState("状态1");
43. System.out.println("初始状态:"+originator.getState());
44. Caretakercaretaker=newCaretaker();
45. caretaker.setMemento(originator.createMemento());
46. originator.setState("状态2");
47. System.out.println("改变后状态:"+originator.getState());
48. originator.restoreMemento(caretaker.getMemento());
49. System.out.println("恢复后状态:"+originator.getState());
50. }
51. }

代码演示了一个单状态单备份的例子，逻辑非常简单：Originator类中的state变量需要备份，以便在需要的时候恢复；Memento类中，也有一个state变量，用来存储Originator类中state变量的临时状态；而Caretaker类就是用来管理备忘录类的，用来向备忘录对象中写入状态或者取回状态。

多状态多备份备忘录

通用代码演示的例子中，Originator类只有一个state变量需要备份，而通常情况下，发起人角色通常是一个javaBean，对象中需要备份的变量不止一个，需要备份的状态也不止一个，这就是多状态多备份备忘录。实现备忘录的方法很多，备忘录模式有很多变形和处理方式，像通用代码那样的方式一般不会用到，多数情况下的备忘录模式，是多状态多备份的。其实实现多状态多备份也很简单，最常用的方法是，我们在Memento中增加一个Map容器来存储所有的状态，在Caretaker类中同样使用一个Map容器才存储所有的备份。下面我们给出一个多状态多备份的例子：

[java] view plain copy

1. classOriginator{
2. privateStringstate1="";
3. privateStringstate2="";
4. privateStringstate3="";
6. publicStringgetState1(){
7. returnstate1;
8. }
9. publicvoidsetState1(Stringstate1){
10. this.state1=state1;
11. }
12. publicStringgetState2(){
13. returnstate2;
14. }
15. publicvoidsetState2(Stringstate2){
16. this.state2=state2;
17. }
18. publicStringgetState3(){
19. returnstate3;
20. }
21. publicvoidsetState3(Stringstate3){
22. this.state3=state3;
23. }
24. publicMementocreateMemento(){
25. returnnewMemento(BeanUtils.backupProp(this));
26. }
28. publicvoidrestoreMemento(Mementomemento){
29. BeanUtils.restoreProp(this,memento.getStateMap());
30. }
31. publicStringtoString(){
32. return"state1="+state1+"state2="+state2+"state3="+state3;
33. }
34. }
35. classMemento{
36. privateMap<String,Object>stateMap;
38. publicMemento(Map<String,Object>map){
39. this.stateMap=map;
40. }
42. publicMap<String,Object>getStateMap(){
43. returnstateMap;
44. }
46. publicvoidsetStateMap(Map<String,Object>stateMap){
47. this.stateMap=stateMap;
48. }
49. }
50. classBeanUtils{
51. publicstaticMap<String,Object>backupProp(Objectbean){
52. Map<String,Object>result=newHashMap<String,Object>();
53. try{
54. BeanInfobeanInfo=Introspector.getBeanInfo(bean.getClass());
55. PropertyDescriptor[]descriptors=beanInfo.getPropertyDescriptors();
56. for(PropertyDescriptordes:descriptors){
57. StringfieldName=des.getName();
58. Methodgetter=des.getReadMethod();
59. ObjectfieldValue=getter.invoke(bean,newObject[]{});
60. if(!fieldName.equalsIgnoreCase("class")){
61. result.put(fieldName,fieldValue);
62. }
63. }
65. }catch(Exceptione){
66. e.printStackTrace();
67. }
68. returnresult;
69. }
71. publicstaticvoidrestoreProp(Objectbean,Map<String,Object>propMap){
72. try{
73. BeanInfobeanInfo=Introspector.getBeanInfo(bean.getClass());
74. PropertyDescriptor[]descriptors=beanInfo.getPropertyDescriptors();
75. for(PropertyDescriptordes:descriptors){
76. StringfieldName=des.getName();
77. if(propMap.containsKey(fieldName)){
78. Methodsetter=des.getWriteMethod();
79. setter.invoke(bean,newObject[]{propMap.get(fieldName)});
80. }
81. }
82. }catch(Exceptione){
83. e.printStackTrace();
84. }
85. }
86. }
87. classCaretaker{
88. privateMap<String,Memento>memMap=newHashMap<String,Memento>();
89. publicMementogetMemento(Stringindex){
90. returnmemMap.get(index);
91. }
93. publicvoidsetMemento(Stringindex,Mementomemento){
94. this.memMap.put(index,memento);
95. }
96. }
97. classClient{
98. publicstaticvoidmain(String[]args){
99. Originatorori=newOriginator();
100. Caretakercaretaker=newCaretaker();
101. ori.setState1("中国");
102. ori.setState2("强盛");
103. ori.setState3("繁荣");
104. System.out.println("===初始化状态===\n"+ori);
106. caretaker.setMemento("001",ori.createMemento());
107. ori.setState1("软件");
108. ori.setState2("架构");
109. ori.setState3("优秀");
110. System.out.println("===修改后状态===\n"+ori);
112. ori.restoreMemento(caretaker.getMemento("001"));
113. System.out.println("===恢复后状态===\n"+ori);
114. }
115. }

备忘录模式的优缺点和适用场景

备忘录模式的优点有：

• 当发起人角色中的状态改变时，有可能这是个错误的改变，我们使用备忘录模式就可以把这个错误的改变还原。
• 备份的状态是保存在发起人角色之外的，这样，发起人角色就不需要对各个备份的状态进行管理。

备忘录模式的缺点：

• 在实际应用中，备忘录模式都是多状态和多备份的，发起人角色的状态需要存储到备忘录对象中，对资源的消耗是比较严重的。

如果有需要提供回滚操作的需求，使用备忘录模式非常适合，比如jdbc的事务操作，文本编辑器的Ctrl+Z恢复等。