Java設計模式之備忘錄模式

更新時間：2022年10月17日 08:46:19 作者：tianClassmate

這篇文章介紹了Java設計模式之備忘錄模式，文中通過示例代碼介紹的非常詳細。對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

無論是我們在使用word還是記事本，系統(tǒng)都會為我們提供撤銷的功能，這幾乎是人人都會使用到的功能，而在我們實際開發(fā)中，會不會存在一個很復雜的對象，當更改了其中的某一個屬性以后，也提供撤銷的功能，可以快速恢復到更新前的狀態(tài)。提供該功能的模式也正是今天的主題——備忘錄模式。

一、概念理解

書上備忘錄的解釋是，在不破壞封裝的前提下，捕獲一個對象的內(nèi)部狀態(tài)，并在該對象之外保存這個狀態(tài)，這樣可以在以后將對象恢復到原先保存的狀態(tài)。

其實也就是在一個對象之外再額外的增加一個副本對象，每當我們在對象上更改一些屬性以后就構(gòu)建一個副本，并把副本存放在一個隊列中，每當回退該對象的時候就從副本中恢復數(shù)據(jù)。

很顯然需要三個角色：原對象、副本對象、存放副本的隊列。

也即書上的三個角色定義：

Originator（發(fā)起人角色）：負責創(chuàng)建一個備忘錄，記錄自身需要保存的狀態(tài)，具備狀態(tài)回滾功能；即原對象。

Memento（備忘錄角色)：用于存儲Originator的內(nèi)部狀態(tài)，且可以防止Originator以外的對象進行訪問；即副本對象。

Caretaker（管理員角色）：負責存儲、提供管理Memento，無法對Memento的內(nèi)容進行操作和訪問；也即存放副本的隊列。

為了讓概念落地，我們基于備忘錄模式的思想實現(xiàn)視頻草稿箱的功能。

在這個業(yè)務場景中，發(fā)起人其實就是編輯視頻的編輯器，在這個編輯器中我們能干啥呢？編輯視頻、從草稿箱導入、保存到草稿箱。這不是就是發(fā)起人角色的作用嗎！我們稱為編輯草稿。

備忘錄那不就是草稿修改后嗎，我們稱之為完稿。

完稿做好了，要存放到一個列表中用于我們快速修復，那當然就是管理員角色。

基于三個角色我們實現(xiàn)代碼。

二、案例實現(xiàn)

備忘錄角色（完稿）：

就是個基礎對象，用于存儲數(shù)據(jù)，視頻包含的屬性主要是，標題、封面、視頻地址

/**
 * 備忘錄（完稿）
 * @author tcy
 * @Date 16-09-2022
 */
public class VideoMemento {
    private String title;
    private String videoUrl;
    private String imgs;

    public VideoMemento(String title, String content, String imgs) {
        this.title = title;
        this.videoUrl = content;
        this.imgs = imgs;
    }

    public String getTitle() {
        return title;
    }

    public String getContent() {
        return videoUrl;
    }

    public String getImgs() {
        return imgs;
    }

    @Override
    public String toString() {
        return "ArticleMemento{" +
                "title='" + title + '\'' +
                ", content='" + videoUrl + '\'' +
                ", imgs='" + imgs + '\'' +
                '}';
    }
}

發(fā)起人角色（編輯草稿）：

在基本對象之上，增加保存和撤銷的操作，可以看到和我們定義的完稿長的一樣，只是又增了saveToMemento()方法和undoFromMemento()方法，用于保存和撤銷。

/**
 * 發(fā)起人 （草稿）
 * @author tcy
 * @Date 16-09-2022
 */
public class Editor {
    private String title;
    private String videoUrl;
    private String imgs;

    public Editor(String title, String videoUrl, String imgs) {
        this.title = title;
        this.videoUrl = videoUrl;
        this.imgs = imgs;
    }

    public String getTitle() {
        return title;
    }

    public String getContent() {
        return videoUrl;
    }

    public String getImgs() {
        return imgs;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public void setContent(String content) {
        this.videoUrl = content;
    }

    public void setImgs(String imgs) {
        this.imgs = imgs;
    }

    /**
     *  保存到備忘錄
     * @return
     */
    public VideoMemento saveToMemento(){
        VideoMemento articleMemento = new VideoMemento(this.title,this.videoUrl,this.imgs);
        return articleMemento;
    }

    /**
     * 從備忘錄恢復
     * @param articleMemento
     */
    public void undoFromMemento(VideoMemento articleMemento){
        this.title = articleMemento.getTitle();
        this.videoUrl = articleMemento.getContent();
        this.imgs = articleMemento.getImgs();
    }

    @Override
    public String toString() {
        return "Editor{" +
                "title='" + title + '\'' +
                ", content='" + videoUrl + '\'' +
                ", imgs='" + imgs + '\'' +
                '}';
    }
}

管理員角色（草稿箱）：

包括一個棧，用于存儲完稿，利用棧先進后出的特性，實現(xiàn)逐步的撤銷。

/**
 * 管理者（草稿箱）
 * @author tcy
 * @Date 16-09-2022
 */
public class Caretaker {
    private final Stack<VideoMemento> STACK = new Stack<VideoMemento>();

    public VideoMemento getMemento(){
        VideoMemento videoMemento = STACK.pop();
        return videoMemento;
    }

    public void addMemento(VideoMemento videoMemento){
        STACK.push(videoMemento);
    }
}

讀者可以拉取完整代碼到本地進行學習，實現(xiàn)代碼均測試通過后上傳到碼云，本地下載。