0

0

Lombok类中实现“至少一个字段必须存在”的校验

DDD

DDD

发布时间:2025-11-04 18:20:10

|

968人浏览过

|

来源于php中文网

原创

Lombok类中实现“至少一个字段必须存在”的校验

本文详细介绍了如何在lombok生成的java类中,通过结合使用`javax.validation.constraints.assertfalse`注解,优雅地实现“在两个可空字段中,至少一个字段必须存在”的业务校验逻辑。这种方法利用bean validation规范,确保数据在对象构建时满足特定的复杂条件,提升了数据模型的健壮性。

在Java应用程序开发中,Lombok极大地简化了样板代码的编写,例如自动生成getter、setter、构造函数和Builder模式等。然而,当涉及到更复杂的业务校验逻辑时,例如要求一个对象中的多个字段虽然都是可空的,但至少其中一个必须被赋值时,Lombok本身并不能直接提供这样的约束。本文将探讨如何利用Java Bean Validation(JSR 380)规范中的@AssertFalse注解来解决这一问题。

业务场景:可选字段的互斥/互补校验

假设我们有一个Example类,它包含两个String类型的字段maybeA和maybeB。这两个字段都是可选的,但业务规则要求:maybeA和maybeB不能同时为空。也就是说,我们可以有A和B、A或B,但不能A和B都不存在。

以下是使用Lombok构建的初始Example类:

import lombok.Builder;
import lombok.Getter;
import lombok.RequiredArgsConstructor;

@Getter
@Builder
@RequiredArgsConstructor
class Example {
    private final String maybeA;
    private final String maybeB;
}

直接使用Lombok的@Builder和@RequiredArgsConstructor并不能强制执行“至少一个字段存在”的逻辑。如果使用Example.builder().build(),maybeA和maybeB都将是null,这违反了我们的业务规则。

解决方案:使用@AssertFalse进行自定义校验

Java Bean Validation规范提供了一系列强大的注解来声明数据校验规则。对于这种需要基于多个字段进行判断的复杂逻辑,我们可以利用@AssertFalse注解。

@AssertFalse注解用于标记一个返回boolean类型的方法。当该方法返回true时,校验失败;当返回false时,校验通过。这使得它非常适合表达“某个条件不能成立”的校验规则。

为了实现“maybeA和maybeB不能同时为空”的规则,我们可以在Example类中添加一个私有方法,该方法在maybeA和maybeB都为null时返回true。然后,使用@AssertFalse注解标记此方法。

Play.ht
Play.ht

根据文本生成多种逼真的语音

下载
import lombok.Builder;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import javax.validation.constraints.AssertFalse; // 引入AssertFalse注解

@Getter
@Builder
@RequiredArgsConstructor
class Example {
    private final String maybeA;
    private final String maybeB;

    /**
     * 自定义校验方法:确保maybeA和maybeB不能同时为null。
     * 当此方法返回true时,表示校验失败(因为AssertFalse期望为false)。
     * 当maybeA和maybeB都为null时,返回true,触发校验错误。
     */
    @AssertFalse(message = "maybeA和maybeB不能同时为空,至少一个字段必须存在。")
    private boolean oneFieldHasToExists() {
        return maybeA == null && maybeB == null;
    }
}

在这个解决方案中:

  1. 我们定义了一个名为oneFieldHasToExists()的私有方法。
  2. 该方法返回maybeA == null && maybeB == null的结果。这意味着,只有当maybeA和maybeB都为null时,该方法才返回true。
  3. @AssertFalse注解被应用到这个方法上。根据@AssertFalse的语义,如果被注解的方法返回true,则校验失败。因此,当maybeA和maybeB都为null时,校验就会失败,从而强制要求至少一个字段必须存在。
  4. message属性用于自定义校验失败时返回的错误信息,这对于用户体验和错误诊断至关重要。

如何触发校验

要使javax.validation.constraints包下的注解生效,你的应用程序必须集成一个Bean Validation的实现,例如Hibernate Validator,并在适当的时机触发校验。在Spring Boot应用中,通常只需要引入spring-boot-starter-validation依赖,并在控制器方法参数或服务方法参数上使用@Valid注解即可。

例如,在一个Spring控制器中:

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;
import javax.validation.Valid; // 引入@Valid注解

@RestController
public class ExampleController {

    @PostMapping("/examples")
    public ResponseEntity createExample(@Valid @RequestBody Example example) {
        // 如果example对象校验通过,则执行业务逻辑
        return ResponseEntity.ok("Example created successfully: " + example);
    }
}

当客户端发送一个请求体,其中maybeA和maybeB都为null时,@Valid注解将触发Example对象上的所有校验规则,包括oneFieldHasToExists()方法上的@AssertFalse。此时,请求将因校验失败而被拒绝,并返回相应的错误信息。

注意事项与最佳实践

  • 依赖管理: 确保你的项目中包含了javax.validation-api(Bean Validation API)和hibernate-validator(Bean Validation实现)的依赖。对于Maven项目,通常添加如下依赖:
    
        org.springframework.boot
        spring-boot-starter-validation
    

    这个starter会自动引入所需的Bean Validation API和Hibernate Validator实现。

  • 方法可见性: 被@AssertFalse(或其他约束注解)标记的校验方法通常可以是private或protected,只要Bean Validation框架能够访问它即可。
  • 错误信息: 始终为校验注解提供有意义的message属性,以便在校验失败时向用户或开发者提供清晰的反馈。
  • 复杂校验: 对于更复杂的跨字段校验逻辑,除了@AssertFalse,还可以考虑使用@AssertTrue或自定义约束注解(@Constraint)。自定义约束注解提供了更大的灵活性,可以创建可重用的校验逻辑。
  • Lombok与校验: Lombok生成的代码与Bean Validation注解兼容良好。Lombok负责生成标准的Java Bean方法,而Bean Validation则在这些Bean上执行校验。

总结

通过巧妙地结合Lombok的便捷性与Java Bean Validation的强大功能,我们可以优雅地解决复杂的业务校验需求。@AssertFalse注解为实现“至少一个字段必须存在”这类逻辑提供了一个简洁而有效的方案,确保了数据模型的完整性和业务规则的遵守。在实际项目中,合理运用这些工具将大大提升代码质量和应用健壮性。

相关专题

更多
java
java

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

651

2023.06.15

java流程控制语句有哪些
java流程控制语句有哪些

java流程控制语句:1、if语句;2、if-else语句;3、switch语句;4、while循环;5、do-while循环;6、for循环;7、foreach循环;8、break语句;9、continue语句;10、return语句。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

454

2024.02.23

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

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

722

2023.07.05

java自学难吗
java自学难吗

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

725

2023.07.31

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

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

394

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基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

441

2023.08.02

java有什么用
java有什么用

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

427

2023.08.02

笔记本电脑卡反应很慢处理方法汇总
笔记本电脑卡反应很慢处理方法汇总

本专题整合了笔记本电脑卡反应慢解决方法,阅读专题下面的文章了解更多详细内容。

1

2025.12.25

热门下载

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

精品课程

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

共23课时 | 2万人学习

C# 教程
C# 教程

共94课时 | 5.3万人学习

Java 教程
Java 教程

共578课时 | 37.6万人学习

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

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