Lombok Builder 中对 Enum 字段进行自定义取值校验的实践方法

老强吖_6730

老强吖_6730

2026-08-18

364人浏览

原创

Lombok Builder 中对 Enum 字段进行自定义取值校验的实践方法

本文介绍如何在使用 Lombok @Builder 时,对枚举类型字段(如 TestEnum)施加额外的业务约束(仅允许 ALPHA 或 BETA),无需手写完整 Builder,而是通过覆盖生成的 builder 方法并嵌入校验逻辑实现安全、简洁、可维护的构造控制。

本文介绍如何在使用 lombok `@builder` 时,对枚举类型字段(如 `testenum`)施加额外的业务约束(仅允许 `alpha` 或 `beta`),无需手写完整 builder,而是通过覆盖生成的 builder 方法并嵌入校验逻辑实现安全、简洁、可维护的构造控制。

在基于 Lombok 的构建器模式开发中,@Builder 能显著减少样板代码,但其默认校验能力有限——例如无法对 enum 字段做值域限制(如仅接受 ALPHA/BETA,排除 GAMMA)。此时,直接依赖 @NonNull@NotNull 并不足够,因为它们只校验非空,不校验具体枚举值。

✅ 推荐方案:局部覆盖 Builder 方法(轻量、精准)

Lombok 允许你仅重写 Builder 中特定 setter 方法,而复用其余自动生成逻辑。只需确保方法签名与 Lombok 生成的一致(包括类名、方法名、参数类型),Lombok 将自动跳过该方法的生成,并采用你的实现:

@Builder(toBuilder = true)
public class Testing {
    @NonNull private String id;
    @NonNull private TestEnum test;
    private String message;

    // 手动提供 test() 方法,注入业务校验
    public static class TestingBuilder {
        public TestingBuilder test(@NonNull TestEnum test) {
            if (test != TestEnum.ALPHA && test != TestEnum.BETA) {
                throw new IllegalArgumentException(
                    "test must be either ALPHA or BETA, but got: " + test);
            }
            this.test = test;
            return this;
        }
    }
}

? 关键细节说明

  • 类名必须为 TestingBuilder(主类名 + Builder);
  • 方法名必须为 test(与字段名一致);
  • 参数类型需完全匹配(含 @NonNull 注解,Lombok 会识别并保留其语义);
  • 返回 this 以支持链式调用,且 toBuilder() 仍可正常工作。

⚠️ 进阶建议:强制全路径校验(防御性更强)

若业务要求所有构造方式(包括直接 new Testing(...)、反射、反序列化等)都必须满足约束,则应在构造器层面统一拦截,而非仅依赖 Builder:

public Testing(@NonNull String id, @NonNull TestEnum test, String message) {
    if (test != TestEnum.ALPHA && test != TestEnum.BETA) {
        throw new IllegalArgumentException(
            "test must be either ALPHA or BETA, but got: " + test);
    }
    this.id = id;
    this.test = test;
    this.message = message;
}

// 禁用无参构造器(可选,配合 @RequiredArgsConstructor(staticName = "of") 更佳)
private Testing() { throw new UnsupportedOperationException(); }

此时建议移除 @BuildertoBuilder = true(或配合自定义 toBuilder 方法),避免绕过构造器校验。

✅ 总结与最佳实践

  • 优先使用“局部覆盖 Builder 方法”:开发成本低、侵入性小、兼容 toBuilder(),适合大多数场景;
  • 校验信息应明确包含非法值(如示例中的 + test),便于调试与日志追踪;
  • ❌ 避免自定义 Lombok 注解:Lombok 不支持运行时注解处理器与自定义校验逻辑的深度集成,易引发不可预测行为;
  • ? 若项目已引入 Bean Validation(如 jakarta.validation),可结合 @Constraint 自定义枚举校验注解,但需额外配置验证触发点(如 @Valid + Validator.validate()),不适用于 Builder 构造阶段。

通过上述方式,你既能享受 Lombok 带来的生产力提升,又能严守业务规则边界,真正实现「约定优于配置」的工程化实践。

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

8917

6

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

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

2023.07.05

6142

9

java自学难吗
java自学难吗

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

2023.07.31

5512

8

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

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

2023.08.01

984

3

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

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

2023.08.02

828

3

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

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

2023.08.02

1156

5

java有什么用
java有什么用

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

2023.08.02

2349

5

java在线网站
java在线网站

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

2023.08.03

19691

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1075

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.2万人学习