装饰器模式小总结

最近在工作中遇到这么一个场景：需要根据配置文件，动态地生成一个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("
Auther: 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("
Date: " + 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());
    }
}

运行结果：