1. Toy模板网首页
  2. > Toy博客

@Valid、@Validated参数校验详解

7月前 作者：liudachu 分类：Toy博客 阅读(28) 违法举报

这篇具有很好参考价值的文章主要介绍了@Valid、@Validated参数校验详解。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

@Valid与@Validated作用

@Valid与@Validated都是用来校验接收参数的。
 
@Valid是使用Hibernate validation的时候使用
 
@Validated是只用Spring Validator校验机制使用
 
说明：java的JSR303声明了@Valid这类接口，而Hibernate-validator对其进行了实现。
 
 
 
@Validated与@Valid区别：
 
@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上，不支持嵌套检测
@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上，支持嵌套检测
 
 
 
注意:SpringBoot使用@Valid注解需要引入如下POM
 
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-validation</artifactId>
</dependency>

校验参数注解含义

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-M6CfNsNC-1687851467867)(images/20200913110853722.png)]

全局异常处理类

说明：若不做异常处理，@Validated注解的默认异常消息如下（示例）：

2020-09-05 21:48:38.106  WARN 9796 --- [nio-8080-exec-3] .w.s.m.s.DefaultHandlerExceptionResolver : Resolved [org.springframework.web.bind.MethodArgumentNotValidException: Validation failed for argument [0] in public java.lang.String com.example.validateddemo.controller.DemoController.validatedDemo1(com.example.validateddemo.entity.dto.UseDto): [Field error in object 'useDto' on field 'username': rejected value [null]; codes [NotBlank.useDto.username,NotBlank.username,NotBlank.java.lang.String,NotBlank]; arguments [org.springframework.context.support.DefaultMessageSourceResolvable: codes [useDto.username,username]; arguments []; default message [username]]; default message [用户名不能为空！]] ]

因此我们在这里做了一个全局的异常处理类，用于处理参数校验失败后抛出的异常，同时进行日志输出。

package com.example.validateddemo.handler;
 
import com.example.validateddemo.base.Result;
import com.example.validateddemo.enums.ResultEnum;
import com.example.validateddemo.utils.ResultUtil;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.validation.BindingResult;
import org.springframework.validation.FieldError;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.ResponseStatus;
import java.util.List;
 
/**
 * @author He Changjie on 2020/9/5
 */
@Slf4j
@ControllerAdvice
public class ValidatedExceptionHandler {
 
    /**
     * 处理@Validated参数校验失败异常
     * @param exception 异常类
     * @return 响应
     */
    @ResponseBody
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Result exceptionHandler(MethodArgumentNotValidException exception){
        BindingResult result = exception.getBindingResult();
        StringBuilder stringBuilder = new StringBuilder();
        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            if (errors != null) {
                errors.forEach(p -> {
                    FieldError fieldError = (FieldError) p;
                    log.warn("Bad Request Parameters: dto entity [{}],field [{}],message [{}]",fieldError.getObjectName(), fieldError.getField(), fieldError.getDefaultMessage());
                    stringBuilder.append(fieldError.getDefaultMessage());
                });
            }
        }
        return ResultUtil.validatedException(stringBuilder.toString());
    }
}

基础参数校验

实体类

package com.example.validateddemo.entity.dto;
 
import lombok.Data;
import org.springframework.format.annotation.DateTimeFormat;
 
import javax.validation.constraints.*;
 
/**
 * 用户实体
 * 数据传输对象
 * @author He Changjie on 2020/9/5
 */
@Data
public class User1Dto {
    /**
     * 用户名
     */
    @NotBlank(message = "用户名不能为空！")
    private String username;
    /**
     * 性别
     */
    @NotBlank(message = "性别不能为空！")
    private String gender;
    /**
     * 年龄
     */
    @Min(value = 1, message = "年龄有误！")
    @Max(value = 120, message = "年龄有误！")
    private int age;
    /**
     * 地址
     */
    @NotBlank(message = "地址不能为空！")
    private String address;
    /**
     * 邮箱
     */
    @Email(message = "邮箱有误！")
    private String email;
    /**
     * 手机号码
     */
    @Pattern(regexp = "^(13[0-9]|14[579]|15[0-3,5-9]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$",message = "手机号码有误！")
    private String mobile;
}

控制类

package com.example.validateddemo.controller;
 
import com.example.validateddemo.entity.dto.Use1Dto;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @author He Changjie on 2020/9/5
 */
@RestController
@RequestMapping("/api/v1")
public class Demo1Controller {
 
    @PostMapping("/insert")
    public String validatedDemo1(@Validated @RequestBody Use1Dto use1Dto){
        System.out.println(use1Dto);
        return "success";
    }
}

测试

1、参数校验不通过：

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-qZ6aFCYZ-1687851467868)(images/20200905225032404.png)]

嵌套参数验证

验证实体中的其他需要被验证的对象集合或其他对象

实体类

package com.example.validateddemo.entity.dto;
 
import lombok.Data;
 
import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import javax.validation.constraints.NotNull;
import java.util.List;
 
/**
 * 队伍实体
 * 数据传输对象
 * @author He Changjie on 2020/9/5
 */
