快速校验实体类时,@Valid,@Validated,@NotNull注解无效的解决

142 阅读 0 评论 94 点赞

我是靠谱客的博主洁净流沙，最近开发中收集的这篇文章主要介绍快速校验实体类时,@Valid,@Validated,@NotNull注解无效的解决，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

校验实体类参数内容不能为空时使用注解校验无效

使用@valid注解首先引入依赖

如果是SpringBoot项目，引入web开发包，就不需要再单独引入@valid依赖了、因为他存在于Web开发包中的最核心之中

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.0.5.RELEASE</version>
</dependency>

如果不是SpringBoot项目，要在Maven的Pom中显式引入@valid依赖

<dependency>
    <groupId>javax.validation</groupId>
    <artifactId>validation-api</artifactId>
    <version>1.1.0.Final</version>
</dependency>
 
<dependency>
    <groupId>org.hibernate</groupId>
    <artifactId>hibernate-validator</artifactId>
    <version>5.4.1.Final</version>
</dependency>

校验实体类大部分人使用的方法肯定都是controller层里面拿出来判断是否为空，其实可以直接通过实体类中的注释@NotNull直接校验，如图

但经过我的实验，不知道什么原因，在我的项目中并没有起到作用，解决如下

1、更换方法入参类型

在网上看到@Valid是可以用在方法、构造函数、方法参数和成员属性（字段）上，而我一开始controller层中使用的是json接收的，转换成实体类后再校验的，如图

修改如下：在controller接收数据时直接以对象接收，在入口中直接以注解进行校验

2、错误内容过多

此时对象字段校验生效，但是出错时返回的是很凌乱的内容，如图：

3、使用对象接收错误内容，按自己要求输出

上面的图片可看出，返回内容中defaultMessage就是想要输出的内容，所以在方法中添加一个接收错误信息的类型为BindingResult的对象，如果对象有数据，则输出错误数据，如图：

另一层面的实现了实体类的参数校验，大家如果有更好的方法可以留言交流

springboot 校验机制 @Validated @Valid

1、探究原因

在开发的过程中一直迷惑 @Validated 与 @Valid 的用法，有时候是@Validated ，有时候是@Valid 。虽然能够实现校验，但是还是不够明确何时能够生效，不了解他生效的情况

首先定位2个注解所属的包：

@Validated 在 spring-context 包下属于spring 提供的核心包

@Valid 在 validation-api 包下 2.0.2 版本

@Validated 是spring 核心包，是每个项目都有的，那么 api 是如何引入的? 查看maven 依赖

原来是在引入 Spring-boot-start-web 的时候，就引入了该依赖

两个注解存在不同的包，而@NotNull ,@Null ,@Size ，@Max 等校验注解是哪里的呢？

这些注解都是在 api 包下

2、使用@Validated 实现校验机制

情景一：查询参数是一个实体，Get 请求，在不添加任何注解的情况下，查询是正常的，实体参数字段都为null

现在需求 id 字段不能为空，在实体id 字段标记 @NotNull ,继续查询，发现注解没有生效

经过测试，只有请求实体参数列表前加@Validated 才会生效，即使@Validated 加在类上也无法生效

情景二：查询参数是基本或者引用类型字段，参数列表中加入 @NutNull 修改该字段。发现无法生效

经过测试：只有全局类上加@Validated 才会生效，即使参数列表中加入 @Validated 也无法生效

产生异常也有所不同：在校验生效的情况下，实体类校验产生的异常是：BindException , 而参数列表产生的异常是:ConstraintViolationException

3、使用@Valid 实现校验机制

场景一：与上述一致，只有@Valid 作用在参数列表前才会生效

场景二：@Valida 不管是左右在参数列表还是类上，都无法生效。只能使用@Validated 全局设置

结论：暂不清楚@Valid 设计出现的原因，所以的校验@Validate 均可以实现

附加全局异常捕获：

@RestControllerAdvice
public class GlobalException {
    @ExceptionHandler({BindException.class})
    public RespResult validationException(BindException exception){
        List<ObjectError> errors =  exception.getAllErrors();
        if(!CollectionUtils.isEmpty(errors)){
            StringBuilder sb = new StringBuilder();
            errors.forEach(e->sb.append(e.getDefaultMessage()).append(","));
            return new RespResult(400, sb.toString());
        }
        return new RespResult(500, exception.getLocalizedMessage());
    }
    @ExceptionHandler({ConstraintViolationException.class})
    public RespResult constraintViolationException(ConstraintViolationException exception){
        Set<ConstraintViolation<?>> constraintViolations = exception.getConstraintViolations();
        if(!CollectionUtils.isEmpty(constraintViolations)){
            StringBuilder sb = new StringBuilder();
            constraintViolations.forEach(e->sb.append(e.getMessage()).append(","));
            return new RespResult(400, sb.toString());
        }
        return new RespResult(500, exception.getLocalizedMessage());
    }
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持靠谱客。