首页 > Java > java教程 > 正文

Lombok对象中实现两个可选字段至少一个存在的约束

心靈之曲
发布: 2025-11-04 14:40:25
原创
856人浏览过

Lombok对象中实现两个可选字段至少一个存在的约束

本文详细介绍了如何在lombok构建的对象中,为两个可空字段添加“至少一个必须存在”的业务约束。通过结合jsr 303 bean validation规范中的`@assertfalse`注解和自定义校验方法,可以优雅地实现当两个字段同时为空时触发校验失败,从而确保数据完整性,并提供了示例代码及注意事项。

业务场景:两个可选字段,至少一个必填

在构建数据模型时,我们经常会遇到这样的业务需求:一个对象中包含两个或多个字段,它们都可以是空值(nullable),但业务逻辑要求在任何给定实例中,这些字段中至少有一个必须被赋值。例如,一个联系人信息可能允许提供邮箱或电话号码,但不能两者都为空。Lombok库通过@Builder和@RequiredArgsConstructor等注解极大地简化了Java对象的创建,但其本身并不直接提供处理此类复杂业务约束的机制。

结合JSR 303 Bean Validation解决约束问题

Java的JSR 303(Bean Validation)规范提供了一种标准化的方式来定义和验证Java对象的约束。我们可以利用其内置的注解,特别是javax.validation.constraints.AssertFalse,来解决“两个可选字段至少一个必填”的问题。

@AssertFalse注解用于标记一个返回boolean类型的方法,它要求该方法的返回值必须为false才能通过验证。这为我们提供了一个灵活的机制:我们可以编写一个方法,当且仅当出现“两个字段都为空”的无效状态时,该方法返回true,然后用@AssertFalse来确保这种情况不会发生。

实现步骤与示例代码

假设我们有一个Example类,其中包含maybeA和maybeB两个String类型的字段,我们要求它们不能同时为空。

import lombok.Builder;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import javax.validation.constraints.AssertFalse; // 确保已引入javax.validation-api依赖

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

    /**
     * 自定义校验方法,用于检查maybeA和maybeB是否同时为空。
     * 当且仅当maybeA和maybeB都为null时,返回true,表示出现无效状态。
     * @return 如果两个字段都为空,则返回true;否则返回false。
     */
    @AssertFalse(message = "maybeA和maybeB不能同时为空,至少需要提供一个值。")
    private boolean oneFieldHasToExists() {
        // 当maybeA和maybeB都为null时,我们认为这是无效状态,返回true
        return maybeA == null && maybeB == null;
    }

    // 可以在此处添加main方法或其他测试代码来验证
    public static void main(String[] args) {
        // 示例1: A和B都存在 - 应该通过校验
        Example example1 = Example.builder().maybeA("ValueA").maybeB("ValueB").build();
        System.out.println("Example 1: " + example1.getMaybeA() + ", " + example1.getMaybeB());
        // 实际应用中,会通过Validator实例来校验

        // 示例2: 只有A存在 - 应该通过校验
        Example example2 = Example.builder().maybeA("ValueA").build();
        System.out.println("Example 2: " + example2.getMaybeA() + ", " + example2.getMaybeB());

        // 示例3: 只有B存在 - 应该通过校验
        Example example3 = Example.builder().maybeB("ValueB").build();
        System.out.println("Example 3: " + example3.getMaybeA() + ", " + example3.getMaybeB());

        // 示例4: A和B都不存在 - 应该触发校验失败
        Example example4 = Example.builder().build();
        System.out.println("Example 4: " + example4.getMaybeA() + ", " + example4.getMaybeB());
    }
}
登录后复制

在上述代码中:

猫眼课题宝
猫眼课题宝

5分钟定创新选题,3步生成高质量标书!

猫眼课题宝 262
查看详情 猫眼课题宝
  1. 我们定义了一个私有的boolean类型方法oneFieldHasToExists()。
  2. 这个方法的核心逻辑是return maybeA == null && maybeB == null;。这意味着只有当maybeA和maybeB都为null时,该方法才返回true。
  3. 我们在oneFieldHasToExists()方法上添加了@AssertFalse注解。根据@AssertFalse的语义,它要求被注解的方法返回false才能通过校验。因此,当maybeA和maybeB同时为null时,oneFieldHasToExists()返回true,@AssertFalse就会触发校验失败。
  4. message属性用于自定义校验失败时返回的错误信息。

集成与注意事项

要使上述校验生效,您的项目需要集成一个JSR 303的实现,例如Hibernate Validator。通常,在Spring Boot应用中,只需添加spring-boot-starter-validation依赖即可自动配置。

<!-- Maven 依赖示例 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>
<!-- 或直接引入JSR 303 API和实现 -->
<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>2.0.1.Final</version> <!-- 或更高版本 -->
</dependency>
<dependency>
    <groupId>org.hibernate.validator</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>6.0.13.Final</version> <!-- 或更高版本 -->
</dependency>
登录后复制

在实际使用时,您需要在需要校验Example对象的地方(例如REST控制器的方法参数、服务层逻辑等)使用@Valid注解触发校验:

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;

@RestController
public class ExampleController {

    @PostMapping("/examples")
    public String createExample(@Valid @RequestBody Example example) {
        // 如果example对象校验通过,则执行业务逻辑
        return "Example created successfully: A=" + example.getMaybeA() + ", B=" + example.getMaybeB();
    }
}
登录后复制

当example对象的maybeA和maybeB都为null时,@Valid注解会触发校验,oneFieldHasToExists()方法返回true,@AssertFalse导致校验失败,进而抛出MethodArgumentNotValidException(在Spring MVC中),通常会被全局异常处理器捕获并返回相应的错误响应。

总结

通过巧妙地利用JSR 303 Bean Validation规范中的@AssertFalse注解,我们可以为Lombok构建的对象添加复杂的业务约束,例如“两个可选字段至少一个必填”的场景。这种方法将校验逻辑内聚到模型类中,保持了代码的整洁性和可维护性,并且与标准的Java验证框架无缝集成。对于更复杂的跨字段校验,也可以考虑自定义约束注解,但对于此类特定场景,@AssertFalse提供了一个简洁而有效的解决方案。

以上就是Lombok对象中实现两个可选字段至少一个存在的约束的详细内容,更多请关注php中文网其它相关文章!

最佳 Windows 性能的顶级免费优化软件
最佳 Windows 性能的顶级免费优化软件

每个人都需要一台速度更快、更稳定的 PC。随着时间的推移,垃圾文件、旧注册表数据和不必要的后台进程会占用资源并降低性能。幸运的是,许多工具可以让 Windows 保持平稳运行。

下载
来源:php中文网
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn
最新问题
开源免费商场系统广告
热门教程
更多>
最新下载
更多>
网站特效
网站源码
网站素材
前端模板
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新 English
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送
PHP中文网APP
随时随地碎片化学习

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