Spring中@Validated和@Valid區別淺析

2022-04-20 13:01:55

基本概念

Spring Validation 驗證框架對引數的驗證機制提供了@Validated（Spring's JSR-303規範，是標準JSR-303的一個變種），javax提供了@Valid（標準JSR-303規範），配合BindingResult可以直接提供引數驗證結果。其中對於欄位的特定驗證註解，比如@NotNull。

@Valid和@Validated 批註

在Spring中，我們使用JSR-303的@Valid批註進行方法級別驗證。此外，我們還使用它來標記成員屬性以進行驗證。但是，此註釋不支援組驗證。

組驗證有助於限制驗證期間應用的約束。UI嚮導是一種特殊的用例。在這裡，第一步，我們可能有一個特定的欄位子組。在後續步驟中，可能存在另一個屬於同一bean的組。因此，我們需要在每個步驟中對這些有限的欄位應用約束，但是@Valid不支援此約束。

在這種情況下，對於組級別，我們必須使用Spring的@Validated，這是此JSR-303的@Valid的變體。在方法級別使用。為了標記成員屬性，我們繼續使用@Valid批註。

主要區別

在檢驗Controller的入參是否符合規範時，使用@Validated或者@Valid在基本驗證功能上沒有太多區別。但是在分組、註解地方、巢狀驗證等功能上兩個有所不同：

	@Validated	@Valid
分組	提供分組功能，可在入參驗證時，根據不同的分組採用不同的驗證機制。	無分組功能
可註解位置	可以用在型別、方法和方法引數上。但是不能用在成員屬性上	可以用在方法、建構函式、方法引數和成員屬性上（兩者是否能用於成員屬性上直接影響能否提供巢狀驗證的功能）
巢狀驗證	用在方法入參上無法單獨提供巢狀驗證功能。不能用在成員屬性上。也無法提供框架進行巢狀驗證。能配合巢狀驗證註解@Valid進行巢狀驗證。	用在方法入參上無法單獨提供巢狀驗證功能。能夠用在成員屬性上，提示驗證框架進行巢狀驗證。能配合巢狀驗證註解@Valid進行巢狀驗證。

什麼是巢狀驗證？

public class Item {

    @NotNull(message = "id不能為空")
    @Min(value = 1, message = "id必須為正整數")
    private Long id;

    @NotNull(message = "props不能為空")
    @Size(min = 1, message = "至少要有一個屬性")
    private List<Prop> props;
}

Item帶有很多屬性，屬性裡面有屬性id，屬性值id，props屬性名和屬性值，如下所示：

public class Prop {
    @NotNull(message = "pid不能為空")
    @Min(value = 1, message = "pid必須為正整數")
    private Long pid;

    @NotNull(message = "vid不能為空")
    @Min(value = 1, message = "vid必須為正整數")
    private Long vid;

    @NotBlank(message = "pidName不能為空")
    private String pidName;

    @NotBlank(message = "vidName不能為空")
    private String vidName;
}

props屬性也有自己的驗證機制，比如屬性值不能為空。

現在測試，接收Item的入參，想要對Item進行驗證，如下所示：

@RestController
public class ItemController {
    @RequestMapping("/item/add")
    public void addItem(@Validated Item item, BindingResult bindingResult) {
        doSomething();
    }
}

再上圖中，如果Item實體的props屬性不額外加註釋，只有NotNull和@Size，無論入參採用@Validated還是@Valid驗證，Spring Validation框架止會對Item的id和props做非空和數量驗證，不會對props欄位裡的Prop實體進行欄位驗證，也就是@Validated和@Valid加在方法引數前，都不會對引數進行巢狀驗證。

為了能夠進行巢狀驗證，必須手動在Item實體的props欄位上明確質出這個欄位裡面的實體也要進行驗證。由於@Validated不能用在成員屬性上，但是@Valid加在成員屬性上，而且@Valid類註解上也說明了它支援巢狀驗證功能，那我們能夠推斷出：@Valid加在方法引數時並不能夠自動進行巢狀驗證，而是用在需要巢狀驗證類的相應欄位上，來配合方法引數上@Validated或@Valid來進行巢狀驗證。

修改後的Item類：

public class Item {
    @NotNull(message = "id不能為空")
    @Min(value = 1, message = "id必須為正整數")
    private Long id;

    @Valid // 巢狀驗證必須用@Valid
    @NotNull(message = "props不能為空")
    @Size(min = 1, message = "props至少要有一個自定義屬性")
    private List<Prop> props;
}

總結

到此這篇關於Spring中@Validated和@Valid區別的文章就介紹到這了,更多相關Spring @Validated和@Valid區別內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

Spring中@Validated和@Valid區別淺析

目錄

基本概念

@Valid和@Validated 批註

主要區別

什麼是巢狀驗證？

總結

熱門文章