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

于 2024-04-03 19:15:00 发布
阅读量3.2k 收藏 43
点赞数 31
分类专栏： # Spring Boot 文章标签： Valid注解详解 Validated注解详解
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_42402854/article/details/137344029
版权

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进行嵌套验证。

参考文章：

– 求知若饥，虚心若愚。

Charge8
关注
  • 31
    点赞
  • 踩
  • 43
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
spring @Validated 注解开发中使用group分组校验的实现
08-19
主要介绍了spring @Validated 注解开发中使用group分组校验的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
springboot@Valid注解用法详解
w20001118的博客
07-27 5058
Digits(integer,fraction)限制必须为一个小数，且整数部分的位数不能超过integer，小数部分的位数不能超过fraction。现在如果想要对User中的姓名和age做非空校验和长度校验，如果在接口中频繁使用if会增加很大的代码量，这个时候@Valid注解就派上了用场。@DecimalMin(value)限制必须为一个不小于指定值的数字,小数存在精度。@DecimalMax(value)限制必须为一个不大于指定值的数字,小数存在精度。@Null用在基本类型上；...
@Validated注解详解，分组校验，嵌套校验，@Valid和@Validated 区别，Spring Boot @Validated
热门推荐
qq_32352777的博客
09-05 18万+
技术栈： spring boot2.3.3.RELEASE hibernate-validator 文末附项目源代码 目录 简述 项目依赖 全局异常处理类 基础参数校验 实体类 控制类 测试 嵌套参数验证 实体类 控制类 测试 分组参数验证 接口类 实体类 控制类 测试 @Valid和@Validated 区别 简述 @Validation是一套帮助我们继续对传输的参数进行数据校验的注解，通过配置Validation可以很轻松的完成对数据的约束。 @...
SpringBoot请求参数校验@Valide和@Validated区别以及内部类参数校验失效怎么处理？
最新发布
Barry_Li1949的博客
01-11 1707
SpringBoot请求参数校验@Valide和@Validated区别以及内部类参数校验失效怎么处理？
Spring Boot中参数验证（@Valid）
make_progress的博客
04-25 289
Spring Boot中使用@Valid实现参数验证。
Spring Boot中的@Validated和@Valid
果酱 の 博客
06-14 4548
在开发Web应用程序时，输入数据的验证是一个重要的问题。@Validated和@Valid。这两种方式都可以用于验证请求参数和请求体中的数据。本文将详细介绍这两种验证方式的使用方法和区别。@Validated是Spring框架中的一个注解，它是JSR-303规范的扩展，可以用于在方法级别上校验方法参数。它可以用于验证请求参数和请求体中的数据。@Validated注解可以用于方法级别和类级别上，用于验证方法参数和类属性。@Validated和@Valid。@Validated。
Spring中参数校验@Validation注解的详细介绍
weixin_42279822的博客
08-09 1461
Valid除了使用预定义的验证注解，你还可以创建自定义的验证器来满足特定的验证需求。要创建一个自定义的验证器，需要实现接口。return age!Class
Spring Boot 如何使用 @Validated 注解进行数据校验
Java徐师兄的博客
06-22 1923
Validated是 Spring Boot 中的一个注解，用于验证方法参数、请求参数和请求体。它是中的@Valid注解的扩展，但提供了更多的功能，例如分组校验和参数校验顺序。在使用@Validated注解时，需要在 Spring Boot 应用程序中添加依赖，以便使用校验器。校验器是包中的一个实现，用于验证对象和属性。有时，内置的校验器无法满足您的需求。例如，您可能需要验证用户名是否唯一，这需要访问数据库。在这种情况下，您可以定义自己的校验器。要定义自定义校验器，请创建一个实现接口的类。
SpringBoot表单验证（注解验证）@Validated使用
伍玖的博客
03-04 1875
SpringBoot注解验证参数 导入包： import javax.validation.constraints import org.springframework.validation.annotation 注解 作用类型 解释 @NotNull 任何类型 属性不能为null @NotEmpty 集合 集合不能为null，且size大于0 @NotBlank 字符串、...
Springboot中@Validated注解的使用
Rsun2018的博客
03-04 5412
前端传过来数据的时候,要进行校验,但是大量的校验很繁琐,会造成大量的if else语句的产生,所以@Valid和@Validated很好的解决了这个问题。1、基础使用 因为spring boot已经引入了基础包，所以直接使用就可以了。首先在controller上声明@Validated需要对数据进行校验。2、然后在对应字段Get方法加上参数校验注解，如果不符合验证要求，则会以message的信息为准，返回给前端。为什么使用@Validated。也可以直接放在字段上面声明。
Springboot参数校验@Validated和@Valid区别源码
11-22
Springboot参数校验@Validated和@Valid区别源码
Springboot @Validated和@Valid的区别及使用详解
08-19
Springboot @Validated和@Valid的区别及使用详解 @Valid和@Validated是Spring Boot中两个常用的验证注解，它们都可以用于验证JavaBean的合法性，但是它们之间存在一些关键的区别。在本文中，我们将详细介绍@Valid和...
详解Spring 参数验证@Validated和@Valid的区别
08-26
@Valid 可以用在方法、构造函数、方法参数和成员属性（字段）上。 3. 嵌套验证 在比较两者的嵌套验证时，需要注意的是，在使用 @Validated 或 @Valid 时，需要在成员属性（字段）上明确指出需要进行嵌套验证的字段...
@RequestBody与@Validated使用时校验失效.md
08-02
@RequestBody与@Validated使用时校验失效.md
SpringBoot利用@Validated和@Valid进行校验参数
大灰狼的专栏
07-06 1万+
什么是Validator Spring Validation验证框架对参数的验证机制提供了@Validated（Spring's JSR-303规范，是标准JSR-303的一个变种），javax提供了@Valid（标准JSR-303规范），配合BindingResult可以直接提供参数验证结果。 @Validated是@Valid的一次封装，不是规范。 在检验Controller的入参是否符合规范时，使用@Validated或者@Valid在基本验证功能上没有太多区别。但是在分组、注解地方、嵌套验证等
SpringBoot表单验证
weixin_40455265的博客
09-30 1018
限制 说明 @Null 限制只能为null @NotNull 限制必须不为null @AssertFalse 限制必须为false @AssertTrue 限制必须为true @DecimalMax(value) 限制必须为一个不大于指定值的数字 @DecimalMin(
Spring框架 之@Valid注解的使用（嵌套类型的效验）
AlbenXie的博客
06-13 1120
@Valid注解可以实现数据的验证，你可以定义实体，在实体的属性上添加校验规则，而在API接收数据时添加@valid关键字，这时你的实体将会开启一个校验的功能。 @Valid 注解类型的使用: @Null 限制只能为null @NotNull 限制必须不为null @AssertFalse 限制必须为false @AssertTrue 限制必须为true @DecimalMax(val...
springboot中注解校验@Valid@Validated(亲测有效)
weixin_43401380的博客
09-01 5360
1.校验步骤说明 1.请求对象上添加注解@RequestBody @Vlid(源自javax.validation.Valid); 2,对象实体类中添加相关校验注解(源于javax.validation.constraints). 2.示例说明 1.请求类 package com.kawaxiaoyu.api.appointCourse.controller; import com.kawaxiaoyu.api.appointCourse.dto.ApplyInfoDto; import c
@valid和@validated注解
09-09
@Valid和@Validated注解是用于在Spring框架中进行数据校验的注解。 @Valid注解是Java标准的校验注解，它可以应用于方法参数和方法返回值上。当应用在方法参数上时，它会告诉Spring框架对该参数进行校验。当应用在方法返回值上时，它会告诉Spring框架对该返回值进行校验。 @Validated注解是Spring提供的校验注解，它是对@Valid注解的扩展和增强。@Validated注解可以应用在类、方法、接口或者方法参数上。与@Valid注解不同的是，@Validated注解支持分组校验（Group Validation），即可以指定在特定场景下才进行校验。 使用@Valid和@Validated注解需要配合校验器（Validator）来完成具体的数据校验逻辑。在Spring框架中，默认使用的是Hibernate Validator作为校验器实现，也可以自定义校验器。 总之，@Valid和@Validated注解是用于在Spring框架中进行数据校验的注解，可以帮助开发者简化数据校验的代码编写和处理过程。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值