如何解决@Valid对象嵌套List对象校验无效问题

 更新时间:2024年07月11日 09:29:54   作者:Thomas & Friends  
这篇文章主要介绍了如何解决@Valid对象嵌套List对象校验无效问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教

引言

在使用Spring框架进行数据校验时,有时会遇到@Valid注解无法校验嵌套的List对象的情况。

本文将介绍这个问题的原因,并提供解决方案,帮助您有效地校验嵌套的List对象。

问题背景

Spring框架提供了基于注解的数据校验功能,其中@Valid注解用于标记需要进行校验的对象。

然而,当对象中包含嵌套的List对象时,外层使用@Valid注解无法对嵌套的List对象进行校验。

原因分析

默认情况下,Spring框架对嵌套对象的校验支持较好,但对于嵌套的List对象,@Valid注解并不会自动递归进行校验。

controller如下:

public Objects flights(@RequestBody @Valid AForm aForm){
        return null;
    }

Form如下:

public class AForm {

    @NotNull(message = "数据更新时间必选")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS")
    private Date updateTime;

    private List<ASubForm> updateList;
}

public class ASubForm {

    @NotBlank(message = "航班号必选")
    private String FlightNumber;

    @NotBlank(message = "航班日期必选")
    private String FlightDate;

    @NotBlank(message = "离港机场必选")
    private String DepAirport;

    @NotBlank(message = "目的机场必选")
    private String ArrAirport;
}

问题

controller调用的时候只有外层的updateTime有提示数据更新时间必填,航班号航班日期等为空都不进行校验。

解决方案

修改AForm,在list对象上加上注解 @Valid就能正常校验了

public class AForm {

    @NotNull(message = "数据更新时间必选")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS")
    private Date updateTime;

 	@Valid
    private List<ASubForm> updateList;
}

在使用Spring框架进行数据校验时,可以在嵌套的List对象上添加@Valid注解,以启用对嵌套对象的递归校验。这样,Spring框架会自动对List中的每个元素应用校验规则。

例如:

public class YourClass {
    @Valid
    private List<YourNestedClass> nestedList;
    // 其他属性和方法
}

通过在List对象上添加@Valid注解,Spring框架会自动递归校验嵌套对象,并将校验结果返回。

这种方式是更简便的解决方案,可以避免手动递归校验或自定义注解和校验器。建议优先考虑在嵌套的List对象上使用@Valid注解来实现校验。

除了使用@Valid注解,还有其他方法可以对嵌套的List对象进行校验。以下是一些备选方案:

1.使用自定义校验器

您可以编写自定义的校验器来处理嵌套的List对象。自定义校验器可以实现对List中每个元素的校验逻辑,并进行递归校验。

首先,创建一个自定义的校验器类:

public class ListValidator implements ConstraintValidator<ValidList, List<?>> {
    @Override
    public void initialize(ValidList constraintAnnotation) {
    }

    @Override
    public boolean isValid(List<?> list, ConstraintValidatorContext context) {
        if (list == null || list.isEmpty()) {
            return true; // 空列表不进行校验
        }

        // 执行自定义的校验逻辑
        for (Object element : list) {
            // 校验每个元素
            // ...
        }

        return true; // 校验通过
    }
}

然后,创建一个自定义的注解来应用该校验器:

@Target({ElementType.FIELD, ElementType.PARAMETER})
@Retention(RetentionPolicy.RUNTIME)
@Constraint(validatedBy = ListValidator.class)
public @interface ValidList {
    String message() default "Invalid list";
    Class<?>[] groups() default {};
    Class<? extends Payload>[] payload() default {};
}

最后,在需要进行嵌套List对象校验的地方使用该注解:

public class YourClass {
    @ValidList
    private List<YourNestedClass> nestedList;
    // 其他属性和方法
}

通过自定义校验器和注解,您可以实现对嵌套的List对象的校验逻辑。

2.手动递归校验

另一种方法是手动递归校验嵌套的List对象。您可以在校验对象的方法中,手动对List对象的每个元素应用校验规则。

