SpringMVC校验注解不生效

简介

SpringMVC框架提供了SPI扩展:javax.validation.spi.ValidationProvider,用来实现参数校验功能。Spring使用hibernate-validator作为它的默认实现,我们只需要进行一些简单的注解声明,就可以达到参数校验的功能。但是在实际使用场景中,经常会出现校验没生效的问题。

原因分析

  1. 检查jar包依赖。
    需要确报项目引入hibernate-validator以及与之匹配的validation-api版本,推荐直接依赖spring-boot-starter-validation
xml 复制代码
<dependency>
	<groupId>org.springframework.boot</groupId>
	<artifactId>spring-boot-starter-validation</artifactId>
</dependency>

最好检查下pom实际生效的依赖,有可能因为项目中显示引入了这两个包或者其他包间接依赖了这两个包导致他们版本不匹配。hibernate-validator依赖的validator-api才是它支持的版本。

  1. 检查注解是否正确

    新版本J2EE已经把javax包改成了jarkata包,检查项目中的validation-api中校验注解的包路径,选择与之匹配的注解。
    javax.validation.constraints.NotNull, jakarta.validation.constraints.NotNull

  2. 检查方法签名中,参数签名是否加了@Valid注解,必须加了@Valid注解的参数才会被校验。

  3. 检查参数是不是List类型,目前List不会被校验。

  4. 检查复杂字段上是否有@Valid注解,成员变量如果不是基本类型,需要在上面使用@Valid注解。

  5. 其他情况可以打断点排查:org.hibernate.validator.internal.engine.ValidatorImpl#validate

解决方案

对于参数是List类型,需要自己新建一个ValidationUtil类,在方法开始处手动调用校验。

java 复制代码
public class ValidationUtil {

    private static final Validator validator;

    static {
        validator = Validation.buildDefaultValidatorFactory().getValidator();
    }

    public static void validate(Object object, String objectName) {
        if (object instanceof List) {
            for (Object obj : (List<?>) object) {
                validateEntity(obj, objectName);
            }
        } else {
            validateEntity(object, objectName);
        }
    }

	@SneakyThrows
    private static void validateEntity(Object object, String objectName) {
        Set<ConstraintViolation<Object>> constraintViolations = validator.validate(object);
        if (!constraintViolations.isEmpty()) {
            throw new MethodArgumentNotValidException(null, createBindingResult(constraintViolations, objectName));
        }
    }

    private static BindingResult createBindingResult(Set<ConstraintViolation<Object>> violations, String objectName) {
        List<FieldError> fieldErrors = new ArrayList<>();

        for (ConstraintViolation<Object> violation : violations) {
            FieldError fieldError = new FieldError(
                    objectName,
                    violation.getPropertyPath().toString(),
                    violation.getMessage()
            );
            fieldErrors.add(fieldError);
        }

        return new BeanPropertyBindingResult(null, objectName, false, 256) {
            @NotNull
            @Override
            public List<FieldError> getFieldErrors() {
                return fieldErrors;
            }
        };
    }
}

// 调用方法
ValidationUtil.validate(paramValue, "param name");
相关推荐
杨杨杨大侠4 分钟前
Atlas Mapper 教程系列 (1/10):框架概述与设计思路
java·开源·github
椰椰椰耶16 分钟前
[Spring Cloud][3]从零开始简单工程搭建实践详解,远程调用
java·数据库·spring cloud
兔子撩架构27 分钟前
Akka Cluster的整体应用:系统管理的核心支撑
java·架构
毕设源码-李学长31 分钟前
计算机毕业设计java高校多媒体教室管理系统高校多媒体教室综合管理系统高校智能多媒体教室管理平台
java·开发语言·课程设计
AAA修煤气灶刘哥32 分钟前
从 Timer 到 XXL-Job,定时任务调度的 “进化史”,看完再也不怕漏跑任务~
java·后端·架构
Funcy1 小时前
XxlJob 源码分析04:admin与executor通讯
java
托比-马奎尔1 小时前
初识SpringBoot
java·spring boot·后端
前行的小黑炭1 小时前
Android :如何提升代码的扩展性,方便复制到其他项目不会粘合太多逻辑,增强你的实战经验。
android·java·kotlin
-凌凌漆-1 小时前
【Qt】【C++】虚析构函数及 virtual ~Base() = default
java·c++·qt
凯尔萨厮1 小时前
Java学习笔记四(继承)
java·笔记·学习