脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → Springboot项目参数校验

Springboot项目参数校验方式(Validator)

 更新时间：2025年02月07日 09:22:43   作者：F0urtEEn  
本文介绍了如何在Spring Boot项目中使用`spring-boot-starter-validation`包和注解来实现请求参数校验,主要介绍了校验注解的使用方法、校验失败的异常捕获以及`@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，无法验证''空串
@NotBlankCharSequence子类型验证注解的元素值不为空（不为null、去除首位空格后长度为0），不同于@NotEmpty，@NotBlank只应用于字符串且在比较时会去除字符串的首位空格
@NotEmptyCharSequence子类型、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（包含）指定区间之内，如字符长度、集合大小
@PastDate、Calendar日期类型验证注解的元素值比当前时间早
@FutureDate、Calendar日期类型验证注解的元素值比当前时间晚
@LengthCharSequence子类型验证注解的元素值长度在min和max区间内
@RangeBigDecimal,BigInteger,CharSequence, byte, short, int, long等原子类型和包装类型验证注解的元素值在最小值和最大值之间
@Email(regexp=正则表达式,flag=标志的模式)CharSequence子类型验证注解的元素值是Email，也可以通过regexp和flag指定自定义的email格式
@Pattern(regexp=正则表达式,flag=标志的模式)CharSequence子类型验证注解的元素值与指定的正则表达式匹配
@Valid任何非原子类型指定递归验证关联的对象如用户对象中有个地址对象属性，如果想在验证用户对象时一起验证地址对象的话，在地址对象上加@Valid注解即可级联验证
@AssertFalseBoolean验证注解的元素值是false
@AssertTrueBoolean验证注解的元素值是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的区别

  1. @Validated是spring框架下的注解，@Valid注解时javax包下的注解
  2. @Validated对@Valid的封装，具有更强大的功能，@Validated在@Valid之上提供了分组功能和验证排序功能
  3. @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;
    }

总结

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。

您可能感兴趣的文章:

相关文章

  • Java语言实现扫雷游戏（2）

    Java语言实现扫雷游戏（2）

    这篇文章主要为大家详细介绍了Java语言实现扫雷游戏第二部分代码，文中示例代码介绍的非常详细，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
    2020-04-04
  • IntelliJ IDEA cmd和idea Terminal查看java版本不一致的解决方案

    IntelliJ IDEA cmd和idea Terminal查看java版本不一致的解决

    原来win10电脑上安装的是jdk8的版本,因某些原因,现在想换成jdk7的版本,修改环境变量后,在cmd中执行 [java -version]命令,显示的是7的版本,遇到这样的问题如何解决呢？下面小编给大家分享IntelliJ IDEA cmd和idea Terminal查看java版本不一致的解决方案,一起看看吧
    2023-09-09
  • SpringBoot参数校验之@Valid与@Validated的用法与场景

    SpringBoot参数校验之@Valid与@Validated的用法与场景

    这篇文章主要介绍了SpringBoot参数校验的用法与场景,在实际开发中,参数校验是保证接口安全性和数据完整性的重要手段,Spring Boot提供了@Valid和@Validated两个核心注解来实现参数校验,但许多开发者对它们的区别和使用场景存在疑惑,需要的朋友可以参考下
    2025-02-02
  • Java实现轻松处理日期和时间的API小结

    Java实现轻松处理日期和时间的API小结

    这篇文章主要为大家详细介绍了Java中的日期和时间API,可以轻松处理日期和时间,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下
    2024-03-03
  • Java设计模式之java状态模式详解

    Java设计模式之java状态模式详解

    这篇文章主要介绍了Java设计模式之状态模式定义与用法,结合具体实例形式详细分析了Java状态模式的概念、原理、定义及相关操作技巧,需要的朋友可以参考下
    2021-09-09
  • 搭建MyBatis-Plus框架并进行数据库增删改查功能

    搭建MyBatis-Plus框架并进行数据库增删改查功能

    这篇文章主要介绍了搭建MyBatis-Plus框架并进行数据库增删改查,本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
    2021-03-03
  • Java集合快速失败与安全失败解析

    Java集合快速失败与安全失败解析

    这篇文章主要介绍了Java集合快速失败与安全失败解析，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
    2021-11-11
  • java多线程创建及线程安全详解

    java多线程创建及线程安全详解

    多线程是日常开发中的常用知识，也是难用知识。通这篇文章主要给大家介绍了关于java多线程创建及线程安全的相关资料，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
    2021-05-05
  • Mybatis表的关联查询详情

    Mybatis表的关联查询详情

    这篇文章主要介绍了Mybatis表的关联查询详情，文章通过围绕主题展开详细的内容介绍，具有一定的参考价值，需要的小伙伴可以参考一下
    2022-09-09
  • 基于SpringBoot bootstrap.yml配置未生效的解决

    基于SpringBoot bootstrap.yml配置未生效的解决

    这篇文章主要介绍了基于SpringBoot bootstrap.yml配置未生效的解决方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
    2020-10-10

最新评论