SpringBoot中@Valid与@Validated使用场景详解


SpringBoot中@Valid与@Validated使用场景详解

在实际开发中,参数校验是保证接口安全性和数据完整性的重要手段。Spring Boot提供了@Valid@Validated两个核心注解来实现参数校验,但许多开发者对它们的区别和使用场景存在疑惑。本文将深入解析二者的差异,并通过代码示例演示其具体应用场景。


目录

  1. 核心注解对比
  2. @Valid的用法与场景
  3. @Validated的进阶特性
  4. 嵌套验证与分组校验
  5. 常见问题与注意事项
  6. 总结与最佳实践

一、核心注解对比

特性@Valid@Validated
标准来源JSR-303/JSR-349规范(Java标准)Spring框架扩展
作用范围方法参数、字段、嵌套对象类、方法、参数
分组校验不支持支持
嵌套验证需配合@Valid递归触发需配合@Valid递归触发
使用场景简单参数校验复杂校验(分组、方法参数校验)

二、@Valid的用法与场景

1. 基本使用

@Valid主要用于方法参数校验,尤其在Controller层对DTO对象进行验证。需配合JSR-303注解(如@NotNull@Size)使用。

示例代码:

@PostMapping("/users")
public ResponseEntity<?> createUser(@RequestBody @Valid UserDTO userDTO) {// 业务逻辑return ResponseEntity.ok().build();
}public class UserDTO {@NotBlank(message = "用户名不能为空")private String username;@Size(min = 6, max = 20, message = "密码长度需在6-20位")private String password;
}
2. 嵌套验证

若DTO中包含其他对象字段,需在字段上添加@Valid触发递归校验。

public class OrderDTO {@Valid  // 触发嵌套校验private UserDTO user;@NotNull(message = "订单金额不能为空")private BigDecimal amount;
}

三、@Validated的进阶特性

1. 分组校验

场景说明:不同业务场景下,同一对象可能需要不同的校验规则。例如,用户注册时需要验证邮箱,而更新信息时不需要。

实现步骤

  1. 定义分组接口:
public interface CreateGroup {}  // 创建分组
public interface UpdateGroup {}  // 更新分组
  1. 在DTO中指定分组:
public class UserDTO {@NotBlank(groups = CreateGroup.class, message = "邮箱不能为空")private String email;@NotBlank(message = "用户名不能为空")private String username;
}
  1. 在Controller中使用@Validated激活分组:
@PostMapping("/users")
public ResponseEntity<?> createUser(@RequestBody @Validated(CreateGroup.class) UserDTO userDTO) {// 仅校验CreateGroup分组的规则return ResponseEntity.ok().build();
}
2. 方法参数校验

@Validated可用于Service层的方法参数校验,需在类上添加@Validated注解。

@Service
@Validated  // 启用方法参数校验
public class UserService {public void updateUser(@NotBlank String username, @Min(1) Long userId) {// 业务逻辑}
}

四、嵌套验证与分组校验结合

复杂场景:在分组校验中触发嵌套对象的验证。

public class OrderDTO {@Validated(CreateGroup.class)  // 指定分组@Validprivate UserDTO user;@NotNull(message = "金额必填")private BigDecimal amount;
}// Controller层
@PostMapping("/orders")
public ResponseEntity<?> createOrder(@RequestBody @Validated(CreateGroup.class) OrderDTO orderDTO) {// 同时校验OrderDTO和UserDTO中CreateGroup分组的规则return ResponseEntity.ok().build();
}

五、常见问题与注意事项

1. 异常处理

校验失败会抛出以下异常:

  • MethodArgumentNotValidException(@Valid触发)
  • ConstraintViolationException(@Validated触发)

统一异常处理示例

@RestControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(MethodArgumentNotValidException.class)public ResponseEntity<?> handleValidationException(MethodArgumentNotValidException ex) {Map<String, String> errors = new HashMap<>();ex.getBindingResult().getFieldErrors().forEach(error -> errors.put(error.getField(), error.getDefaultMessage()));return ResponseEntity.badRequest().body(errors);}
}
2. 依赖问题

确保项目中引入spring-boot-starter-validation

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>
3. 注意事项
  • Spring版本兼容性:低版本Spring需手动启用@EnableWebMvc@Validated支持。
  • 分组接口设计:分组接口建议定义为空接口,仅作为标识。

