本文详细介绍了如何在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@RequiredArgsConstructorclass 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注解标记此方法。
Poe
Quora旗下的对话机器人聚合工具
607 查看详情
import lombok.Builder;import lombok.Getter;import lombok.RequiredArgsConstructor;import javax.validation.constraints.AssertFalse; // 引入AssertFalse注解@Getter@Builder@RequiredArgsConstructorclass 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; }}
在这个解决方案中：
我们定义了一个名为oneFieldHasToExists()的私有方法。该方法返回maybeA == null && maybeB == null的结果。这意味着，只有当maybeA和maybeB都为null时，该方法才返回true。@AssertFalse注解被应用到这个方法上。根据@AssertFalse的语义，如果被注解的方法返回true，则校验失败。因此，当maybeA和maybeB都为null时，校验就会失败，从而强制要求至少一个字段必须存在。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注解@RestControllerpublic 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注解为实现“至少一个字段必须存在”这类逻辑提供了一个简洁而有效的方案，确保了数据模型的完整性和业务规则的遵守。在实际项目中，合理运用这些工具将大大提升代码质量和应用健壮性。
以上就是Lombok类中实现“至少一个字段必须存在”的校验的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/993219.html
微信扫一扫 
支付宝扫一扫 
