0

0

Lombok类中实现“至少一个字段必须存在”的校验

DDD

DDD

发布时间:2025-11-04 18:20:10

|

968人浏览过

|

来源于php中文网

原创

Lombok类中实现“至少一个字段必须存在”的校验

本文详细介绍了如何在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
@RequiredArgsConstructor
class 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注解标记此方法。

GentleAI
GentleAI

GentleAI是一个高效的AI工作平台,为普通人提供智能计算、简单易用的界面和专业技术支持。让人工智能服务每一个人。

下载
import lombok.Builder;
import lombok.Getter;
import lombok.RequiredArgsConstructor;
import javax.validation.constraints.AssertFalse; // 引入AssertFalse注解

@Getter
@Builder
@RequiredArgsConstructor
class 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;
    }
}

在这个解决方案中:

  1. 我们定义了一个名为oneFieldHasToExists()的私有方法。
  2. 该方法返回maybeA == null && maybeB == null的结果。这意味着,只有当maybeA和maybeB都为null时,该方法才返回true。
  3. @AssertFalse注解被应用到这个方法上。根据@AssertFalse的语义,如果被注解的方法返回true,则校验失败。因此,当maybeA和maybeB都为null时,校验就会失败,从而强制要求至少一个字段必须存在。
  4. 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注解

@RestController
public class ExampleController {

    @PostMapping("/examples")
    public ResponseEntity<String> 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项目,通常添加如下依赖:
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

    这个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注解为实现“至少一个字段必须存在”这类逻辑提供了一个简洁而有效的方案,确保了数据模型的完整性和业务规则的遵守。在实际项目中,合理运用这些工具将大大提升代码质量和应用健壮性。

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

409

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

33

2026.02.11

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

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

26

2026.03.13

热门下载

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

精品课程

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

共23课时 | 4.4万人学习

C# 教程
C# 教程

共94课时 | 11.3万人学习

Java 教程
Java 教程

共578课时 | 81.9万人学习

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

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