使用流式 API 的建造者模式
使用流式建造者逐步构建复杂对象,避免构造方法参数逐渐膨胀
使用流式 API 的建造者模式 是 CoddyKit 上的免费 Java Academy 课时。 这是第 4 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Java Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Java Academy 课程共包含 4 节课。
伸缩式构造函数问题
当一个类拥有许多可选参数时,构造函数的数量会不断增加:2 个参数、3 个参数、4 个参数……Builder 模式通过流式的分步配置 API 解决了这个问题。
// Without builder — hard to read:
Pizza p = new Pizza("large", "thin", true, false, true, false, "mozzarella");Builder 的基本结构
请创建一个静态嵌套的 Builder 类。外部类应具有一个接收 builder 的私有构造函数。Builder 中的每个 setter 都返回 this,以支持流式链式调用。
public final class Pizza {
private final String size, crustType, cheese;
private final boolean extraSauce, pepperoni;
private Pizza(Builder b) {
this.size = b.size; this.crustType = b.crustType;
this.cheese = b.cheese; this.extraSauce = b.extraSauce;
this.pepperoni = b.pepperoni;
}
public static class Builder {
private final String size;
private String crustType = "regular", cheese = "mozzarella";
private boolean extraSauce, pepperoni;
public Builder(String size) { this.size = size; }
public Builder crustType(String c) { this.crustType = c; return this; }
public Builder cheese(String c) { this.cheese = c; return this; }
public Builder extraSauce() { this.extraSauce = true; return this; }
public Builder pepperoni() { this.pepperoni = true; return this; }
public Pizza build() { return new Pizza(this); }
}
}流式 API 的使用
Builder 的调用方式读起来像一句话。必需参数放在构造函数中,可选参数通过方法调用设置。最后调用 build() 生成不可变对象。
Pizza p = new Pizza.Builder("large")
.crustType("thin")
.extraSauce()
.pepperoni()
.build();
System.out.println(p);在 build() 中进行验证
请在构造对象之前,将验证逻辑添加到 build() 中。对于无效的参数组合,请抛出 IllegalStateException 或 IllegalArgumentException。
public Pizza build() {
if (size == null || size.isBlank())
throw new IllegalArgumentException("Size required");
if (extraSauce && crustType.equals("stuffed"))
throw new IllegalStateException("No extra sauce on stuffed crust");
return new Pizza(this);
}用于不可变对象的 Builder
由于外部类是通过 builder 一次性创建的,所有字段都可以声明为 final,从而使生成的对象完全不可变且具备线程安全性。
public final class Address {
private final String street, city, country;
private final String postalCode;
private Address(Builder b) { ... } // all finals
// no setters — immutable!
}使用自身类型的泛型 Builder
对于继承层次结构,请使用递归泛型类型参数(SELF extends Builder<SELF>),这样子类 Builder 的链式方法就能返回子类类型。
public abstract static class Builder<SELF extends Builder<SELF>> {
String name;
@SuppressWarnings("unchecked")
public SELF name(String n) { this.name = n; return (SELF) this; }
public abstract Vehicle build();
}Lombok @Builder
Lombok 的 @Builder 会在编译时生成完整的 builder 基础设施。请使用 @Builder.Default 设置字段默认值,并使用 @Singular 处理集合。
@Builder
public class Report {
private final String title;
@Builder.Default private final int pageCount = 1;
@Singular private final List<String> authors;
}
// Usage:
Report r = Report.builder().title("Q4").author("Alice").author("Bob").build();JDK 中的 Builder
许多 JDK 类都使用 Builder 风格的 API:StringBuilder、HttpRequest.newBuilder()、ProcessBuilder 和 Stream.Builder。请注意识别这种模式。
HttpRequest req = HttpRequest.newBuilder()
.uri(URI.create("https://api.example.com/users"))
.header("Accept", "application/json")
.GET()
.build();Builder 与工厂
当对象需要许多参数并且需要分步配置时,请使用 Builder。当所有变体都很简单、可以通过一次调用完成创建时,请使用工厂。
用于测试数据的 Builder
Builder 在测试中非常有用:您可以在辅助工具中创建一个基础 builder,然后只覆盖每个测试用例相关的字段,从而让测试保持 DRY 且易于阅读。
User defaultUser() { return new User.Builder("test@example.com").name("Test User").build(); }
User adminUser() { return new User.Builder("admin@example.com").name("Admin").role(ADMIN).build(); }线程安全
Builder 本身不是线程安全的,因此请不要在线程之间共享一个 Builder。如果所有字段都是 final,并且没有共享可变对象,那么由它构建的产品可以是不可变且线程安全的。
快速检查
Builder 方法具有什么特征时,才称得上是“流式”的?
回顾
Builder 解决了伸缩式构造函数问题。请使用静态嵌套的 Builder 类,让每个 setter 返回 this,在 build() 中进行验证,并生成不可变对象。Lombok 的 @Builder 可以自动完成这些样板代码。
常见问题解答
「使用流式 API 的建造者模式」课时是免费的吗?
是的 — 「使用流式 API 的建造者模式」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Java Academy 课程的其余内容,请升级到 CoddyKit PRO。 Java Academy 课程共包含 4 节课。
「使用流式 API 的建造者模式」这节课中我会学到什么?
使用流式建造者逐步构建复杂对象,避免构造方法参数逐渐膨胀 你通过在浏览器中直接运行的动手代码来练习 Java Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Java Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 Java Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 4 节课,共 4 节。
「使用流式 API 的建造者模式」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 Java Academy 课中编写并运行代码吗?
能。每节 Java Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- Singleton:线程安全的实现
- 工厂方法模式
- 面向产品族的抽象工厂
- 使用流式 API 的建造者模式