设计模式之备忘录模式

一时失言乱红尘 2023-07-13 03:02 66阅读 0赞

### 定义 ###

保存一个对象的某个状态，以便在适当的时候恢复对象。

“后悔药”

### 类型 ###

行为型

### 适用场景 ###

①、保存及恢复数据相关业务场景。  
②、后悔的时候，即想恢复到之前的状态。

### 优缺点 ###

优点：  
①、为用户提供一种可恢复机制。  
②、存档信息的封装。

缺点：  
①、资源占用。

### 代码实现 ###

案例：程序员A在写代码的时候，刚写完一个方法，保存后发现这个方法还可以进行优化，等优化完成之后，准备收工。没想到程序员B说，你的那段代码纵使改得很好，但是为了符合整个框架或者整个公司的 代码风格，建议改回最开始的那个版本，这时候，你肯定要从开发工具的历史中查找之前的版本，进行回退。  
其实写文章和写代码大致相似，不可能说一篇文章不用涂涂改改，就能一气呵成。下面就以写文章为例。  
首先创建一个文章类

public class Article { 
    
        private String title;
        private String content;
        private String image;
    
        public Article(String title, String content, String image) { 
            this.title = title;
            this.content = content;
            this.image = image;
        }
    
        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 getImage() { 
            return image;
        }
    
        public void setImage(String image) { 
            this.image = image;
        }
    
        /** * 保存快照 */
        public ArticleSnapshot saveToSnapshot() { 
            return new ArticleSnapshot(this.title, this.content, this.image);
        }
    
        /** * 撤销操作 */
        public void undoFromSnapshot(ArticleSnapshot articleSnapshot) { 
            this.title = articleSnapshot.getTitle();
            this.content = articleSnapshot.getContent();
            this.image = articleSnapshot.getImage();
        }
    
        @Override
        public String toString() { 
            return "Article{" +
                    "title='" + title + '\'' +
                    ", content='" + content + '\'' +
                    ", image='" + image + '\'' +
                    '}';
        }
    }

里面有三个属性：标题、内容、图片。还提供了两个方法，一个是保存快照、一个是撤销。  
创建一个快照类

public class ArticleSnapshot { 
    
        private String title;
        private String content;
        private String image;
    
        public ArticleSnapshot(String title, String content, String image) { 
            this.title = title;
            this.content = content;
            this.image = image;
        }
    
        public String getTitle() { 
            return title;
        }
    
    
        public String getContent() { 
            return content;
        }
    
        public String getImage() { 
            return image;
        }
    
        @Override
        public String toString() { 
            return "ArticleSnapshot{" +
                    "title='" + title + '\'' +
                    ", content='" + content + '\'' +
                    ", image='" + image + '\'' +
                    '}';
        }
    }

因为快照就是文章的一个版本，所以属性自然和文章中的一样。  
最后创建一个管理文章的工具类

public class ArticleSnapshotManager { 
    
        private final Stack<ArticleSnapshot> ARTICLE_SNAPSHOT_STACK = new Stack<>();
    
        /** * 出栈 */
        public ArticleSnapshot getArticleSnapshot() { 
            return ARTICLE_SNAPSHOT_STACK.pop();
        }
    
        /** * 入栈 */
        public void setArticleSnapshot(ArticleSnapshot articleSnapshot) { 
            ARTICLE_SNAPSHOT_STACK.push(articleSnapshot);
        }
    }

因为栈有“先进后出，后进先出”这个特点，所以它能获取上一个最新的版本。  
编写测试类

public class MainTest { 
    
        public static void main(String[] args) { 
            ArticleSnapshotManager articleSnapshotManager = new ArticleSnapshotManager();
    
            Article article = new Article("Java设计模式-版本(1)", "关于23种设计模式的讲解-版本(1)", "https://qfcwx.com/版本(1)");
            // 保存快照
            ArticleSnapshot articleSnapshot = article.saveToSnapshot();
            // 存档
            articleSnapshotManager.setArticleSnapshot(articleSnapshot);
            System.out.println("标题:" + article.getTitle() + "内容:" + article.getContent() + "图片:" + article.getImage() + "暂存成功");
    
            System.out.println("文章的完整信息" + article);
    
            System.out.println("文章修改--->start");
            article.setTitle("Java设计模式-版本(2)");
            article.setContent("关于23种设计模式的讲解-版本(2)");
            article.setImage("https://qfcwx.com/版本(2)");
            System.out.println("文章修改--->end");
            System.out.println("文章的完整信息" + article);
    
            // 保存快照
            articleSnapshot = article.saveToSnapshot();
            // 存档
            articleSnapshotManager.setArticleSnapshot(articleSnapshot);
    
            article.setTitle("Java设计模式-版本(3)");
            article.setContent("关于23种设计模式的讲解-版本(3)");
            article.setImage("https://qfcwx.com/版本(3)");
    
            System.out.println("存档回退--->start");
            System.out.println("回退出栈1次");
            articleSnapshot = articleSnapshotManager.getArticleSnapshot();
            article.undoFromSnapshot(articleSnapshot);
    
            System.out.println("回退出栈2次");
            articleSnapshot = articleSnapshotManager.getArticleSnapshot();
            article.undoFromSnapshot(articleSnapshot);
    
            System.out.println("存档回退--->end");
            System.out.println("文章的完整信息" + article);
        }
    }

这里对文章进行了三次编辑，存档了两次。就像刚才所说，更改了很多版本，发现只有第一次最好，最适合，想要把它发表出去。这时候就需要进行退档了。从栈里获取上一个版本的内容。  
输出结果：  
![format_png][]

### 相关源码 ###

1. Spring框架中的StateManageableMessageContext

> 参考链接  
> [https://coding.imooc.com/learn/list/270.html][https_coding.imooc.com_learn_list_270.html]

[format_png]: https://imgconvert.csdnimg.cn/aHR0cHM6Ly9maWxlLnFmY3d4LmNvbS9kZXNpZ24tcGF0dGVybi8lRTUlQTQlODclRTUlQkYlOTglRTUlQkQlOTUlRTYlQTglQTElRTUlQkMlOEYvJUU1JUE0JTg3JUU1JUJGJTk4JUU1JUJEJTk1JUU2JUE4JUExJUU1JUJDJThGLmpwZw?x-oss-process=image/format,png
[https_coding.imooc.com_learn_list_270.html]: https://coding.imooc.com/learn/list/270.html