SpringBoot参数校验@Valid 和 @Validated注解使用详解

JSR-303 是 JAVA EE 6 中的一项子规范,叫做 Bean Validation,官方参考实现是Hibernate Validator。

注意:JSR-303实现与 Hibernate ORM 没有任何关系。 JSR 303 用于对 Java Bean 中的字段的值进行验证。

Spring MVC 3.x 之中也大力支持 JSR-303,可以在控制器中对表单提交的数据方便地验证。

在这里插入图片描述

一、@Valid注解使用

1、使用步骤

在Controller中使用 @Valid+BindingResult做参数校验非常好用。一般步骤如下:

(1)引入pom依赖

        <dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId></dependency>
<!-- @JsonFormat注解需要引入--><dependency><groupId>com.fasterxml.jackson.core</groupId><artifactId>jackson-annotations</artifactId></dependency>

(2)在入参bean类中需要校验的参数上使用校验注解

  • 在bean类中的字段加上校验注解,比如:@NotBlank(message = “ID 不能为空”)
  • 每个字段可以加上多个校验注解。
  • 如果 bean需要交给Spring容器管理,可以加上 @Conmponent注解。

(3)编写Controller层代码

  • 在入参的请求体前加@Valid注解
  • 请求体后加 BindingResult bindingResult 此类为bean校验捕获到的异常储存。
  • 对于 BindingResult信息,我们业务做统一校验信息处理。

注意:

(1)@Valid与 BindingResult要配套使用。

(2)@Valid使用

  • 可以用在方法、构造函数、方法参数和成员属性(field)上;
  • 可以进行嵌套校验,但是,需要在嵌套的字段上面加上@Valid注解;
  • 不能进行分组校验;

2、示例1使用

(1)请求体

@Data
public class AaSaveRequest extends BaseRequest {private static final long serialVersionUID = -7895168538160321157L;@NotEmpty(message = "用户名不能为空")private String username;@NotNull(message = "createTime不能为空")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createTime;private Boolean delFlag;}

