如何解決@Valid對(duì)象嵌套List對(duì)象校驗(yàn)無效問題

更新時(shí)間：2024年07月11日 09:29:54 作者：Thomas & Friends

這篇文章主要介紹了如何解決@Valid對(duì)象嵌套List對(duì)象校驗(yàn)無效問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教

引言

在使用Spring框架進(jìn)行數(shù)據(jù)校驗(yàn)時(shí)，有時(shí)會(huì)遇到@Valid注解無法校驗(yàn)嵌套的List對(duì)象的情況。

本文將介紹這個(gè)問題的原因，并提供解決方案，幫助您有效地校驗(yàn)嵌套的List對(duì)象。

問題背景

Spring框架提供了基于注解的數(shù)據(jù)校驗(yàn)功能，其中@Valid注解用于標(biāo)記需要進(jìn)行校驗(yàn)的對(duì)象。

然而，當(dāng)對(duì)象中包含嵌套的List對(duì)象時(shí)，外層使用@Valid注解無法對(duì)嵌套的List對(duì)象進(jìn)行校驗(yàn)。

原因分析

默認(rèn)情況下，Spring框架對(duì)嵌套對(duì)象的校驗(yàn)支持較好，但對(duì)于嵌套的List對(duì)象，@Valid注解并不會(huì)自動(dòng)遞歸進(jìn)行校驗(yàn)。

controller如下：

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

Form如下：

public class AForm {

    @NotNull(message = "數(shù)據(jù)更新時(shí)間必選")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS")
    private Date updateTime;

    private List<ASubForm> updateList;
}

public class ASubForm {

    @NotBlank(message = "航班號(hào)必選")
    private String FlightNumber;

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

    @NotBlank(message = "離港機(jī)場(chǎng)必選")
    private String DepAirport;

    @NotBlank(message = "目的機(jī)場(chǎng)必選")
    private String ArrAirport;
}

問題

controller調(diào)用的時(shí)候只有外層的updateTime有提示數(shù)據(jù)更新時(shí)間必填，航班號(hào)航班日期等為空都不進(jìn)行校驗(yàn)。

解決方案

修改AForm，在list對(duì)象上加上注解 @Valid就能正常校驗(yàn)了

public class AForm {

    @NotNull(message = "數(shù)據(jù)更新時(shí)間必選")
    @JsonFormat(pattern = "yyyy-MM-dd HH:mm:ss.SSS")
    private Date updateTime;

 	@Valid
    private List<ASubForm> updateList;
}

在使用Spring框架進(jìn)行數(shù)據(jù)校驗(yàn)時(shí)，可以在嵌套的List對(duì)象上添加@Valid注解，以啟用對(duì)嵌套對(duì)象的遞歸校驗(yàn)。這樣，Spring框架會(huì)自動(dòng)對(duì)List中的每個(gè)元素應(yīng)用校驗(yàn)規(guī)則。

例如：

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

通過在List對(duì)象上添加@Valid注解，Spring框架會(huì)自動(dòng)遞歸校驗(yàn)嵌套對(duì)象，并將校驗(yàn)結(jié)果返回。

這種方式是更簡(jiǎn)便的解決方案，可以避免手動(dòng)遞歸校驗(yàn)或自定義注解和校驗(yàn)器。建議優(yōu)先考慮在嵌套的List對(duì)象上使用@Valid注解來實(shí)現(xiàn)校驗(yàn)。

除了使用@Valid注解，還有其他方法可以對(duì)嵌套的List對(duì)象進(jìn)行校驗(yàn)。以下是一些備選方案：

1.使用自定義校驗(yàn)器

您可以編寫自定義的校驗(yàn)器來處理嵌套的List對(duì)象。自定義校驗(yàn)器可以實(shí)現(xiàn)對(duì)List中每個(gè)元素的校驗(yàn)邏輯，并進(jìn)行遞歸校驗(yàn)。

首先，創(chuàng)建一個(gè)自定義的校驗(yàn)器類：

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; // 空列表不進(jìn)行校驗(yàn)
        }

        // 執(zhí)行自定義的校驗(yàn)邏輯
        for (Object element : list) {
            // 校驗(yàn)每個(gè)元素
            // ...
        }

        return true; // 校驗(yàn)通過
    }
}

然后，創(chuàng)建一個(gè)自定義的注解來應(yīng)用該校驗(yàn)器：

@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 {};
}

最后，在需要進(jìn)行嵌套List對(duì)象校驗(yàn)的地方使用該注解：

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

通過自定義校驗(yàn)器和注解，您可以實(shí)現(xiàn)對(duì)嵌套的List對(duì)象的校驗(yàn)邏輯。

2.手動(dòng)遞歸校驗(yàn)

另一種方法是手動(dòng)遞歸校驗(yàn)嵌套的List對(duì)象。您可以在校驗(yàn)對(duì)象的方法中，手動(dòng)對(duì)List對(duì)象的每個(gè)元素應(yīng)用校驗(yàn)規(guī)則。

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);
            // 處理校驗(yàn)錯(cuò)誤
        }
    }
}

通過手動(dòng)遞歸校驗(yàn)List對(duì)象的每個(gè)元素，您可以實(shí)現(xiàn)對(duì)嵌套的List對(duì)象的校驗(yàn)。

這些是一些可選的方法，可用于對(duì)嵌套的List對(duì)象進(jìn)行校驗(yàn)。您可以根據(jù)具體需求和情況選擇適合您的解決方案。

請(qǐng)注意，以上方法也可以與@Valid注解結(jié)合使用，以實(shí)現(xiàn)更全面的校驗(yàn)。