public class YourClass {
    private List<@Valid YourNestedClass> nestedList;
    // 其他属性和方法

    public void validate() {
        ValidatorFactory validatorFactory = Validation.buildDefaultValidatorFactory();
        Validator validator = validatorFactory.getValidator();
        for (YourNestedClass element : nestedList) {
            Set<ConstraintViolation<YourNestedClass>> violations = validator.validate(element);
            // 处理校验错误
        }
    }
}

通过手动递归校验List对象的每个元素,您可以实现对嵌套的List对象的校验。

这些是一些可选的方法,可用于对嵌套的List对象进行校验。您可以根据具体需求和情况选择适合您的解决方案。

请注意,以上方法也可以与@Valid注解结合使用,以实现更全面的校验。

总结

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

相关文章

  • 关于JavaEE内部类的部分注意事项

    关于JavaEE内部类的部分注意事项

    这篇文章主要介绍了关于JavaEE内部类的部分注意事项,将一个类定义在另一个类里面或者一个方法里面,这样的类称为内部类,这是一种封装思想,那么使用内部类的时候要注意些什么呢,让我们一起来看看吧
    2023-03-03
  • Java超详细透彻讲解接口

    Java超详细透彻讲解接口

    接口是Java中最重要的概念之一,它可以被理解为一种特殊的类,不同的是接口的成员没有执行体,是由全局常量和公共的抽象方法所组成,本文给大家介绍Java接口,感兴趣的朋友一起看看吧
    2022-05-05
  • 23种设计模式(20)java中介者模式

    23种设计模式(20)java中介者模式

    这篇文章主要为大家详细介绍了23种设计模式之java中介者模式,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-01-01
  • Spring定时任务并行(异步)处理方式

    Spring定时任务并行(异步)处理方式

    这篇文章主要介绍了Spring定时任务并行(异步)处理方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2024-08-08
  • Java设计模式之开闭原则精解

    Java设计模式之开闭原则精解

    设计模式(Design pattern)代表了最佳的实践,通常被有经验的面向对象的软件开发人员所采用。设计模式是软件开发人员在软件开发过程中面临的一般问题的解决方案。本篇介绍设计模式七大原则之一的开闭原则
    2022-02-02
  • Java语言实现简单FTP软件 FTP软件效果图预览之下载功能(2)

    Java语言实现简单FTP软件 FTP软件效果图预览之下载功能(2)

    这篇文章主要为大家详细介绍了Java语言实现简单FTP软件,FTP软件效果图预览之下载功能,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-03-03
  • SpringCloud实现SSO 单点登录的示例代码

    SpringCloud实现SSO 单点登录的示例代码

    作为分布式项目,单点登录是必不可少的,这篇文章主要介绍了SpringCloud实现SSO 单点登录的示例代码,非常具有实用价值,需要的朋友可以参考下
    2019-01-01
  • java策略枚举:消除在项目里大批量使用if-else的优雅姿势

    java策略枚举:消除在项目里大批量使用if-else的优雅姿势

    这篇文章主要给大家介绍了关于Java彻底消灭if-else的8种方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习吧
    2021-06-06
  • 雪花算法(snowflak)生成有序不重复ID的Java实现代码

    雪花算法(snowflak)生成有序不重复ID的Java实现代码

    雪花算法是一种分布式系统中生成唯一ID的方法,由41位时间戳、10位机器码和12位序列号组成,具有唯一性、有序性和高效率等优点,这篇文章主要介绍了雪花算法(snowflak)生成有序不重复ID的Java实现的相关资料,需要的朋友可以参考下
    2024-11-11
  • Mybatis中动态SQL,if,where,foreach的使用教程详解

    Mybatis中动态SQL,if,where,foreach的使用教程详解

    MyBatis的动态SQL是基于OGNL表达式的,它可以帮助我们方便的在SQL语句中实现某些逻辑。这篇文章主要介绍了Mybatis中动态SQL,if,where,foreach的使用教程,需要的朋友可以参考下
    2017-11-11

最新评论