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

news2025/1/17 18:00:23

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.coloradmin.cn/o/1569248.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

备战蓝桥杯---多路归并与归并排序刷题

备战蓝桥杯---多路归并与归并排序刷题

话不多说&#xff0c;直接看题 1. 我们考虑一行一行合并&#xff0c;一共m次&#xff0c;我们合并两个并取前n小&#xff0c;那么我们怎么取&#xff1f; 我们采用分组的思想&#xff1a; 我们选第一列的min,然后把后面那个再纳入考虑&#xff0c;用优先队列实现即可。 下面…
阅读更多...
一致性hash问题(负载均衡原理)

一致性hash问题(负载均衡原理)

一致性哈希问题 简介 一致性Hash是一种特殊的Hash算法&#xff0c;由于其均衡性、持久性的映射特点&#xff0c;被广泛的应用于负载均衡领域&#xff0c;如nginx和memcached都采用了一致性Hash来作为集群负载均衡的方案。 本文将介绍一致性Hash的基本思路&#xff0c;并讨论其…
阅读更多...
Java web第一次作业

Java web第一次作业

1.学会用记事本编写jsp文件&#xff0c;并放进tomcat的相关目录下&#xff0c;运行。 源代码&#xff1a; <% page contentType"text/html;charsetUTF-8" language"java" %> <html> <head> <title>我的第一个JSP页面</ti…
阅读更多...
视觉大模型--deter的深入理解

视觉大模型--deter的深入理解

但对于transformer用于目标检测领域的开创性模型&#xff0c;该模型言简意赅&#xff0c;但是但从论文理解&#xff0c;有很多细节都不清楚&#xff0c;尤其是解码器的query和二分图匹配(Bipartite Matching)和匈牙利算法(Hungarian Algorithm)相关&#xff0c;本文将根据代码详…
阅读更多...
我认识的Git-Git工作流

我认识的Git-Git工作流

WorkFlow 的字面意思&#xff0c;工作流&#xff0c;即工作流程。工作流不涉及任何命令&#xff0c;因为它就是一个规则&#xff0c;完全由开发者自定义&#xff0c;并且自遵守。 集中式工作流 集中式工作流以中央仓库作为项目所有修改的单点实体。相比svn缺省的开发分支trunk…
阅读更多...
基于深度学习的植物叶片病害识别系统（网页版+YOLOv8/v7/v6/v5代码+训练数据集）

基于深度学习的植物叶片病害识别系统（网页版+YOLOv8/v7/v6/v5代码+训练数据集）

摘要&#xff1a;本文深入研究了基于YOLOv8/v7/v6/v5的植物叶片病害识别系统&#xff0c;核心采用YOLOv8并整合了YOLOv7、YOLOv6、YOLOv5算法&#xff0c;进行性能指标对比&#xff1b;详述了国内外研究现状、数据集处理、算法原理、模型构建与训练代码&#xff0c;及基于Strea…
阅读更多...
FA模型切换Stage模型配置文件的差异app和deviceConfig的切换

FA模型切换Stage模型配置文件的差异app和deviceConfig的切换

FA模型切换Stage模型配置文件的差异 FA模型应用在 config.json文件 中描述应用的基本信息&#xff0c;一个应用工程中可以创建多个Module&#xff0c;每个Module中都有一份config.json文件。config.json由app、deviceConfig和module三部分组成&#xff0c;app标签用于配置应用…
阅读更多...
捷途山海T2预售正式开启，起售价18.49万元，品质与价值并存！

捷途山海T2预售正式开启，起售价18.49万元，品质与价值并存！

捷途汽车于4月2日宣布&#xff0c;旗下全新车型山海T2正式启动预售。新车预售价格区间为18.49万元-21.69万元。这款定位为“旅行越野超混SUV”的新车&#xff0c;以其独特的方盒子造型和强大的混动系统&#xff0c;吸引了众多消费者的关注。 山海T2是捷途山海系列的第二款产品&…
阅读更多...
JS详解-函数柯里化

JS详解-函数柯里化

简介&#xff1a; 柯里化&#xff08;Currying&#xff09;是一种关于函数的高阶技术。柯里化是一种函数的转换&#xff0c;它是指将一个函数从可调用的 f(a, b, c) 转换为可调用的 f(a)(b)(c)。柯里化不会调用函数。它只是对函数进行转换。 举个例子&#xff1a; 已最简单的…
阅读更多...
nvme协议学习总结

nvme协议学习总结

