快捷導(dǎo)航

Spring Validation的校驗(yàn)順序問(wèn)題及解決過(guò)程

更新時(shí)間：2026年01月09日 09:19:23 作者：她又在叢中笑

本文主要介紹了使用@GroupSequence注解來(lái)解決接口入?yún)⑿ｒ?yàn)順序不穩(wěn)定的問(wèn)題,并提供了具體的實(shí)現(xiàn)步驟和代碼示例

問(wèn)題場(chǎng)景

測(cè)試發(fā)現(xiàn)對(duì)同一個(gè)接口調(diào)用多次時(shí)，返回的校驗(yàn)異常信息不同，經(jīng)過(guò)問(wèn)題追蹤，入?yún)?shí)體類代碼如下：

@Data
public class EditDevNameDto {
    @NotBlank(message = "deviceSn must not null")
    private String deviceSn;
    @NotBlank(message = "deviceName must not null")
    private String deviceName;
}

當(dāng)這個(gè)接口入?yún)⒌膁eviceSn和deviceName均為空值時(shí)，調(diào)用多次的話會(huì)出現(xiàn)兩個(gè)msg錯(cuò)誤信息循環(huán)返回的問(wèn)題。

原理剖析

懷疑是調(diào)用接口時(shí)，校驗(yàn)注解的先后順序是不確定的，所以，可能deviceSn先被校驗(yàn)，可能deviceName先被校驗(yàn)，那要解決這個(gè)問(wèn)題就要規(guī)定校驗(yàn)的順序才行。

解決方法

使用@GroupSequence注解實(shí)現(xiàn)順序的穩(wěn)定性。

創(chuàng)建五個(gè)接口

public interface GroupA {
}

public interface GroupB {
}

public interface GroupC {
}

public interface GroupD {
}

@GroupSequence({GroupA.class,GroupB.class,GroupC.class,GroupD.class})
public interface Group {
}

修改Controller控制層代碼

注意在入?yún)⒅屑尤隌Validated(Group.class)注解，其中要加入被@GroupSequence修飾的類對(duì)象。

    @PostMapping("/edit_device_name")
    public ExecuteResult editDevName(
    	@RequestBody @Validated(Group.class) EditDevNameDto dev) {
        // -----邏輯代碼
        return null;
    }

修改實(shí)體類代碼

在實(shí)體類中使用校驗(yàn)注解中添加groups屬性，順序按照@GroupSequence類規(guī)定的順序即可。

@Data
public class EditDevNameDto {
    @NotBlank(message = "deviceSn must not null", groups = {GroupA.class})
    private String deviceSn;
    @NotBlank(message = "deviceName must not null", groups = {GroupB.class})
    private String deviceName;
}

整改結(jié)果

當(dāng)這個(gè)接口入?yún)⒌膁eviceSn和deviceName均為空值時(shí)，頻繁調(diào)用依然是按照先校驗(yàn)deviceSn，后校驗(yàn)deviceName的順序進(jìn)行參數(shù)校驗(yàn)。

后續(xù)問(wèn)題

問(wèn)題原因

解決了上面的問(wèn)題，過(guò)了幾天，又出現(xiàn)了解決校驗(yàn)順序的問(wèn)題，但是這次又不同于上一次，這次的Dto參數(shù)接收類有些復(fù)雜，代碼如下：

@Data
public class UpdateInfoDto {

    @NotBlank(message = "deviceSn can not be empty")
    @GBDeviceSnValid
    private String deviceSn;


    @Valid // 讓CommonDto類中的校驗(yàn)屬性生效
    @GBChannelDuplicateValid
    @CollectionNotEmptyValid(message = "channels cannot be empty")
    private List<CommonDto> channels;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonDto{

    @GBChannelIdValid
    private String id;

    @NotNull(message = "channelId must not be null")
    @PositiveOrZero(message = "channelId only Integer or zero")
    private Integer channelId;
}

以上代碼中有兩個(gè)類，共同組合成參數(shù)接收類，要糾正校驗(yàn)順序混亂問(wèn)題，還是需要用到一開(kāi)始講到的@GroupSequence注解，但是，有兩個(gè)問(wèn)題：

Dto中還有一個(gè)對(duì)象類型的屬性。
對(duì)象類型屬性中的子屬性（id、channelId）也要成功校驗(yàn)

解決方案

首先，為了讓Dto中的對(duì)象類型的屬性也能正常校驗(yàn)，需要添加@Valid注解；

然后，在對(duì)象類型屬性中的子屬性中也需要像文章前面所說(shuō)的在校驗(yàn)注解中設(shè)置groups屬性。

修改后的代碼如下：

@Data
public class UpdateInfoDto {

    @NotBlank(message = "deviceSn can not be empty", groups = {GroupA.class})
    @GBDeviceSnValid(groups = {GroupA.class})
    private String deviceSn;


    @Valid // 讓CommonDto類中的校驗(yàn)屬性生效
    @GBChannelDuplicateValid(groups = {GroupB.class})
    @CollectionNotEmptyValid(message = "channels cannot be empty", groups = {GroupB.class})
    private List<CommonDto> channels;
}

@Data
@AllArgsConstructor
@NoArgsConstructor
public class CommonDto{

    @GBChannelIdValid(groups = {GroupC.class})
    private String id;

    @NotNull(message = "channelId must not be null", groups = {GroupD.class})
    @PositiveOrZero(message = "channelId only Integer or zero", groups = {GroupD.class})
    private Integer channelId;
}

如果CommonDto中校驗(yàn)屬性的注解不設(shè)置groups，CommonDto中的校驗(yàn)屬性就會(huì)失效，這是個(gè)大坑。