@Data
public class Team1Dto {
    /**
     * 队伍名称
     */
    @NotBlank(message = "队伍名称不能为空！")
    private String name;
    /**
     * 队伍人员
     */
    @NotNull(message = "队伍人员不能为空！")
    @Valid
    private List<User1Dto> userList;
 
    /**
     * 队伍负责人
     */
    @NotNull(message = "队伍负责人不能为空！")
    @Valid
    private User1Dto user;
}

控制类

package com.example.validateddemo.controller;
 
import com.example.validateddemo.base.Result;
import com.example.validateddemo.entity.dto.Team1Dto;
import com.example.validateddemo.entity.dto.Use1Dto;
import com.example.validateddemo.utils.ResultUtil;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @author He Changjie on 2020/9/5
 */
@RestController
@RequestMapping("/api/v1")
public class Demo1Controller {
 
    @PostMapping("/insert")
    public Result validatedDemo1(@Validated @RequestBody Use1Dto use1Dto){
        return ResultUtil.success(use1Dto);
    }
 
    @PostMapping("/insert2")
    public Result validatedDemo2(@Validated @RequestBody Team1Dto team1Dto){
        return ResultUtil.success(team1Dto);
    }
}

分组参数验证

将不同的校验规则分给不同的组，在使用时，指定不同的校验规则，可以用于更新和新增接口不同的校验规则

接口类

package com.example.validateddemo.interfaces;
 
/**
 * 校验分组1
 * @author He Changjie on 2020/9/5
 */
public interface Group1 {
}

package com.example.validateddemo.interfaces;
 
/**
 * 校验分组2
 * @author He Changjie on 2020/9/5
 */
public interface Group2 {
}

实体类

package com.example.validateddemo.entity.dto;
 
import com.example.validateddemo.interfaces.Group1;
import com.example.validateddemo.interfaces.Group2;
import lombok.Data;
 
import javax.validation.constraints.*;
 
/**
 * @author He Changjie on 2020/9/5
 */
@Data
public class User2Dto {
    /**
     * 用户名
     */
    @NotBlank(message = "用户名不能为空！", groups = {Group1.class})
    private String username;
    /**
     * 性别
     */
    @NotBlank(message = "性别不能为空！")
    private String gender;
    /**
     * 年龄
     */
    @Min(value = 1, message = "年龄有误！", groups = {Group1.class})
    @Max(value = 120, message = "年龄有误！", groups = {Group2.class})
    private int age;
    /**
     * 地址
     */
    @NotBlank(message = "地址不能为空！")
    private String address;
    /**
     * 邮箱
     */
    @Email(message = "邮箱有误！", groups = {Group2.class})
    private String email;
    /**
     * 手机号码
     */
    @Pattern(regexp = "^(13[0-9]|14[579]|15[0-3,5-9]|16[6]|17[0135678]|18[0-9]|19[89])\\d{8}$",message = "手机号码有误！", groups = {Group2.class})
    private String mobile;
}

控制类

package com.example.validateddemo.controller;
 
import com.example.validateddemo.base.Result;
import com.example.validateddemo.entity.dto.Team1Dto;
import com.example.validateddemo.entity.dto.User1Dto;
import com.example.validateddemo.entity.dto.User2Dto;
import com.example.validateddemo.interfaces.Group1;
import com.example.validateddemo.interfaces.Group2;
import com.example.validateddemo.utils.ResultUtil;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
 
/**
 * @author He Changjie on 2020/9/5
 */
@RestController
@RequestMapping("/api/v1")
public class Demo1Controller {
 
    @PostMapping("/insert")
    public Result validatedDemo1(@Validated @RequestBody User1Dto user1Dto){
        return ResultUtil.success(user1Dto);
    }
 
    @PostMapping("/insert2")
    public Result validatedDemo2(@Validated @RequestBody Team1Dto team1Dto){
        return ResultUtil.success(team1Dto);
    }
 
    @PostMapping("/insert3")
    public Result validatedDemo3(@Validated @RequestBody User2Dto user2Dto){
        return ResultUtil.success(user2Dto);
    }
 
    @PostMapping("/insert4")
    public Result validatedDemo4(@Validated(Group1.class) @RequestBody User2Dto user2Dto){
        return ResultUtil.success(user2Dto);
    }
 
    @PostMapping("/insert5")
    public Result validatedDemo5(@Validated(Group2.class) @RequestBody User2Dto user2Dto){
        return ResultUtil.success(user2Dto);
    }
}

@Valid和@Validated 区别

通过源码分析：

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

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

@Valid：没有分组的功能。

@Validated：提供了一个分组功能，可以在入参验证时，根据不同的分组采用不同的验证机制

嵌套验证

@Validated：可以用在类型、方法和方法参数上。但是不能用在成员属性（字段）上，不支持嵌套检测，只能通过@Valid配合实现嵌套校验。

@Valid：可以用在方法、构造函数、方法参数和成员属性（字段）上，支持嵌套检测，可以用在list，set等集合上实现嵌套校验文章来源地址https://www.toymoban.com/news/detail-506814.html

