Spring校驗:@Validated和@Valid區別
結論:
Spring validation驗證框架對入參實體進行巢狀驗證必須在相應屬性(欄位)加上@Valid而不是@Validated
Spring Validation驗證框架對引數的驗證機制提供了@Validated(Spring's JSR-303規範,是標準JSR-303的一個變種),javax提供了@Valid(標準JSR-303規範),配合BindingResult可以直接提供引數驗證結果。其中對於欄位的特定驗證註解比如@NotNull等網上到處都有,這裡不詳述
在檢驗Controller的入參是否符合規範時,使用@Validated或者@Valid在基本驗證功能上沒有太多區別。但是在分組、註解地方、巢狀驗證等功能上兩個有所不同:
1. 分組
@Validated:提供了一個分組功能,可以在入參驗證時,根據不同的分組採用不同的驗證機制,這個網上也有資料,不詳述。@Valid:作為標準JSR-303規範,還沒有吸收分組的功能。
2. 註解地方
@Validated:可以用在型別、方法和方法引數上。但是不能用在成員屬性(欄位)上
@Valid:可以用在方法、建構函式、方法引數和成員屬性(欄位)上
兩者是否能用於成員屬性(欄位)上直接影響能否提供巢狀驗證的功能。
3. 巢狀驗證
在比較兩者巢狀驗證時,先說明下什麼叫做巢狀驗證。比如我們現在有個實體叫做Item:
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,屬性名和屬性值,如下所示:
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; }
屬性這個實體也有自己的驗證機制,比如屬性和屬性值id不能為空,屬性名和屬性值不能為空等。
現在我們有個ItemController接受一個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加在方法引數前,都不會自動對引數進行巢狀驗證。也就是說如果傳的List<Prop>中有Prop的pid為空或者是負數,入參驗證不會檢測出來。
為了能夠進行巢狀驗證,必須手動在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; }
然後我們在ItemController的addItem函式上再使用@Validated或者@Valid,就能對Item的入參進行巢狀驗證。此時Item裡面的props如果含有Prop的相應欄位為空的情況,Spring Validation框架就會檢測出來,bindingResult就會記錄相應的錯誤。
總結一下@Validated和@Valid在巢狀驗證功能上的區別:
@Validated:用在方法入參上無法單獨提供巢狀驗證功能。不能用在成員屬性(欄位)上,也無法提示框架進行巢狀驗證。能配合巢狀驗證註解@Valid進行巢狀驗證。
@Valid:用在方法入參上無法單獨提供巢狀驗證功能。能夠用在成員屬性(欄位)上,提示驗證框架進行巢狀驗證。能配合巢狀驗證註解@Valid進行巢狀驗證。
————————————————
版權宣告:本文為CSDN博主「花郎徒結」的原創文章,遵循CC 4.0 BY-SA版權協議,轉載請附上原文出處連結及本宣告。
原文連結:https://blog.csdn.net/qq_27680317/article/details/79970590