生成器

将一个复杂对象的构建与它的表示分离，使得同样的构建过程可以创建不同的表示。

生成器模式（Builder）是使用多个“小型”工厂来最终创建出一个完整对象。

当我们使用Builder的时候，一般来说，是因为创建这个对象的步骤比较多，每个步骤都需要一个零部件，最终组合成一个完整的对象。

我们仍然以Markdown转HTML为例，因为直接编写一个完整的转换器比较困难，但如果针对类似下面的一行文本：

  1. # this is a heading

转换成HTML就很简单：

  1. <h1>this is a heading</h1>

因此，我们把Markdown转HTML看作一行一行的转换，每一行根据语法，使用不同的转换器：

  • 如果以#开头，使用HeadingBuilder转换；
  • 如果以>开头，使用QuoteBuilder转换；
  • 如果以—-开头，使用HrBuilder转换；
  • 其余使用ParagraphBuilder转换。

这个HtmlBuilder写出来如下：

  1. public class HtmlBuilder {
  2.     private HeadingBuilder headingBuilder = new HeadingBuilder();
  3.     private HrBuilder hrBuilder = new HrBuilder();
  4.     private ParagraphBuilder paragraphBuilder = new ParagraphBuilder();
  5.     private QuoteBuilder quoteBuilder = new QuoteBuilder();
  7.     public String toHtml(String markdown) {
  8.         StringBuilder buffer = new StringBuilder();
  9.         markdown.lines().forEach(line -> {
  10.             if (line.startsWith("#")) {
  11.                 buffer.append(headingBuilder.buildHeading(line)).append('\n');
  12.             } else if (line.startsWith(">")) {
  13.                 buffer.append(quoteBuilder.buildQuote(line)).append('\n');
  14.             } else if (line.startsWith("---")) {
  15.                 buffer.append(hrBuilder.buildHr(line)).append('\n');
  16.             } else {
  17.                 buffer.append(paragraphBuilder.buildParagraph(line)).append('\n');
  18.             }
  19.         });
  20.         return buffer.toString();
  21.     }
  22. }

注意观察上述代码，HtmlBuilder并不是一次性把整个Markdown转换为HTML，而是一行一行转换，并且，它自己并不会将某一行转换为特定的HTML，而是根据特性把每一行都“委托”给一个XxxBuilder去转换，最后，把所有转换的结果组合起来，返回给客户端。

这样一来，我们只需要针对每一种类型编写不同的Builder。例如，针对以#开头的行，需要HeadingBuilder：

  1. public class HeadingBuilder {
  2.     public String buildHeading(String line) {
  3.         int n = 0;
  4.         while (line.charAt(0) == '#') {
  5.             n++;
  6.             line = line.substring(1);
  7.         }
  8.         return String.format("<h%d>%s</h%d>", n, line.strip(), n);
  9.     }
  10. }

注意：实际解析Markdown是带有状态的，即下一行的语义可能与上一行相关。这里我们简化了语法，把每一行视为可以独立转换。

可见，使用Builder模式时，适用于创建的对象比较复杂，最好一步一步创建出“零件”，最后再装配起来。

JavaMail的MimeMessage就可以看作是一个Builder模式，只不过Builder和最终产品合二为一，都是MimeMessage：

  1. Multipart multipart = new MimeMultipart();
  2. // 添加text:
  3. BodyPart textpart = new MimeBodyPart();
  4. textpart.setContent(body, "text/html;charset=utf-8");
  5. multipart.addBodyPart(textpart);
  6. // 添加image:
  7. BodyPart imagepart = new MimeBodyPart();
  8. imagepart.setFileName(fileName);
  9. imagepart.setDataHandler(new DataHandler(new ByteArrayDataSource(input, "application/octet-stream")));
  10. multipart.addBodyPart(imagepart);
  12. MimeMessage message = new MimeMessage(session);
  13. // 设置发送方地址:
  14. message.setFrom(new InternetAddress("me@example.com"));
  15. // 设置接收方地址:
  16. message.setRecipient(Message.RecipientType.TO, new InternetAddress("xiaoming@somewhere.com"));
  17. // 设置邮件主题:
  18. message.setSubject("Hello", "UTF-8");
  19. // 设置邮件内容为multipart:
  20. message.setContent(multipart);

很多时候，我们可以简化Builder模式，以链式调用的方式来创建对象。例如，我们经常编写这样的代码：

  1. StringBuilder builder = new StringBuilder();
  2. builder.append(secure ? "https://" : "http://")
  3.        .append("www.liaoxuefeng.com")
  4.        .append("/")
  5.        .append("?t=0");
  6. String url = builder.toString();

由于我们经常需要构造URL字符串，可以使用Builder模式编写一个URLBuilder，调用方式如下：

  1. String url = URLBuilder.builder() // 创建Builder
  2.         .setDomain("www.liaoxuefeng.com") // 设置domain
  3.         .setScheme("https") // 设置scheme
  4.         .setPath("/") // 设置路径
  5.         .setQuery(Map.of("a", "123", "q", "K&R")) // 设置query
  6.         .build(); // 完成build

练习

从生成器 - 图1下载练习：使用Builder模式实现一个URLBuilder （推荐使用IDE练习插件快速下载）

小结

Builder模式是为了创建一个复杂的对象，需要多个步骤完成创建，或者需要多个零件组装的场景，且创建过程中可以灵活调用不同的步骤或组件。

读后有收获可以支付宝请作者喝咖啡，读后有疑问请加微信群讨论：

生成器 - 图2生成器 - 图3