六、总结与最佳实践

场景推荐注解
Controller层DTO参数校验@Valid
分组校验@Validated + 分组接口
Service层方法参数校验@Validated(类级别)
嵌套对象递归校验@Valid + @Validated组合

最佳实践

  1. Controller层:优先使用@Valid进行简单校验。
  2. 复杂业务校验:使用@Validated的分组功能。
  3. Service层参数校验:在类上添加@Validated,配合JSR-303注解。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/68536.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

基于PyQt设计的智能停车管理系统

文章目录 一、前言1.1 项目介绍【1】项目开发背景【2】设计实现的功能【3】设计意义【4】国内外研究现状【6】摘要1.2 设计思路1.3 系统功能总结1.4 开发工具的选择【1】VSCODE【2】python【3】ptqt【4】HyperLPR31.5 参考文献二、安装Python环境1.1 环境介绍**1.2 Python版本介…

前端-Rollup

Rollup 是一个用于 JavaScript 的模块打包工具&#xff0c;它将小的代码片段编译成更大、更复杂的代码&#xff0c;例如库或应用程序。它使用 JavaScript 的 ES6 版本中包含的新标准化代码模块格式&#xff0c;而不是以前的 CommonJS 和 AMD 等特殊解决方案。ES 模块允许你自由…

数仓ETL测试

提取&#xff0c;转换和加载有助于组织使数据在不同的数据系统中可访问&#xff0c;有意义且可用。ETL工具是用于提取&#xff0c;转换和加载数据的软件。在当今数据驱动的世界中&#xff0c;无论大小如何&#xff0c;都会从各种组织&#xff0c;机器和小工具中生成大量数据。 …

策略模式 - 策略模式的使用

引言 在软件开发中&#xff0c;设计模式是解决常见问题的经典解决方案。策略模式&#xff08;Strategy Pattern&#xff09;是行为型设计模式之一&#xff0c;它允许在运行时选择算法的行为。通过将算法封装在独立的类中&#xff0c;策略模式使得算法可以独立于使用它的客户端…

网络直播时代的营销新策略:基于受众分析与开源AI智能名片2+1链动模式S2B2C商城小程序源码的探索

摘要&#xff1a;随着互联网技术的飞速发展&#xff0c;网络直播作为一种新兴的、极具影响力的媒体形式&#xff0c;正逐渐改变着人们的娱乐方式、消费习惯乃至社交模式。据中国互联网络信息中心数据显示&#xff0c;网络直播用户规模已达到3.25亿&#xff0c;占网民总数的45.8…

STM32调试手段:重定向printf串口

引言 C语言中经常使用printf来输出调试信息&#xff0c;打印到屏幕。由于在单片机中没有屏幕&#xff0c;但是我们可以重定向printf&#xff0c;把数据打印到串口&#xff0c;从而在电脑端接收调试信息。这是除了debug外&#xff0c;另外一个非常有效的调试手段。 一、什么是pr…

设计模式:春招面试的关键知识储备

在之前的文章中&#xff0c;我们深入探讨了分布式事务&#xff0c;了解了它在分布式系统中的重要性以及常见的解决方案。而在软件开发领域&#xff0c;设计模式是提升代码质量、可维护性和可扩展性的关键要素。设计模式是对软件开发中反复出现的问题的通用解决方案&#xff0c;…

上位机知识篇---Linux的shell脚本搜索、查找、管道

文章目录 前言第一部分&#xff1a;什么是shell&#xff1f;1. 基本结构脚本声明注释命令和表达式例子 2.变量控制结构条件判断 3.函数输入输出重定向 4.执行命令5.实际应用 第二部分&#xff1a;Linux的搜索、查找、管道命令1.搜索命令2.查找命令3.管道操作 总结 前言 以上就…

利用飞书机器人进行 - ArXiv自动化检索推荐

相关作者的Github仓库 ArXivToday-Lark 使用教程 Step1 新建机器人 根据飞书官方机器人使用手册&#xff0c;新建自定义机器人&#xff0c;并记录好webhook地址&#xff0c;后续将在配置文件中更新该地址。 可以先完成到后续步骤之前&#xff0c;后续的步骤与安全相关&…

混合专家模型MoE的全面详解

