0

0

Lombok对象中实现“至少一个字段存在”的校验

花韻仙語

花韻仙語

发布时间:2025-11-04 17:12:01

|

508人浏览过

|

来源于php中文网

原创

Lombok对象中实现“至少一个字段存在”的校验

本文详细介绍了如何在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类:

Imagine By Magic Studio
Imagine By Magic Studio

AI图片生成器,用文字制作图片

下载
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;
    }
}

代码解析:

  1. @AssertFalse注解: 它来自javax.validation.constraints包,是JSR 303/380 Bean Validation规范的一部分。
  2. oneFieldHasToExists()方法: 这是一个私有方法,其命名应清晰地表达其验证目的。
    • 该方法返回maybeA == null && maybeB == null的结果。
    • 如果maybeA和maybeB都为null,则表达式为true。
    • 如果maybeA或maybeB(或两者)不为null,则表达式为false。
  3. 验证逻辑: @AssertFalse要求其所注解的方法必须返回false才能通过验证。因此,当maybeA和maybeB都为null时,oneFieldHasToExists()返回true,@AssertFalse就会触发验证失败,从而实现了“至少一个字段存在”的约束。
  4. message属性: 可以通过message属性自定义验证失败时的提示信息,这对于用户体验和错误排查非常重要。

使用与注意事项

要使上述校验生效,你的项目需要引入Bean Validation API及其实现,例如Hibernate Validator。

Maven 依赖示例:

<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.16.Final</version> <!-- 或更高版本 -->
</dependency>

在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对象中实现“至少一个字段必须存在”的复杂校验逻辑。这种方法保持了代码的整洁性,并将校验逻辑内聚在数据模型本身,有助于提高代码的可维护性和健壮性。在实际开发中,理解并灵活运用各种验证注解,能够帮助我们构建更加可靠的应用程序。

热门AI工具

更多
DeepSeek
DeepSeek

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

豆包大模型
豆包大模型

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

WorkBuddy
WorkBuddy

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

腾讯元宝
腾讯元宝

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

文心一言
文心一言

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

讯飞写作
讯飞写作

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

即梦AI
即梦AI

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

ChatGPT
ChatGPT

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

相关专题

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

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

160

2025.08.06

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

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

88

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应用程序等。

408

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 应用的流行工具。

150

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 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

32

2026.02.11

Python异步编程与Asyncio高并发应用实践
Python异步编程与Asyncio高并发应用实践

本专题围绕 Python 异步编程模型展开,深入讲解 Asyncio 框架的核心原理与应用实践。内容包括事件循环机制、协程任务调度、异步 IO 处理以及并发任务管理策略。通过构建高并发网络请求与异步数据处理案例,帮助开发者掌握 Python 在高并发场景中的高效开发方法,并提升系统资源利用率与整体运行性能。

37

2026.03.12

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.2万人学习

Java 教程
Java 教程

共578课时 | 81.4万人学习

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

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