Springboot项目参数校验（Validator）

F0urtEEn

已于 2024-12-30 00:05:29 修改

阅读量4.6k

点赞数 18

分类专栏： Spring&SpringBoot 文章标签： spring boot

于 2023-07-01 20:20:19 首次发布

本文链接：https://blog.youkuaiyun.com/nuoya989/article/details/131493071

版权

Spring&SpringBoot 专栏收录该内容

3 篇文章

订阅专栏

本文介绍了如何在SpringBoot项目中使用spring-boot-starter-validation包进行请求参数校验，详细阐述了@Validated和@Valid的区别，以及如何使用各种校验注解，如@NotNull、@Length等。同时，文章还提到了校验失败的异常处理和@Validated的分组功能，展示了如何根据不同的分组实现不同的验证机制。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

一、 pom文件引入依赖

二、校验注解列表

三、校验注解用法

四、@Validated 与 @Valid的区别

五、校验失败的异常捕获

六、@Validated的分组功能

我们使用spring-boot-starter-validation 包+注解的方式来实现springboot项目中请求参数校验。其中spring-boot-starter-validation包中依赖了hibernate-validator包，校验功能就是hibernate-validator包所提供的。

一、 pom文件引入依赖

<!--validation校验依赖包 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-validation</artifactId>
</dependency>

<!--
    <dependency>
            <groupId>org.hibernate</groupId>
            <artifactId>hibernate-validator</artifactId>
     </dependency>
-->

引入spring-boot-starter-validation 包后，可以看见包中依赖了hibernate-validator

二、校验注解列表

下面的注解用于修饰在需要校验的实体类属性上方，或者直接用于修饰请求接口的参数。

注解	作用数据类型	说明
@Null	任意类型	验证注解的元素值是null
@NotNull	任意类型	验证注解的元素值不是null，无法验证''空串
@NotBlank	CharSequence子类型	验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@NotEmpty	CharSequence子类型、Collection、Map、数组	验证注解的元素值不为null且不为空（字符串长度不为0、集合大小不为0）
@Min	任何Number类型	验证注解的元素值大于等于@Min指定的值
@Max	任何Number类型	验证注解的元素值小于等于@Max指定的值
@DecimalMin	任何Number类型	验证注解的元素值大于等于@ DecimalMin指定的值
@DecimalMax	任何Number类型	验证注解的元素值小于等于@ DecimalMax指定的值
@Digits(integer=整数位数, fraction=小数位数)	任何Number类型	验证注解的元素值的整数位数和小数位数上限
@Size	字符串、Collection、Map、数组等	验证注解的元素值的在min和max（包含）指定区间之内，如字符长度、集合大小
@Past	Date、Calendar日期类型	验证注解的元素值比当前时间早
@Future	Date、Calendar日期类型	验证注解的元素值比当前时间晚
@Length	CharSequence子类型	验证注解的元素值长度在min和max区间内
@Range	BigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型	验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)	CharSequence子类型	验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)	CharSequence子类型	验证注解的元素值与指定的正则表达式匹配
@Valid	任何非原子类型	指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证
@AssertFalse	Boolean	验证注解的元素值是false
@AssertTrue	Boolean	验证注解的元素值是true

三、校验注解用法

1. 注解用于修饰在需要校验的实体类属性上方

注解的参数message 用于自定义校验提示信息。

public class User {

    @NotNull
    @Length(min = 2, max = 10, message = "用户名字必须在2到10个字母")
    private String name;

    @Min(1)
    @Max(100)
    private int age;

    @NotBlank(message = "联系邮箱不能为空")
    @Email(message = "邮箱格式不对")
    private String email;

    @NotBlank(message = "手机号不能为空")
    @Pattern(regexp = "^[1][3,4,5,6,7,8,9][0-9]{9}$", message = "手机号格式有误")
    private String mobile;
}

然后在请求接口方法参数上用@Validated或@Valid修饰，不然校验不生效。

@RestController
@RequestMapping("/test")
public class TestController {

    @RequestMapping("/01")
    public Object test01(@Validated User user) {

        System.out.println("===> user: "+user);
        return user;
    }

    @RequestMapping("/02")
    public Object test02(@Valid User user) {

        System.out.println("===> user: "+user);
        return user;
    }
}

2. 直接用于修饰请求接口的参数

这种方式需要在接口类上面添加@Validated，不然校验不生效。

@RestController
@RequestMapping("/test")
@Validated
public class TestController {

    @RequestMapping("/01")
    public Object test01(@NotNull String name, @Min(1) @Max(100) Integer age) {

        System.out.println("===> name: "+name+", age="+age);
        return name;
    }