什么是混合专家&#xff08;MoE&#xff09;&#xff1f; 混合专家&#xff08;MoE&#xff09;是一种利用多个不同的子模型&#xff08;或称为“专家”&#xff09;来提升LLM质量的技术。 MoE的两个主要组成部分是&#xff1a; 专家&#xff1a;每个前馈神经网络&#xff08…

基于Arcsoft的人脸识别

目录 一、前言 二、使用方法 三、获取SDK 四、人脸检测/人脸识别 五、代码实现 一、前言 face++,百度ai,虹软,face_recognition,其中除了face_recognition是python免费的一个库安装好响应的库直接运行就好,另外三个需要填入相关申请的信息id和key。 分别对应着相应的人…

电梯系统的UML文档13

5.2.6 CarPositionControl 的状态图 图 24: CarPositionControl 的状态图 5.2.7 Dispatcher 的状态图 图 25: Dispatcher 的状态图 5.3 填补从需求到状态图鸿沟的实用方法 状态图能对类的行为&#xff0c;一个用例&#xff0c;或系统整体建模。在本文中&#xff0c;状态图…

自动化运维在云环境中的完整实践指南

随着云计算的普及,越来越多的企业将业务迁移到云上。云环境的高动态性和复杂性使得传统的手动运维方式难以应对,自动化运维成为提升效率、降低成本、保障系统稳定性的关键。本文将详细介绍如何在云环境中实施自动化运维,涵盖工具选择、实施步骤和最佳实践。 © ivwdcwso…

性能测试丨分布式性能监控系统 SkyWalking

软件测试领域&#xff0c;分布式系统的复杂性不断增加&#xff0c;如何保证应用程序的高可用性与高性能&#xff0c;这是每一个软件测试工程师所面临的重大挑战。幸运的是&#xff0c;现在有了一些强大的工具来帮助我们应对这些挑战&#xff0c;其中之一便是Apache SkyWalking。…

Ollama windows安装

Ollama 是一个开源项目&#xff0c;专注于帮助用户本地化运行大型语言模型&#xff08;LLMs&#xff09;。它提供了一个简单易用的框架&#xff0c;让开发者和个人用户能够在自己的设备上部署和运行 LLMs&#xff0c;而无需依赖云服务或外部 API。这对于需要数据隐私、离线使用…

留学生scratch计算机haskell函数ocaml编程ruby语言prolog作业VB

您列出了一系列编程语言和技术&#xff0c;这些可能是您在留学期间需要学习或完成作业的内容。以下是对每个项目的简要说明和它们可能涉及的领域或用途&#xff1a; Scratch&#xff1a; Scratch是一种图形化编程语言&#xff0c;专为儿童和初学者设计&#xff0c;用于教授编程…

C++二叉树进阶

1.二叉搜索树 1.1二叉搜索树概念 二叉搜索树又称二叉排序树&#xff0c;它或者是一颗空树&#xff0c;或者具有以下性质的二叉树 若它的左子树不为空&#xff0c;则左子树上所有结点的值小于根节点的值若它的右子树不为空&#xff0c;则右子树上所有节点的值都大于根节点的值…

亲测有效!解决PyCharm下PyEMD安装报错 ModuleNotFoundError: No module named ‘PyEMD‘

解决PyCharm下PyEMD安装报错 PyEMD安装报错解决方案 PyEMD安装报错 PyCharm下通过右键自动安装PyEMD后运行报错ModuleNotFoundError: No module named ‘PyEMD’ 解决方案 通过PyCharm IDE python package搜索EMD-signal&#xff0c;选择版本后点击“install”执行安装

2. Java-MarkDown文件解析-工具类

2. Java-MarkDown文件解析-工具类 1. 思路 读取markdown文件的内容&#xff0c;根据markdown的语法进行各个类型语法的解析。引入工具类 commonmark 和 commonmark-ext-gfm-tables进行markdown语法解析。 2. 工具类 pom.xml <!-- commonmark 解析markdown --> <d…

常用符号的英语表达

plus 加号&#xff1b;正号 -  minus 减号&#xff1b;负号  plus or minus 正负号  is multiplied by 乘号  is divided by 除号 &#xff1d; is equal to 等于号 ≠ is not equal to 不等于号 ≡ is equivalent to 全等于号 ≌ is equal to or approximatel…