Builder模式就像盖楼,将一个一个楼层组装为一栋楼

Builder模式


在建造大楼时,需要先打牢地基,搭建框架,然后自下而上地一层一层盖起来。通常,在建造
这种具有复杂结构的物体时,很难一气呵成。我们需要首先建造组成这个物体的各个部分,然后分
阶段将它们组装起来。

Builder模式就是这样,组成一个类的各个部分,再组装起来。

示例程序


这个示例将编写一个文档,其有以下特性:

  • 含有一个标题
  • 含有几个字符串
  • 含有条目项目

Builder类中定义了决定文档结构的方法,Director类使用该方法编写一个具体的文档。

类的一览表:

名字说明
Builder定义了决定文档结构的抽象类
Director编写1个文档的类
TextBuilder使用纯文本(普通字符串)编写文档的类
HTMLBuilder使用HTML编写文档的类
Main测试程序行为的类

示例程序的类图:

Builder类

作为一个声明了编写文档的方法的抽象类。

public abstract class Builder {  
    public abstract void makeTitle(String title);  
    public abstract void makeString(String str);  
    public abstract void makeItems(String[] items);  
    public abstract void close();  
}

Director类

Director类使用Builder类中声明的方法来编写文档。

Director类的构造方法的参数为Builder类型。但实际上我们不会将==Builder类的实例==作为参数传给Director类。因为Builder类是抽象类,是无法生成其实例的。实际上传递给Director类的是==Builder类的子类==。

public class Director {
    private Builder builder;

    public Director(Builder builder) {
        this.builder = builder;
    }

    public void construct() {
        builder.makeTitle("Greeting");
        builder.makeString("从早上至下午");
        builder.makeItems(new String[]{
                "早上好。",
                "下午好。",
        });
        builder.makeString("晚上");
        builder.makeItems(new String[]{
                "晚上好。",
                "晚安。",
                "再见。"
        });
        builder.close();
    }
}

TextBuilder

TextBuilder作为Builder的子类,实现了其方法,同时加入了方法 getResult,其可以作为Director构造函数的参数。

public class TextBuilder extends Builder {
    private StringBuffer buffer = new StringBuffer();

    @Override
    public void makeTitle(String title) {
        buffer.append("==============================\n");
        buffer.append("「").append(title).append("」");
        buffer.append("\n");
    }

    @Override
    public void makeString(String str) {
        buffer.append("■").append(str).append("\n");
        ;
        buffer.append("\n");
    }

    @Override
    public void makeItems(String[] items) {
        for (String item : items) buffer.append(" ·").append(item).append("\n");
        buffer.append("\n");
    }

    @Override
    public void close() {
        buffer.append("==============================\n");
    }

    public String getResult() {
        return buffer.toString();
    }
}

HTMLBuilder

同上

public class HTMLBuilder extends Builder {
    private String filename;
    private PrintWriter writer;

    @Override
    public void makeTitle(String title) {
        filename = title + ".html";
        try {
            writer = new PrintWriter(new FileWriter(filename));
        } catch (IOException e) {
            e.printStackTrace();
        }
        writer.println("<html><head><title>" + title + "</title></head><body>");
        writer.println("<h1>" + title + "</h1>");
    }

    @Override
    public void makeString(String str) {
        writer.println("<p>" + str + "</p>");
    }

    @Override
    public void makeItems(String[] items) {
        writer.println("<ul>");
        for (String item : items) writer.println("<li>" + item + "</li>");
        writer.println("</ul>");
    }

    @Override
    public void close() {
        writer.println("</body></html>");
        writer.close();
    }

    public String getResult() {
        return filename;
    }
}

Main

public class Main {  
    public static void main(String[] args) {  
        if (args.length != 1) {  
            System.exit(0);  
        }  
        if (args[0].equals("plain")) {  
            TextBuilder textBuilder = new TextBuilder();  
            Director director = new Director(textBuilder);  
            director.construct();  
            String result = textBuilder.getResult();  
            System.out.println(result);  
        } else if (args[0].equals("html")) {  
            HTMLBuilder htmlBuilder = new HTMLBuilder();  
            Director director = new Director(htmlBuilder);  
            director.construct();  
            String filename = htmlBuilder.getResult();  
            System.out.println(filename + "文件编写完成。");  
        } else {  
            System.exit(0);  
        }  
    }  
}

