
本文详细介绍了如何在lombok生成的java对象中,利用jsr 303规范的`@assertfalse`注解,实现一个关键的业务校验:确保两个或多个可空字段中,至少有一个必须存在值。通过一个具体的`example`类示例,演示了如何定义一个私有方法来检查无效状态(即所有字段都为null),并结合`@assertfalse`强制其结果为`false`,从而在运行时进行有效性验证。
在现代Java应用开发中,数据模型(DTOs、实体类等)的校验是确保数据完整性和业务逻辑正确性的重要环节。Lombok极大地简化了样板代码的编写,但某些复杂的业务校验逻辑仍需手动实现。其中一个常见需求是,在一个对象中,有多个字段可能为空,但至少其中一个字段必须包含值。例如,一个联系方式对象可能包含手机号和邮箱,但用户必须提供其中至少一个。
业务场景:至少一个字段存在
假设我们有一个使用Lombok构建的Java对象Example,它包含两个String类型的字段maybeA和maybeB,这两个字段都是可空的。我们的业务规则要求,当构建Example对象时,maybeA和maybeB不能同时为空。换句话说,允许maybeA有值且maybeB为空,允许maybeA为空且maybeB有值,也允许maybeA和maybeB都有值,但绝不允许maybeA和maybeB都为空。
初始的Lombok对象定义可能如下:
import lombok.Builder;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
@Getter
@Builder
@RequiredArgsConstructor
class Example {
private final String maybeA;
private final String maybeB;
}直接使用Lombok的注解无法表达这种“互斥非空”或“至少一个存在”的复杂校验逻辑。此时,我们需要借助Java Bean Validation(JSR 303/380)规范提供的注解。
解决方案:使用@AssertFalse实现互斥非空校验
Java Bean Validation规范提供了多种约束注解,其中@AssertFalse非常适合解决此类问题。@AssertFalse注解可以应用于一个返回boolean类型的方法上,它要求该方法的返回结果必须为false,否则验证失败。
利用这个特性,我们可以定义一个私有方法来检查“无效”的状态。对于“maybeA和maybeB不能同时为空”这个规则,其无效状态就是“maybeA为空且maybeB为空”。如果这个无效状态为真,那么我们的验证就应该失败。因此,我们将@AssertFalse应用于一个当maybeA和maybeB都为空时返回true的方法。
下面是修改后的Example类:
import lombok.Builder;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import javax.validation.constraints.AssertFalse; // 引入javax.validation包
@Getter
@Builder
@RequiredArgsConstructor
class Example {
private final String maybeA;
private final String maybeB;
/**
* 验证方法:确保maybeA和maybeB不能同时为空。
* 当maybeA和maybeB都为null时,此方法返回true,
* 结合@AssertFalse注解,将导致验证失败。
*/
@AssertFalse(message = "maybeA和maybeB不能同时为空,至少需要提供一个值。")
private boolean oneFieldHasToExists() {
return maybeA == null && maybeB == null;
}
}代码解析:
- @AssertFalse注解: 它来自javax.validation.constraints包,是JSR 303/380 Bean Validation规范的一部分。
-
oneFieldHasToExists()方法: 这是一个私有方法,其命名应清晰地表达其验证目的。
- 该方法返回maybeA == null && maybeB == null的结果。
- 如果maybeA和maybeB都为null,则表达式为true。
- 如果maybeA或maybeB(或两者)不为null,则表达式为false。
- 验证逻辑: @AssertFalse要求其所注解的方法必须返回false才能通过验证。因此,当maybeA和maybeB都为null时,oneFieldHasToExists()返回true,@AssertFalse就会触发验证失败,从而实现了“至少一个字段存在”的约束。
- message属性: 可以通过message属性自定义验证失败时的提示信息,这对于用户体验和错误排查非常重要。
使用与注意事项
要使上述校验生效,你的项目需要引入Bean Validation API及其实现,例如Hibernate Validator。
Maven 依赖示例:
javax.validation validation-api 2.0.1.Final org.hibernate.validator hibernate-validator 6.0.16.Final
在Spring Boot等框架中,通常只需在控制器方法参数上使用@Valid注解,即可自动触发Bean Validation:
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; // 引入javax.validation包
@RestController
public class ExampleController {
@PostMapping("/examples")
public String createExample(@Valid @RequestBody Example example) {
// 如果example对象验证失败,将抛出MethodArgumentNotValidException
// 否则,处理example对象
return "Example created successfully!";
}
}注意事项:
- 方法可见性: 验证方法可以是private,protected或public,但通常建议使用private,因为它只是内部验证逻辑的一部分。
- 方法签名: 验证方法必须返回boolean类型,且不能有任何参数。
- 错误信息: 务必通过message属性提供清晰的错误信息,以便前端或客户端能够准确地理解验证失败的原因。
- 复杂逻辑: 对于更复杂的跨字段校验逻辑,可以考虑使用自定义的组合注解,但这超出了本教程的范围。
- Lombok与Validation: Lombok生成的构造器和Getter/Setter与Bean Validation注解是完全兼容的。
总结
通过巧妙地结合Lombok和JSR 303 Bean Validation规范中的@AssertFalse注解,我们可以优雅地在Java对象中实现“至少一个字段必须存在”的复杂校验逻辑。这种方法保持了代码的整洁性,并将校验逻辑内聚在数据模型本身,有助于提高代码的可维护性和健壮性。在实际开发中,理解并灵活运用各种验证注解,能够帮助我们构建更加可靠的应用程序。