到了这里，关于@Valid、@Validated参数校验详解的文章就介绍完了。如果您还想了解更多内容，请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章，希望大家以后多多支持TOY模板网！

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处： 如若内容造成侵权/违法违规/事实不符，请点击违法举报进行投诉反馈，一经查实，立即删除！

分享到：
领支付宝红包 赞助服务器费用

相关文章

  • spring参数校验@Validated及嵌套校验

    本文介绍项目中校验 @Validated的使用，主要分参数对象属性校验，嵌套校验，集合在对象属性中校验，集合作为参数校验。 controller层 测试输入 输出 这里作为参数，如果使用List接收是不起作用的，必须用ValidList，这个类中有标记 @Valid @Valid private ListE list = new ArrayList(); 如果在

    2024年02月09日
    浏览(36)

  • spring-boot 请求参数校验：注解 @Validated 的使用、手动校验、自定义校验

    spring-boot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。 spring-boot已经引入了基础包，所以直接使用就可以。 在属性上添加校验注解： 在Controller上添加 @Validated 注解 校验未通过时，可能看到： 在 @Validated 后面紧跟着追加BindingResult，

    2023年04月16日
    浏览(91)

  • java如何优雅的实现参数非空校验，快速实现参数非空校验，使用@valid实现参数非空校验

    在java项目接口中，有些必传参数需要进行非空校验，如果参数过多，代码会繁杂且冗余，如何优雅的对参数进行非空校验，下面是实现流程 用实体类接收参数，使用非空注解编辑参数内容 使用 @Valid 注解对参数进行拦截，整体进行非空校验 如果是SpringBoot项目，引入web开发包

    2024年02月08日
    浏览(34)

  • Java参数校验@Valid中@Length和@Size的用法和区别

    在Spring框架中，@Length和@Size都是用于参数长度校验的注解，但它们之间存在一些关键的区别： @Length 是Hibernate Validator提供的一个注解，它用于校验字符串的长度。 @Size 也是Hibernate Validator提供的注解，但它可以用于多种数据类型，不仅仅是字符串。对于字符串，它可以校验长

    2024年04月15日
    浏览(30)
  • Spring Boot @Validated 和Javax的@Valid配合使用

    Spring Boot @Validated 和Javax的@Valid配合使用

    @Validation 和@Valid 常常配合使用对传输的参数进行数据校验的注解，并通过配置全局异常处理器进行合理化的提示，增加用户的体验 并且@Validated可以通过分组来指定什么时候触发什么样的参数校验（这里看一下就行，下面有说什么是分组） 其实不用这两个注解也可以完成对传

    2024年02月09日
    浏览(22)
  • 如何优雅的写代码-替代大量if else的@valid、@validated注解

    如何优雅的写代码-替代大量if else的@valid、@validated注解

    @Valid 注解通常用于对象属性字段的规则检测，具体啥意思，下面让我娓娓道来： 下面我们以新增一个员工为功能切入点，以常规写法为背景，慢慢烘托出 @Valid 注解用法详解。 那么，首先，我们会有一个员工对象 Employee，如下 ：首先我们会有一个员工对象 Employee，如下 ：

    2024年01月18日
    浏览(31)
  • Springboot——@valid 做字段校验和自定义注解

    Springboot——@valid 做字段校验和自定义注解

    再项目开发中，针对前端传递的参数信息，有些接口中需要写大量的 if 判断，导致代码臃肿，不够优雅。 此时，可以使用 @Valid 实现基本的字段校验。 springboot 2.3之前 ，直接进行开发即可，无需引用额外的依赖 集成在 spring-boot-starter-web 中。 springboot 2.3之后 需要额外引入

    2023年04月26日
    浏览(50)

  • Golang校验字符串是否JSON格式方法json.Valid源码解析

    上篇文章《Golang中如何校验字符串是否为JSON格式？》主要讲解了使用json.Valid校验字符串是否JSON格式的使用方法，本文来剖析一下json.Valid方法的源码。 json.Valid方法定义： scan := newScanner() 获取一个 scanner 类型的对象，关键的是checkValid方法，checkValid源码如下： 首先调用了sc

    2023年04月26日
    浏览(34)
  • 还在用 if else 做参数校验？快来学习高级参数校验吧

    还在用 if else 做参数校验？快来学习高级参数校验吧

    在上一篇文章 Springboot实现优雅的参数校验（Spring Validation）和 if else说再见，我们介绍了 Spring Validation 的初级用法，在实际开发中，无论是 Bean Validation 定义的约束，还是 Hibernate Validator 附加的约束，都是无法满足我们复杂的业务场景。所以，我们需要自定义约束。开发自定

    2023年04月14日
    浏览(46)
  • 接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

    接收来自客户端的参数使用【JSR303校验框架】进行校验参数是否合法

    目录 1：JSR303校验 1.1：统一校验的需求 1.2：统一校验实现 1.3：分组校验 1.4：校验规则不满足？ 前端请求后端接口传输参数，是在controller中校验还是在Service中校验？ 答案是都需要校验，只是分工不同。 Contoller中校验请求参数的合法性，包括：必填项校验，数据格式校验，

    2023年04月27日
    浏览(30)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包，优惠每天领

二维码1

领取红包

二维码2

领红包