(2)controller请求方法

    @PostMapping("/save")public WebResult save(@RequestBody @Valid AaSaveRequest saveRequest, BindingResult bindingResult) {if (bindingResult.hasErrors()) {//如果有校验错误,返回第一个校验信息String defaultMessage = bindingResult.getFieldErrors().get(0).getDefaultMessage();//将错误信息返回或者抛异常全局处理。WebResult webResult = new WebResult();webResult.setSuccess(false);webResult.setMessage(defaultMessage);return webResult;}BaseOperateResult operateResult = aaService.save(saveRequest);if (!operateResult.isSuccess()) {WebResult.error().message(operateResult.getErrorCode().getMessage());}return WebResult.ok();}

bindingResult.hasErrors() 判断是否校验通过,未通过bindingResult.getFieldError().getDefaultMessage()获取在TestEntity的属性设置的自定义message,如果没有设置,则返回默认值"javax.validation.constraints.XXX.message"。

(3)测试访问

在这里插入图片描述

3、示例2使用

我们将实示例1中 controller请求方法对于 校验错误采用全局异常捕获的方式处理。

(1)自定义异常类

自定义异常,或者捕获 MethodArgumentNotValidException异常。

/*** 参数校验异常类*/
public class ParameterCheckException extends RuntimeException {private static final long serialVersionUID = -4163815498400849756L;public ParameterCheckException(String message) {super(message);}}

(2)全局异常处理

/*** 全局异常处理类*/
@Slf4j
@ResponseBody
@ControllerAdvice
public class GlobalExceptionHandler {@ExceptionHandler(value = ParameterCheckException.class)private WebResult handlerParameterCheckException(ParameterCheckException e) {//log.error("ParameterCheckException 异常 -> error = {}", e);WebResult webResult = new WebResult();webResult.setSuccess(false);webResult.setCode(WebHttpCode.SERVICE_ERROR);webResult.setMessage(e.getMessage());return webResult;}}

(3)controller请求方法改造

    @PostMapping("/save")public WebResult save(@RequestBody @Valid AaSaveRequest saveRequest, BindingResult bindingResult) {if (bindingResult.hasErrors()) {//如果有校验错误,返回第一个校验信息String defaultMessage = bindingResult.getFieldErrors().get(0).getDefaultMessage();//将错误信息返回或者抛异常全局处理。throw new ParameterCheckException(defaultMessage);}BaseOperateResult operateResult = aaService.save(saveRequest);if (!operateResult.isSuccess()) {WebResult.error().message(operateResult.getErrorCode().getMessage());}return WebResult.ok();}

测试访问校验ok

4、嵌套使用

嵌套使用,比如:A类中引用B类,且A、B二类都有内部校验,为了使B类也生效,在A类中引用B类时,在B类变量上加@Valid注解,如果B类不能为空时还需要再加@NotNull。

注意:嵌套验证时必须使用 @Valid注解。

(1)请求体

@Data
public class AaSave2Request extends BaseRequest {private static final long serialVersionUID = -7895168538160321157L;@NotEmpty(message = "用户名不能为空")private String username;@NotNull(message = "createTime不能为空")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createTime;private Boolean delFlag;/*** 嵌套验证时必须使用 @Valid注解*/@Valid@NotNull(message = "文件不能为空")private AaSaveFileRequest aaSaveFileRequest;}

(2)controller请求方法

    @PostMapping("/save2")public WebResult save2(@RequestBody @Valid AaSave2Request save2Request, BindingResult bindingResult) {if (bindingResult.hasErrors()) {//如果有校验错误,返回第一个校验信息String defaultMessage = bindingResult.getFieldErrors().get(0).getDefaultMessage();//将错误信息返回或者抛异常全局处理。throw new ParameterCheckException(defaultMessage);}BaseOperateResult operateResult = aaService.save2(save2Request);if (!operateResult.isSuccess()) {WebResult.error().message(operateResult.getErrorCode().getMessage());}return WebResult.ok();}

(3)测试访问

在这里插入图片描述

二、@Validated注解使用

1、示例1使用

(1)请求体

@Data
public class AaUpdateRequest extends BaseRequest {private static final long serialVersionUID = -8386003857309634939L;@NotNull(message = "id不能为空")private Long id;@NotEmpty(message = "username不能为空")private String username;@NotNull(message = "createTime不能为空")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createTime;private Boolean delFlag;}

(2)controller请求方法

    @PostMapping("/update")public WebResult update(@RequestBody @Validated AaUpdateRequest updateRequest, BindingResult bindingResult) {if (bindingResult.hasErrors()) {//如果有校验错误,返回第一个校验信息String defaultMessage = bindingResult.getFieldErrors().get(0).getDefaultMessage();throw new ParameterCheckException(defaultMessage);}BaseOperateResult operateResult = aaService.update(updateRequest);if (!operateResult.isSuccess()) {WebResult.error().message(operateResult.getErrorCode().getMessage());}return WebResult.ok();}

3)测试访问

在这里插入图片描述

2、示例2使用

我们将实示例1中 controller请求方法对于 校验错误采用全局异常捕获的方式处理。

(1)全局异常处理,捕获 MethodArgumentNotValidException异常

在这里插入图片描述

/*** 全局异常处理类*/
@Slf4j
@ResponseBody
@ControllerAdvice
public class GlobalExceptionHandler {/*** 处理 @Valid和 @Validated注解参数校验失败异常*/@ExceptionHandler(MethodArgumentNotValidException.class)public WebResult exceptionHandler(MethodArgumentNotValidException exception) {WebResult webResult = new WebResult();webResult.setSuccess(false);webResult.setCode(WebHttpCode.SERVICE_ERROR);BindingResult bindingResult = exception.getBindingResult();if (bindingResult.hasErrors()) {//如果有校验错误,返回第一个校验信息String defaultMessage = bindingResult.getFieldErrors().get(0).getDefaultMessage();webResult.setMessage(defaultMessage);}return webResult;}}

(2)controller请求方法改造

这里单独使用 @Validated注解。

    @PostMapping("/update2")public WebResult update2(@RequestBody @Validated AaUpdateRequest updateRequest) {BaseOperateResult operateResult = aaService.update(updateRequest);if (!operateResult.isSuccess()) {WebResult.error().message(operateResult.getErrorCode().getMessage());}return WebResult.ok();}

测试访问校验ok

3、嵌套使用

@Validated无法单独提供嵌套验证功能。不能用在成员属性上,能配合嵌套验证注解@Valid进行嵌套验证。

(1)请求体

@Data
public class AaUpdate3Request extends BaseRequest {private static final long serialVersionUID = 2976273808489796719L;@NotNull(message = "id不能为空")private Long id;@NotEmpty(message = "username不能为空")private String username;@NotNull(message = "createTime不能为空")@JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss", timezone = "GMT+8")private Date createTime;private Boolean delFlag;/*** 嵌套验证时必须使用 @Valid注解*/@Valid@NotNull(message = "文件不能为空")private List<AaSaveFileRequest> fileRequestList;}

(2)controller请求方法

    @PostMapping("/update3")public WebResult update3(@RequestBody @Validated AaUpdate3Request update3Request) {BaseOperateResult operateResult = aaService.update3(update3Request);if (!operateResult.isSuccess()) {WebResult.error().message(operateResult.getErrorCode().getMessage());}return WebResult.ok();}

(3)测试访问

在这里插入图片描述

如果想了解 @Validated注解分组校验请查看参考文章。

s三、@Valid 和 @Validated 区别

先看下两者的源码:

@Valid 包位置:javax.validation

@Target({ElementType.METHOD, ElementType.FIELD, ElementType.CONSTRUCTOR, ElementType.PARAMETER, ElementType.TYPE_USE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Valid {
}

@Validated 包位置 org.springframework.validation.annotation,是 Spring 做得一个自定义注解,增强了分组功能(对 @Valid的封装);只在 Spring Validator 校验机制使用。

@Target({ElementType.TYPE, ElementType.METHOD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Validated {Class<?>[] value() default {};
}

相同点:

  • @Valid 和 @Validated 两者都可以对数据进行校验,在校验字段上加上规则注解(@NotNull, @NotEmpty等)都可以对 @Valid 和 @Validated 生效。
  • @Valid 和 @Validated 两者都可以与 BindingResult bindingResult配对出现,并且形参顺序是固定的(一前一后),controller对 BindingResult处理返回校验提示。
  • @Valid 和 @Validated 两者也可以单独使用,单独使用当校验不通过时会抛出 BindException异常。这时需要再写一个全局校验异常捕获处理类,然后返回校验提示。

不同点:

  • @Valid可以用在方法、构造函数、方法参数和成员属性(field)上;
  • @Valid可以进行嵌套校验,但是,需要在嵌套的字段上面加上@Valid注解;
  • @Valid不支持分组。
  • @Validated可以用在方法、构造函数、方法参数;但是不能用在成员属性(字段)上;
  • @Validated不支持嵌套校验,因为不能用在成员属性(字段)上;
  • @Validated支持分组验证,以在入参验证时,根据不同的分组采用不同的验证机制;

项目中使用 @Valid和@Validated都可以。如果涉及分组校验时,使用 @Validated注解。

  • @Valid无法单独提供嵌套验证功能。能够用在成员属性上,能配合嵌套验证注解@Valid进行嵌套验证。
  • @Validated无法单独提供嵌套验证功能。不能用在成员属性上,能配合嵌套验证注解@Valid进行嵌套验证。

参考文章:

  • Java代码瘦身,巧用 @Valid,@Validated 的分组校验和嵌套检验,实现高阶参数校验操作:https://blog.csdn.net/weixin_44259720/article/details/127965610

– 求知若饥,虚心若愚。

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

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

相关文章

web框架的本质初识

1.什么是HTML HTML是一个超文本语言&#xff0c;是一种创建网页结构的标记语言。就是你女朋友化妆之后的样子 2.什么是HTTP协议 是一种用于在Web上传输数据的协议。它是客户端和服务器之间进行相互通信的基础的协议 3.HTTP的特点 无连接&#xff1a;每个http请求都是独立的…

【WPF应用30】WPF中的ListBox控件详解

WPF&#xff08;Windows Presentation Foundation&#xff09;是.NET框架的一个组成部分&#xff0c;用于构建桌面应用程序的用户界面。ListBox是WPF中一个非常常用的控件&#xff0c;用于显示一系列的项&#xff0c;用户可以选择单个或多个项。 1.ListBox的基本概念 ListBox…

择校!这些计算机专业的考研学校性价比巨高(必看)

建议可以关注一下东北大学&#xff0c;可以抄底 今年东北大学刚更改408&#xff0c;加上地区不太优势&#xff0c;很可能爆冷&#xff0c;有时候会觉得学校的选择可能比个人的努力更加重要。要做出明智的选择&#xff0c;需要考虑近几年的复试分数线&#xff0c;以及当年的热度…

Neo4j基础知识

图数据库简介 图数据库是基于数学里图论的思想和算法而实现的高效处理复杂关系网络的新型数据库系统。它善于高效处理大量的、复杂的、互连的、多变的数据。其计算效率远远高于传统的关系型数据库。 在图形数据库当中&#xff0c;每个节点代表一个对象&#xff0c;节点之间的…

C 练习实例97 - 读磁盘 写磁盘

题目&#xff1a;从键盘输入一些字符&#xff0c;逐个把它们送到磁盘上去&#xff0c;直到输入一个‘#’为止 在桌面新建一个hello.txt文件&#xff0c;内容示例&#xff1a; 代码&#xff1a; #include <stdio.h> #include <stdlib.h>int main() {FILE *fp; //文…

详解k8s集群内外的访问方式

文章目录 1、集群内访问2、集群外访问2.1、Ingress转发外网请求2.2、LoadBanlancer接入外网请求2.3、NodePort接入外网请求 3、总结和对比3.1、Ingress、NodePort和LoadBalancer总结3.2、Ingress和网关的区别 1、集群内访问 在k8s中创建的微服务&#xff0c;大部分都是在集群内…

N1912A安捷伦N1912A功率计

181/2461/8938产品概述&#xff1a; 安捷伦N1912A双通道P系列宽带功率传感器为R&D和制造工程师提供精确和可重复的功率测量&#xff0c;应用市场包括航空航天和国防&#xff08;雷达&#xff09;、无线通信和无线802.11a/b/g网络。该仪表/传感器组合提供的测量包括峰值功率…

算法训练day56leetcode300.最长递增子序列674最长连续递增序列

part13leetcode300.最长递增子序列674最长连续递增序列 718最长重复子数组 300. 最长递增子序列 本题最关键的是要想到dp[i]由哪些状态可以推出来&#xff0c;并取最大值&#xff0c;那么很自然就能想到递推公式&#xff1a;dp[i] max(dp[i], dp[j] 1); #include <iost…

c++|vector使用及模拟实现

目录 一、vector的介绍 二、vector的使用(常用接口) 2.1string类的成员函数 2.1.1构造函数 2.1.2析构函数 2.1.3“”运算符重载函数 2.2 迭代器(iterator) 及 对象的遍历访问 2.2.1iterator 2.2.2 operator[] && at() 2.2.4 back() && front() 2.2…

Springboot自动获取接口实现

ServiceLoader加载接口实现步骤 1.编写接口 public interface CommunicationAdapterFactory {void setKernel(LocalKernel kernel);boolean providesAdapterFor(Vehicle vehicle);BasicCommunicationAdapter getAdapterFor(Vehicle vehicle); }2.编写实现 // 实现类 1 publi…

计算机网络:数据链路层 - 点对点协议PPP

计算机网络&#xff1a;数据链路层 - 点对点协议PPP PPP协议的帧格式透明传输字节填充法零比特填充法 差错检测循环冗余校验 对于点对点链路&#xff0c;PPP协议是目前使用最广泛的数据链路层协议。比如说&#xff0c;当用户想要接入互联网&#xff0c;就需要通过因特网服务提供…

【随笔】Git 高级篇 -- 分离 HEAD(十一)

&#x1f48c; 所属专栏&#xff1a;【Git】 &#x1f600; 作  者&#xff1a;我是夜阑的狗&#x1f436; &#x1f680; 个人简介&#xff1a;一个正在努力学技术的CV工程师&#xff0c;专注基础和实战分享 &#xff0c;欢迎咨询&#xff01; &#x1f496; 欢迎大…

从零开始学RSA:N不互素

1.N不互素 两个n里使用有相同的素数p或q 在CTF中&#xff0c;同样一个e&#xff08;一般为65537&#xff09;和m&#xff0c; 有两个或多个n和c时&#xff0c;那么n之间可能是共享素数 2.题目 n1 10383529640908175186077053551474658681539589842726033432568031364836913…

C 回调函数的两种使用方法

对回调&#xff08;callback&#xff09;函数的一点粗陋理解&#xff0c;在我小时候&#xff0c;隔壁村有家月饼小作坊&#xff08;只在中秋那段时间手工制作一些月饼出售&#xff0c;后来好像不做了&#xff09;&#xff0c;做出的月饼是那种很传统很经典的款式&#xff0c;里…

js:使用ajax获取数据库数据(后端采用php)

前端ajax部分 AllUnsigned.php <script>//刚进入页面就执行$(document).ready(function() {// 发送AJAX请求.ajax({type: POST,url: get_allunsign.php,//请求的页面data: {//传递的参数action: noread_info,type1: type1,order_number1: order_number1,userinfo: user…

C++项目——集群聊天服务器项目(十三)客户端登录、注册、退出业务

截止到上节&#xff0c;我们已将服务器端主要代码介绍完毕&#xff0c;由于不可能一直手动输入信息&#xff0c;所以我们还需编写客户端代码&#xff0c;进行双向通信。 客户端不要求高并发&#xff0c;因此我们这里不使用muduo网络库的TcpClient类编写&#xff0c;仅采用C自带…

Lumos学习王佩丰Excel第一讲:认识Excel

最近发现自己在操作excel的一些特殊功能时会有些不顺手&#xff0c;所以索性找了一个比较全的教程&#xff08;王佩丰excel24讲&#xff09;拿来学习&#xff0c;刚好形成文档笔记&#xff0c;分享给有需要但没有时间看视频的朋友们。整体笔记以王老师授课的知识点去记录&#…

oracle19静默安装

1.安装软件包 yum install -y unixODBC gcc- gcc-c ksh compat-libstdc-33 e2fsprogs e2fsprogs-libs net-tools bc binutils compat-libcap1 elfutils-libelf elfutils-libelf-devel fontconfig-devel glibc glibc-devel ksh libaio libaio-devel libX11 libXau libXi libX…

13.2024

求最大公约数 代码&#xff1a; import java.util.Scanner;public class 第十三题 {public static void main(String[] args) {/* Scanner scnew Scanner(System.in);int asc.nextInt();int bsc.nextInt();while (b!0){int ca%b;ab;bc;}System.out.println(a);*/Scanner scne…

前端JS商品规格组合

给定一个数组 let data [{name: "颜色",specs: ["白色", "黑色"],},{name: "尺寸",specs: ["14寸","15寸", "16寸"],},{name: "处理器",specs: ["i5", "i7", "i9&…