Java 建造者模式（Builder Pattern）知多少？
因 Java 中没有命名参数的概念，当一个类的构造器可选参数太多的时候，代码可读性会变得很差。于是，建造者模式（Builder Pattern）应运而生。
本文首先举了一个真实的例子，引出构造器可选参数太多时应如何去处理的问题。然后，分析传统的伸缩式构造器模式与 JavaBeans 构造器模式在处理该问题时存在的不足；最后，引出了建造者模式，介绍了其设计思路与优点。
先看一个例子：假设我们要为一个 Redis 配置类（RedisConfig）设计构造器，该类仅有主机地址（host）是必填字段，其它字段（端口：port、最大连接数：maxTotal、最大闲置连接数：maxIdle、最长等待毫秒数：maxWaitMillis、获取连接前是否进行测试：testOnBorrow）均为可选字段且拥有默认值。
如何为该 Redis 配置类设计构造器呢？
1 伸缩式构造器模式
针对可选参数太多的情形，传统的方案即是采用伸缩式构造器模式。该模式首先会创建一个只包含所有必填参数的构造器，然后创建仅包含一个可选参数的构造器，进而创建包含两个可选参数的构造器，直至创建包含所有可选参数的构造器。
下面即是 RedisConfig 采用伸缩式构造器模式的实现代码：
import org.junit.jupiter.api.Test;
public class TelescopingConstructorPatternTest {
static class RedisConfig {
private final String host; // 必填
private Integer port = 6379; // 可选，默认为 6379
private Integer maxTotal = 100; // 可选，默认为 100
private Integer maxIdle = 10; // 可选，默认为 10
private Integer maxWaitMillis = 60 * 1000 * 1000; // 可选，默认为 1 分钟
private Boolean testOnBorrow = true; // 可选，默认为 true
public RedisConfig(String host) {
this.host = host;
}
public RedisConfig(String host, Integer port) {
this(host);
this.port = port;
}
public RedisConfig(String host, Integer port, Integer maxTotal) {
this(host, port);
this.maxTotal = maxTotal;
}
public RedisConfig(String host, Integer port,
Integer maxTotal, Integer maxIdle) {
this(host, port, maxTotal);
this.maxIdle = maxIdle;
}
public RedisConfig(String host, Integer port,
Integer maxTotal, Integer maxIdle,
Integer maxWaitMillis) {
this(host, port, maxTotal, maxIdle);
this.maxWaitMillis = maxWaitMillis;
}
public RedisConfig(String host, Integer port,
Integer maxTotal, Integer maxIdle,
Integer maxWaitMillis, Boolean testOnBorrow) {
this(host, port, maxTotal, maxIdle, maxWaitMillis);
this.testOnBorrow = testOnBorrow;
}
}
@Test
public void testConstruction() {
// 设置某个字段时，需要找到包含该字段的最短参数列表来进行设置
RedisConfig config = new RedisConfig("localhost", 6379, 100, 10, 60 * 1000 * 1000, false);
}
}
针对可选参数太多的问题，伸缩式构造器模式是一个可用的方案，但用起来很蹩脚。比如这里需要将 testOnBorrow 设置为 false，就要找到包含该参数的最短参数列表来进行设置，哪怕该参数前面的值采用的都是默认值，我们也不得不对它们手动再设置一遍。
此外，如果两个紧挨着的参数类型是一样的，稍不注意，就容易设置错，从而造成很严重的 Bug。
// maxTotal 与 maxIdle 设置错了，容易引起问题
RedisConfig config = new RedisConfig("localhost", 6379, 10, 100, 60 * 1000 * 1000, false);
2 JavaBeans 构造器模式
解决可选参数太多的另一种方案是采用 JavaBeans 构造器模式。该模式仅包含一个空的构造器，其所有字段的设置均需通过调用 Setters 方法来进行。
下面即是 RedisConfig 采用 JavaBeans 构造器模式的实现代码：
import org.junit.jupiter.api.Test;
public class JavaBeansPatternTest {
static class RedisConfig {
private String host; // 必填
private Integer port = 6379; // 可选，默认为 6379
private Integer maxTotal = 100; // 可选，默认为 100
private Integer maxIdle = 10; // 可选，默认为 10
private Integer maxWaitMillis = 60 * 1000 * 1000; // 可选，默认为 1 分钟
private Boolean testOnBorrow = true; // 可选，默认为 true
public RedisConfig() {
}
public void setHost(String host) {
this.host = host;
}
public void setPort(Integer port) {
this.port = port;
}
public void setMaxTotal(Integer maxTotal) {
this.maxTotal = maxTotal;
}
public void setMaxIdle(Integer maxIdle) {
this.maxIdle = maxIdle;
}
public void setMaxWaitMillis(Integer maxWaitMillis) {
this.maxWaitMillis = maxWaitMillis;
}
public void setTestOnBorrow(Boolean testOnBorrow) {
this.testOnBorrow = testOnBorrow;
}
}
@Test
public void testConstruction() {
RedisConfig config = new RedisConfig();
config.setHost("localhost");
config.setPort(6380);
config.setMaxTotal(200);
config.setMaxIdle(20);
config.setMaxWaitMillis(120 * 1000 * 1000);
config.setTestOnBorrow(false);
}
}
JavaBeans 构造器模式解决了伸缩式构造器模式存在的问题：对一个字段进行设置时，无需对其前面的字段进行设置。但 JavaBeans 构造器模式又引入了别的问题：对象的构造由一次调用分散为多次调用，容易造成对象状态的不一致，从而引起问题。
3 建造者模式
下面介绍建造者模式（Builder Pattern），其兼具伸缩式模式的安全性与 JavaBeans 模式的可读性。其通过引入一个中间对象 Builder 来构造真正的对象，创建 Builder 时需要提供所有的必填参数；而对其它可选参数的设置则采用类似 Setters 的方式来进行；参数设置好后，最后调用一下 Builder 的 build 无参方法来一次性生成最终的不可变对象。
下面即是 RedisConfig 采用建造者模式的实现代码：
import org.junit.jupiter.api.Test;
public class BuilderPatternTest {
static class RedisConfig {
private final String host;
private final Integer port;
private final Integer maxTotal;
private final Integer maxIdle;
private final Integer maxWaitMillis;
private final Boolean testOnBorrow;
static class Builder {
private String host; // 必填
private Integer port = 6379; // 可选，默认为 6379
private Integer maxTotal = 100; // 可选，默认为 100
private Integer maxIdle = 10; // 可选，默认为 10
private Integer maxWaitMillis = 60 * 1000 * 1000; // 可选，默认为 1 分钟
private Boolean testOnBorrow = true; // 可选，默认为 true
public Builder(String host) {
this.host = host;
}
public Builder port(Integer port) {
this.port = port;
return this;
}
public Builder maxTotal(Integer maxTotal) {
this.maxTotal = maxTotal;
return this;
}
public Builder maxIdle(Integer maxIdle) {
this.maxIdle = maxIdle;
return this;
}
public Builder maxWaitMillis(Integer maxWaitMillis) {
this.maxWaitMillis = maxWaitMillis;
return this;
}
public Builder testOnBorrow(Boolean testOnBorrow) {
this.testOnBorrow = testOnBorrow;
return this;
}
public RedisConfig build() {
return new RedisConfig(this);
}
}
private RedisConfig(Builder builder) {
this.host = builder.host;
this.port = builder.port;
this.maxTotal = builder.maxTotal;
this.maxIdle = builder.maxIdle;
this.maxWaitMillis = builder.maxWaitMillis;
this.testOnBorrow = builder.testOnBorrow;
}
}
@Test
public void testConstruction() {
RedisConfig config = new RedisConfig.Builder("localhost")
.port(6380)
.maxTotal(200)
.maxIdle(20)
.maxWaitMillis(120 * 1000 * 1000)
.testOnBorrow(false)
.build();
}
}
综上，本文探索了可选参数太多时应如何处理的问题。对比传统的伸缩式构造器模式、JavaBeans 构造器模式，以及新的建造者模式，发现前两者分别存在可读性差与安全性低的问题，而建造者模式兼具安全性高与可读性好的优点，更适合在日常编码中使用。
本文所涉及的全部示例代码已托管至本人 GitHub，欢迎关注或 Fork。
参考资料
[2] Exploring Joshua Bloch’s Builder design pattern in Java | Java Magazine - blogs.oracle.com
相关文章
评论
正在加载评论......