0

0

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

心靈之曲

心靈之曲

发布时间:2025-11-04 14:40:25

|

861人浏览过

|

来源于php中文网

原创

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());
    }
}

在上述代码中:

Insou AI
Insou AI

Insou AI 是一款强大的人工智能助手,旨在帮助你轻松创建引人入胜的内容和令人印象深刻的演示。

下载
  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提供了一个简洁而有效的解决方案。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

161

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

89

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

139

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

410

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

73

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

151

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

271

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

34

2026.02.11

TypeScript类型系统进阶与大型前端项目实践
TypeScript类型系统进阶与大型前端项目实践

本专题围绕 TypeScript 在大型前端项目中的应用展开,深入讲解类型系统设计与工程化开发方法。内容包括泛型与高级类型、类型推断机制、声明文件编写、模块化结构设计以及代码规范管理。通过真实项目案例分析,帮助开发者构建类型安全、结构清晰、易维护的前端工程体系,提高团队协作效率与代码质量。

49

2026.03.13

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.3万人学习

Java 教程
Java 教程

共578课时 | 82.2万人学习

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

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