裝飾器模式小總結

最近在工作中遇到這么一個場景：需要根據配置文件，動態地生成一個Excel模板。模板有首頁，內容頁，鏈接頁等幾個頁簽。

工頭，哦不，老大指導可以使用裝飾器模式，於是我就學習了一下，就有這篇文章。

初涉設計模式，請大牛們鞭撻。

1. 什么是裝飾器模式

裝飾模式能夠實現動態的為對象添加功能，是從一個對象外部來給對象添加功能。通常給對象添加功能，要么直接修改對象添加相應的功能，要么派生對應的子類來擴展，抑或是使用對象組合的方式。顯然，直接修改對應的類這種方式並不可取。在面向對象的設計中，而我們也應該盡量使用對象組合，而不是對象繼承來擴展和復用功能。裝飾器模式就是基於對象組合的方式，可以很靈活的給對象添加所需要的功能。裝飾器模式的本質就是動態組合。動態是手段，組合才是目的。總之，裝飾模式是通過把復雜的功能簡單化，分散化，然后再運行期間，根據需要來動態組合的這樣一個模式。

是的，以上是抄的。

注意上文說的兩點，簡單化，動態組合。

簡單來說，就是在添加功能的情況下，又不失靈活，比如上面說到的生成Excel模板，如果以后想把鏈接頁放到內容頁前面，那么只需要調整一下組合的順序，就可以實現了，不用把它的實現代碼大段地拷貝過去。

 

2.裝飾器的結構

抽象構件（component）角色 ：這個角色用來規范被裝飾的對象，一般用接口方式給出。

具體構件（concrete  component ）角色 ：被裝飾的類。

裝飾（decorator）角色 ：持有一個構件對象的實例。並定義一個跟抽象構件一致的接口。

具體 （concrete    decorator   ） 裝飾角色 ：負責給具體構件添加附加職責的類。在實際使用中多數情況下裝飾角色和具體裝飾角色可能由一個類來承擔。

 

這個結構中最關鍵的是，裝飾角色持有一個構件對象的實例。這樣，需要裝飾的實例，才能夠傳入到裝飾器中，讓裝飾器對其進行裝飾。同時，在多個裝飾器共同裝飾的情況下，還可以把前面的裝飾器傳入到后面的裝飾器中，由最后的裝飾器調用動作。因為它們實現了同樣的接口，這樣做是允許的。

例如：對象A，需要裝飾器A,B進行裝飾。那么，可以把A傳給裝飾器A，裝飾后，再把A傳給裝飾器B，繼續裝飾。也可以把A傳給裝飾器A之后，再把裝飾器A傳給裝飾器B，由B完成所有的裝飾動作（實際上只是調用了A的裝飾動作，具體實現仍是在裝飾器A當中）。

有同學可能會有疑問了，使用裝飾器模式，要求被裝飾的類型必須和裝飾器的類型，實現相同的接口，具有相同的公有方法。對於已經定義好的類型，怎么能做到裝飾呢？

比如上面說的場景，對Excel文件進行裝飾，一般我們使用POI的開源包，Excel文件對應HSSFWorkBook類型，那么，是不是我們也要去實現HSSFWorkBook實現的接口WorkBook？那WorkBook接口里面沒有我們想要的裝飾方法聲明怎么辦？不就用不了了？

實際上這種場景，仍然可以使用裝飾器模式，方法就是將WorkBook類型封裝到具體構件的角色里，並提供get方法。這樣裝飾器得到具體構件后，就可以通過get方法獲取到真正需要裝飾的對象了（在下面的例子中，我將使用StringBuilder類型，原理是一樣的）

3. 一個小例子

嗯，是不是看懵逼了？沒關系，我們用上面的生成模板的場景，實踐一下。

首先，定義一個抽象構件

package com.khlin.test;

/**
 * 模板文件類型。包裝了文件的內容，{@link #fillContent()} 用於填充內容
 * @author Kingsley
 *
 */
public interface TemplateFile {
    
    StringBuilder getContent();
    
    void fillContent();
}

定義具體構件，即被裝飾的類

package com.khlin.test;

public class ImportTemplateFile implements TemplateFile {

    StringBuilder content = new StringBuilder();
    
    public ImportTemplateFile() {
        content.append("Title: this is an import template.");
    }
    
    @Override
    public StringBuilder getContent() {
        return this.content;
    }

    @Override
    public void fillContent() {
        System.out.println("ImportTemplateFile: i will do nothing.");
    }

}

 

第三步，定義一個裝飾器角色。通常是一個抽象類，同時持有第一步抽象構件的一個實例，這是關鍵。

package com.khlin.test;

public abstract class FileDecorator implements TemplateFile {

    TemplateFile templateFile;

    public FileDecorator(TemplateFile templateFile) {
        this.templateFile = templateFile;
    }
}

最后一步，實現兩個具體的裝飾器

package com.khlin.test;

public class FileAutherDecorator extends FileDecorator {

    public FileAutherDecorator(TemplateFile templateFile) {
        super(templateFile);
    }

    @Override
    public StringBuilder getContent() {
        return this.templateFile.getContent();
    }

    @Override
    public void fillContent() {
        //先用上一個裝飾器處理，再用自己的邏輯處理
        this.templateFile.fillContent();
        
        StringBuilder content = this.templateFile.getContent();
        content.append("\r\nAuther: kingsley");
    }

}

package com.khlin.test;

import java.util.Date;

public class FileDateDecorator extends FileDecorator{

    public FileDateDecorator(TemplateFile templateFile) {
        super(templateFile);
    }

    @Override
    public StringBuilder getContent() {
        return templateFile.getContent();
    }

    @Override
    public void fillContent() {
        //先用上一個裝飾器處理，再用自己的邏輯處理
        this.templateFile.fillContent();
        
        StringBuilder content = this.templateFile.getContent();
        content.append("\r\nDate: " + new Date(System.currentTimeMillis()));
    }

}

最后，我們來運行一下

package com.khlin.test;

public class App {
    public static void main(String[] args) {
        TemplateFile file = new ImportTemplateFile();

        // 把要裝飾的對象傳給裝飾器
        TemplateFile dateDecorator = new FileDateDecorator(file);

        /**
         * 這里可以有兩種做法。
         * 第一種是先調用dateDecorator.fillContent()，先進行裝飾，然后再把file傳給autherDecorator
         * ，由它繼續裝飾。 第二種是把dateDecorator作為參數傳給autherDecorator，由后者一次性地全部裝飾。
         * 這里采用第二種。選用這種，要保證在裝飾器的裝飾方法里面，顯式地調用傳入參數的裝飾方法。
         */
        TemplateFile autherDecorator = new FileAutherDecorator(dateDecorator);

        autherDecorator.fillContent();

        System.out.println(autherDecorator.getContent());
    }
}

 

運行結果：