一、nvme命令 1 nvme在pcie基础上的协议&#xff0c;与PCIE配合&#xff0c;实现高效传输。 2 nvme命令主要分IO命令和admin命令。 3 一个NVME CMD执行流程&#xff1a; step1&#xff1a;host把cmd写入SQ queue中&#xff1b; step2&#xff1a;host远端更新Device&#x…
阅读更多...
Unity commandbuffer

Unity commandbuffer

在渲染不透明物体和天空盒之后&#xff0c;当前图像被复制到一个临时渲染目标中&#xff0c;模糊并设置为全局着色器属性。然后在玻璃物体上的着色器对模糊的图像进行采样&#xff0c;基于法线贴图的UV坐标偏移来模拟折射。这类似于shader GrabPass所做的&#xff0c;除了你可以…
阅读更多...
解密辛普森悖论：如何在数据分析中保持清醒头脑

解密辛普森悖论：如何在数据分析中保持清醒头脑

解密辛普森悖论&#xff1a;如何在数据分析中保持清醒头脑 之前也参加fine Bi的 培训&#xff0c;学到了辛普森悖论&#xff0c;今天为大家介绍一下 文章目录 解密辛普森悖论&#xff1a;如何在数据分析中保持清醒头脑前言我们来举一个例子数据分析解释管理应用的启示 前言 什…
阅读更多...
Game Framework框架Builder窗口展示不完全问题解决方案

Game Framework框架Builder窗口展示不完全问题解决方案

Game Framework框架Builder窗口展示不完全问题解决方案 问题描述解决方法 问题描述 最近在使用&#xff08;研究&#xff09;GF框架进行AssetBundle打包的时候&#xff0c;打开Builder窗口时发现下面的打包按钮被遮挡了&#xff0c;而且也没有滑动条可以滑动。 上网搜了一圈也…
阅读更多...
文字超出收起展开功能的实现（vue2）

文字超出收起展开功能的实现（vue2）

1.编写展开收起组件 <template><div class"text-clamp"><div class"text" :style"{height}"><span v-if"isVisible" class"btn" click"toggle">{{isExpand ? 收起 : ... 展开}}</spa…
阅读更多...
简约好用的TCPUDP小工具

简约好用的TCPUDP小工具

csdn下载地址&#xff1a; https://download.csdn.net/download/a876106354/89077745
阅读更多...
Echarts自定义折线图的节点与图标

Echarts自定义折线图的节点与图标

文章目录 需求分析 需求 如图所示需要自定义节点的图标展示 分析 首先需要 symbol 属性添加引入 需要用到一个工具&#xff1a;http://tu.chacuo.net/imagetodataurl 这里是我的几个图片转出来的svg export const lineColors [#FF5360,#45CB85,#EEB902,#9CEC0F,#FF9562,#…
阅读更多...
书生作业2

书生作业2

Task 1 生成200字以上的笑话&#xff0c;可以看到使用不同的提示词&#xff0c;会有不同的效果。 如果使用提示词“讲一个笑话.200字以上”&#xff0c; 会有偶发的输出较短的笑话的情况。 如果使用提示词“讲一个200字以上的笑话”时&#xff0c;结果相对稳定。 下载目前两种…
阅读更多...
Collection与数据结构 Stack与Queue(一): 栈与Stack

Collection与数据结构 Stack与Queue(一): 栈与Stack

1. 栈 1.1 概念 栈&#xff1a;一种特殊的线性表&#xff0c;其只允许在固定的一端进行插入和删除元素操作。进行数据插入和删除操作的一端称为栈顶&#xff0c;另一端称为栈底。栈中的数据元素遵守后进先出LIFO&#xff08;Last In First Out&#xff09;的原则。 压栈&…
阅读更多...
STL常用容器（2）---vector容器

STL常用容器（2）---vector容器

1.1 vector基本概念 功能&#xff1a; vector数据结构和数组非常相似&#xff0c;也称为单端数组 vector与普通数组区别&#xff1a; 不同之处在于数组是静态空间&#xff0c;而vector可以动态扩展 动态扩展&#xff1a; 并不是在原空间之后的续接的新空间&#xff0c;而…
阅读更多...
腾讯云4核8G配置的服务器有哪些优惠？价格好不？

腾讯云4核8G配置的服务器有哪些优惠？价格好不？

2024年腾讯云4核8G服务器租用优惠价格&#xff1a;轻量应用服务器4核8G12M带宽646元15个月&#xff0c;CVM云服务器S5实例优惠价格1437.24元买一年送3个月&#xff0c;腾讯云4核8G服务器活动页面 txybk.com/go/txy 活动链接打开如下图&#xff1a; 腾讯云4核8G服务器优惠价格 轻…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023