0

0

Lombok @SuperBuilder 实现继承式构建器的正确用法

聖光之護

聖光之護

发布时间:2026-01-11 13:55:42

|

519人浏览过

|

来源于php中文网

原创

Lombok @SuperBuilder 实现继承式构建器的正确用法

本文详解如何使用 lombok 的 `@superbuilder` 注解,让子类 builder 正确继承并初始化父类(抽象)字段,彻底解决手动实现 builder 模式时字段不可见、构造器缺失等问题。

在基于继承的构建器模式(Builder Pattern)中,一个常见痛点是:子类无法自动访问或初始化父类中定义的字段。如问题所示,当 StringValidatorConfig 继承自抽象类 CommonValidatorConfig 且两者均含私有字段(canBeNull、canBeEmpty)时,手动编写的 Builder 会因字段不可见而无法正确构造实例;同时,@AllArgsConstructor(即使设为 PRIVATE)也不会包含父类字段——因为 Lombok 默认只处理当前类的直接字段,不递归继承。

此时,Lombok 提供的 @SuperBuilder 是专为此场景设计的解决方案。它能自动生成支持继承链的泛型 Builder 类,确保:

  • 父类字段被子类 Builder 完整继承并可配置;
  • 构造逻辑类型安全,无需 @SuppressWarnings("unchecked") 强转;
  • 子类 Builder 可无缝调用父类 Builder 方法(如 canBeNull(true)),并最终正确组装完整对象。

✅ 正确用法:两步极简配置

只需为父类和子类分别添加 @SuperBuilder,其余交由 Lombok 处理:

@Getter
@SuperBuilder
public abstract class CommonValidatorConfig {
    private boolean canBeNull;
    private boolean canBeEmpty;
}

@SuperBuilder
public class StringValidatorConfig extends CommonValidatorConfig {
}

编译后,Lombok 将生成:

  • CommonValidatorConfigBuilder(抽象基 Builder);
  • StringValidatorConfigBuilder(具体子类 Builder),自动继承所有父类字段的 setter,并重写 build() 返回 StringValidatorConfig 实例;
  • 所有方法返回 this(即子类 Builder 自身),类型安全无强转。

? 扩展自定义逻辑(如 setDefault())

若需添加自定义构建方法(如一键设置默认值),可在父类中显式声明 Builder 抽象类头,Lombok 会自动补全其余逻辑:

@Getter
@SuperBuilder
public abstract class CommonValidatorConfig {
    private boolean canBeNull;
    private boolean canBeEmpty;

    // 显式声明 Builder 抽象类(Lombok 会继承并增强它)
    public static abstract class CommonValidatorConfigBuilder<
            C extends CommonValidatorConfig, 
            B extends CommonValidatorConfigBuilder> {

        // 自定义方法:类型安全,返回 B(子类 Builder)
        public B setDefault() {
            this.canBeNull = false;
            this.canBeEmpty = false;
            return self(); // Lombok 自动生成 self() 方法,返回 B
        }
    }
}
? 提示:self() 是 @SuperBuilder 自动生成的模板方法,等价于 return (B) this;,但完全类型安全,无需手动强转。

⚠️ 注意事项与最佳实践

  • @SuperBuilder 目前标记为“experimental”,但已广泛用于生产环境;其核心逻辑稳定,仅维护响应可能略慢于 @Builder。官方计划将其提升为稳定特性

    GitHub Copilot
    GitHub Copilot

    GitHub AI编程工具,实时编程建议

    下载
  • 避免混用 @Builder 和 @SuperBuilder:同一继承链中必须统一使用 @SuperBuilder,否则生成的 Builder 类型不兼容。

  • 字段可见性无关紧要:@SuperBuilder 直接操作字段(非 getter/setter),因此父类字段即使为 private 也可被 Builder 访问。

  • 如需审查生成代码:运行 lombok delombok 命令可导出实际生成的 Java 源码,便于调试或迁移:

    java -jar lombok.jar delombok -p src/main/java/your/package/CommonValidatorConfig.java

✅ 总结

放弃手动实现泛型 Builder 的复杂嵌套与类型强转——@SuperBuilder 以声明式语法彻底解决继承式构建器的字段继承、类型安全与可扩展性问题。只需两行注解,即可获得工业级健壮的 Builder 链,代码更简洁、可读性更高、维护成本更低。对于任何含继承关系的配置类、DTO 或领域模型,@SuperBuilder 都应是首选方案。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

831

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

737

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

733

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

396

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

398

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16925

2023.08.03

c++主流开发框架汇总
c++主流开发框架汇总

本专题整合了c++开发框架推荐,阅读专题下面的文章了解更多详细内容。

80

2026.01.09

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.4万人学习

C# 教程
C# 教程

共94课时 | 6.4万人学习

Java 教程
Java 教程

共578课时 | 44.6万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号