此示例程序需要打包成jar包来提供参数:

打包过程演示(maven环境不一定要):

登场角色


Builder模式中,有以下登场角色:

  • Builder(建造者)
    • 负责定义用于生成实例的接口(API)。Builder角色中准备用于生成实例的方法。
  • ConcreteBuilder(具体的建造者)
    • 负责实现Builder接口的类。此外还可以自定义方法。
  • Director(监工)
    • 负责使用Builder角色的接口来生成实例。它不依赖ConcreteBuilder。它只调用在Builder中被定义的方法
  • Client(使用者)
    • 如示例程序中的Main

Builder模式类图:

时序图:

练习题


请将示例程序中的Builder类(代码清单7-1)修改为接口并相应地修改其他类。

直接修改即可。

在示例程序中的HTMLBuilder类(代码清单7-4)中,需要首先调用makeTitle方法,但是在TextBuilder类(代码清单7-3)中,则对方法调用的顺序没有要求。
请修改Builder类(代码清单7-1)、TextBuilder类(代码清单7-3)和HTMLBuilder类(代码清单7-4),确保“在调用makeString方法、makeItems方法和close方法之前必须且只能调用一次makeTitle方法”。

Builder

public abstract class Builder {  
    private boolean initialized = false;  
    public void makeTitle(String title) {  
        if (!initialized) {  
            buildTitle(title);  
            initialized = true;  
        }  
    }  
  
    public void makeString(String str) {  
        if (initialized) buildString(str);  
    }  
  
    public void makeItems(String[] items) {  
        if (initialized) buildItems(items);  
    }  
    public void close() {  
        if (initialized) buildDone();  
    }  
  
    protected abstract void buildTitle(String title);  
  
    protected abstract void buildString(String str);  
  
    protected abstract void buildItems(String[] items);  
  
    protected abstract void buildDone();  
}

HTMLBuilder

public class HTMLBuilder extends Builder {  
    private String filename;  
    private PrintWriter writer;  
  
    @Override  
    protected void buildTitle(String title) {  
        filename = title + ".html";  
        try {  
            writer = new PrintWriter(new FileWriter(filename));  
        } catch (IOException e) {  
            e.printStackTrace();  
        }  
        writer.println("<html><head><title>" + title + "</title></head><body>");  
        writer.println("<h1>" + title + "</h1>");  
    }  
  
    @Override  
    protected void buildString(String str) {  
        writer.println("<p>" + str + "</p>");  
    }  
  
    @Override  
    protected void buildItems(String[] items) {  
        writer.println("<ul>");  
        for (String item : items) writer.println("<li>" + item + "</li>");  
        writer.println("</ul>");  
    }  
  
    @Override  
    protected void buildDone() {  
        writer.println("</body></html>");  
        writer.close();  
    }  
  
    public String getResult() {  
        return filename;  
    }  
}

TextBuilder

public class TextBuilder extends Builder {  
    private StringBuffer buffer = new StringBuffer();  
  
    @Override  
    protected void buildTitle(String title) {  
        buffer.append("==============================\n");  
        buffer.append("「").append(title).append("」");  
        buffer.append("\n");  
    }  
  
    @Override  
    protected void buildString(String str) {  
        buffer.append("■").append(str).append("\n");  
        ;        buffer.append("\n");  
    }  
  
    @Override  
    protected void buildItems(String[] items) {  
        for (String item : items) buffer.append(" ·").append(item).append("\n");  
        buffer.append("\n");  
    }  
  
    @Override  
    protected void buildDone() {  
        buffer.append("==============================\n");  
    }  
  
    public String getResult() {  
        return buffer.toString();  
    }  
}