    @RequestMapping("/02")
    public Object test02(@Email(message = "邮箱格式不对") String email) {

        System.out.println("===> email: "+email);
        return email;
    }

四、@Validated 与 @Valid的区别

@Validated是spring框架下的注解，@Valid注解时javax包下的注解
@Validated对@Valid的封装，具有更强大的功能，@Validated在@Valid之上提供了分组功能和验证排序功能
@Valid注解可以用在成员属性上，提供成员属性是对象类型的嵌套校验功能

五、校验失败的异常捕获

1. @Validated或@Valid注解的请求参数后面紧跟一个BindingResult对象参数，用于封装校验异常信息。 注意的是这种方式就不再抛出校验异常了。

    @RequestMapping("/01")
    public Object test01(@Validated User user, BindingResult result) {
        System.out.println("===> user: "+user);
        List<ObjectError> allErrors = result.getAllErrors();
        if (result.hasErrors()) {
            allErrors.forEach(item -> {
                System.out.println(item.getDefaultMessage());
            });
        }

        return user;
    }

    @RequestMapping("/02")
    public Object test02(@Valid User user, BindingResult result) {

        System.out.println("===> user: "+user);
        List<FieldError> fieldErrors = result.getFieldErrors();
        if (result.hasFieldErrors()) {
            fieldErrors.forEach(item -> {
                System.out.println(item.getDefaultMessage());
            });
        }
        return user;
    }

2. 使用全局异常类@RestControllerAdvice 捕捉校验失败的异常

校验失败会抛出BindException, ConstraintViolationException， MethodArgumentNotValidException 三种异常

@RestControllerAdvice
public class GlobalExceptionHandler {

    /**
     * BindException验证异常
     */
    @ExceptionHandler(BindException.class)
    public AjaxResult handleBindException(BindException e)
    {
        BindingResult bindingResult = e.getBindingResult();
        StringBuilder sb = new StringBuilder("校验失败:");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
        String msg = sb.toString();
        log.error(msg);
        return AjaxResult.error(msg);
    }

    /**
     * MethodArgumentNotValidException验证异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e)
    {
        BindingResult bindingResult = e.getBindingResult();
        StringBuilder sb = new StringBuilder("校验失败:");
        for (FieldError fieldError : bindingResult.getFieldErrors()) {
            sb.append(fieldError.getField()).append("：").append(fieldError.getDefaultMessage()).append(", ");
        }
        String msg = sb.toString();
        log.error(msg);
        return AjaxResult.error(msg);
    }

    /**
     * ConstraintViolationException异常
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public AjaxResult handleConstraintViolationException(ConstraintViolationException e)
    {
        log.error(e.getMessage(), e);
        return AjaxResult.error(e.getMessage());
    }
}

六、@Validated的分组功能

@Validated具有分组功能，可以根据不同的分组采用不同的验证机制。

1. 自定义group接口并实现父接口javax.validation.groups.Default

import javax.validation.groups.Default;

public interface AddGroup extends Default {

}


import javax.validation.groups.Default;

public interface UpdateGroup extends Default {

}

2. 校验注解上提供参数groups，参数值就是上面自定义的接口。

public class User {

    @NotNull
    @Length(min = 2, max = 10, groups = UpdateGroup.class)
    private String name;

    @Min(value = 1, groups = AddGroup.class)
    @Max(value = 100, groups = AddGroup.class)
    @NotNull
    private int age;

    @NotBlank(message = "联系邮箱不能为空", groups = UpdateGroup.class)
    @Email(message = "邮箱格式不对", groups = AddGroup.class)
    private String email;

}

3. 给@Validated注解参数value附上不同的分组类，这样校验就会根据相同的group类来校验

    @RequestMapping("/01")
    public Object test01(@Validated(value = AddGroup.class) User user, BindingResult result) {
        System.out.println("===> user: "+user);
        List<ObjectError> allErrors = result.getAllErrors();
        if (result.hasErrors()) {
            allErrors.forEach(item -> {
                System.out.println(item.getDefaultMessage());
            });
        }

        return user;
    }

    @RequestMapping("/02")
    public Object test02(@Validated(value = UpdateGroup.class) User user, BindingResult result) {

        System.out.println("===> user: "+user);
        List<FieldError> fieldErrors = result.getFieldErrors();
        if (result.hasFieldErrors()) {
            fieldErrors.forEach(item -> {
                System.out.println(item.getDefaultMessage());
            });
        }
        return user;
    }