示例程序
使用Builder模式编写“文档”的程序。这里编写出的文档结构如下:
- 含有一个标题
- 含有几个字符串
- 含有条目项目
Builder类中定义了决定文档结构的方法,然后Director类使用该方法编写一个具体的文档。
Builder是抽象类,它并没有进行任何实际的处理,仅声明了抽象方法。Builder类的子类决定了用来编写文档的具体出里。
/*
* Builder声明了编写文档方法的抽象类。makeTitle、makeString、makeItems
* 方法分别是编写标题、字符串、条目方法。close是完成文档编写*/
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类使用Builder类中声明的方法来编写文档。
* Director构造函数传入的参数是Builder类型,但是参数是Builder的子类
* construct方法是编写文档,所调用的方法都是在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();
}
}
import java.io.*;
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) {
// TODO Auto-generated catch block
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(int i=0;i<items.length;i++) {
writer.println("<li>"+items[i]+"</li>");
}
writer.println("</ul>");
}
@Override
public void close() {
writer.println("</body></html>");
writer.close();
}
public String getResult() {
return filename;
}
}
/*
* 功能是纯文本编写,并以String方式返回*/
public class TextBuilder extends Builder{
private StringBuilder buffer=new StringBuilder();
@Override
public void makeTitle(String title) {
buffer.append("==================\n");
buffer.append("["+title+"]\n");
buffer.append("\n");
}
@Override
public void makeString(String str) {
buffer.append('*'+str+"\n");
buffer.append("\n");
}
@Override
public void makeItems(String[] items) {
for(int i=0;i<items.length;i++) {
buffer.append(" ."+items[i]+"\n");
}
buffer.append("\n");
}
@Override
public void close() {
buffer.append("=======================\n");
}
public String getResult() {
return buffer.toString();
}
}
public class Main {
public static void main(String[] args) {
if(args.length!=1) {
usage();
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 {
usage();
System.exit(0);
}
}
private static void usage() {
System.out.println("Usage: java Main plain 纯文本编辑");
System.out.println("Usage: java Main html 编写HTML文档");
}
}
Builder模式中的登场角色
*Builder(建造者)
Builder角色负责定义用于生成实例的接口。Builder角色中准备了用于生成实例的方法。在示例程序中Builder就是扮演此角色。
ConcreteBuilder(具体创建者)
ConcreteBuilder角色是负责实现Builder角色的接口的类。这里定义了在生成实例时实际被调用的方法此外ConcreteBuilder角色中还定义了最终生成结果的方法。在示例程序中TextBuilder和HTMLBuilder就是扮演次角色。
Director(监工)
Director角色负责使用Builder的接口来生成实例。它并不依赖与ConcreteBuilder角色。为了保证不论ConcreteBuilder角色是如何被定义的,Director角色都能正常工作,它只调用在Builder中的定义的方法。在示例程序中Direcctor类扮演此角色。
Client(使用者)
该角色使用了Builder模式。在示例程序中Main扮演此角色。
谁知道??
Main类并不知道(没有调用)Builder类,它只调用了Director类的construct方法。这样Director类就会开始工作(Main对此一无所知),并完成文档的编写。
另一方面,Director类知道Builder类,它调用了Builder类的方法来编写文档,但是它并不知道它“真正”使用的是哪个类。也不需要知道,因为Director实现了Builder类的方法。而这些方法子类也都已经实现。
Director类不知道自己使用的是Builder的哪个子类,因为这样不知道才能替换。无论将Buidler的哪个子类传递给它,都可以正常工作。
正因为不知道所以才能替换,作为设计人员,我们必须时刻关注这种“可替换性”。