詳解Spring 參數(shù)驗證@Validated和@Valid的區(qū)別
Spring Validation驗證框架對參數(shù)的驗證機制提供了@Validated(Spring's JSR-303 規(guī)范,是標準 JSR-303 的一個變種),javax提供了@Valid(標準JSR-303規(guī)范),配合 BindingResult 可以直接提供參數(shù)驗證結(jié)果。其中對于字段的特定驗證注解比如 @NotNull 等網(wǎng)上到處都有,這里不詳述
在檢驗 Controller 的入?yún)⑹欠穹弦?guī)范時,使用 @Validated 或者 @Valid 在基本驗證功能上沒有太多區(qū)別。但是在分組、注解地方、嵌套驗證等功能上兩個有所不同:
1. 分組
@Validated:提供了一個分組功能,可以在入?yún)Ⅱ炞C時,根據(jù)不同的分組采用不同的驗證機制,這個網(wǎng)上也有資料,不詳述。@Valid:作為標準JSR-303規(guī)范,還沒有吸收分組的功能。
2. 注解地方
@Validated:可以用在類型、方法和方法參數(shù)上。但是不能用在成員屬性(字段)上
@Valid:可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性(字段)上
兩者是否能用于成員屬性(字段)上直接影響能否提供嵌套驗證的功能。
3. 嵌套驗證
在比較兩者嵌套驗證時,先說明下什么叫做嵌套驗證。比如我們現(xiàn)在有個實體叫做Item:
public class Item { @NotNull(message = "id不能為空") @Min(value = 1, message = "id必須為正整數(shù)") 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必須為正整數(shù)") private Long pid; @NotNull(message = "vid不能為空") @Min(value = 1, message = "vid必須為正整數(shù)") private Long vid; @NotBlank(message = "pidName不能為空") private String pidName; @NotBlank(message = "vidName不能為空") private String vidName; }
屬性這個實體也有自己的驗證機制,比如屬性和屬性值id不能為空,屬性名和屬性值不能為空等。
現(xiàn)在我們有個 ItemController 接受一個Item的入?yún)?,想要對Item進行驗證,如下所示:
@RestController public class ItemController { @RequestMapping("/item/add") public void addItem(@Validated Item item, BindingResult bindingResult) { doSomething(); } }
在上圖中,如果Item實體的props屬性不額外加注釋,只有@NotNull和@Size,無論入?yún)⒉捎聾Validated還是@Valid驗證,Spring Validation框架只會對Item的id和props做非空和數(shù)量驗證,不會對props字段里的Prop實體進行字段驗證,也就是@Validated和@Valid加在方法參數(shù)前,都不會自動對參數(shù)進行嵌套驗證。也就是說如果傳的List<Prop>中有Prop的pid為空或者是負數(shù),入?yún)Ⅱ炞C不會檢測出來。
為了能夠進行嵌套驗證,必須手動在Item實體的props字段上明確指出這個字段里面的實體也要進行驗證。由于@Validated不能用在成員屬性(字段)上,但是@Valid能加在成員屬性(字段)上,而且@Valid類注解上也說明了它支持嵌套驗證功能,那么我們能夠推斷出:@Valid加在方法參數(shù)時并不能夠自動進行嵌套驗證,而是用在需要嵌套驗證類的相應字段上,來配合方法參數(shù)上@Validated或@Valid來進行嵌套驗證。
我們修改Item類如下所示:
public class Item { @NotNull(message = "id不能為空") @Min(value = 1, message = "id必須為正整數(shù)") private Long id; @Valid // 嵌套驗證必須用@Valid @NotNull(message = "props不能為空") @Size(min = 1, message = "props至少要有一個自定義屬性") private List<Prop> props; }
然后我們在ItemController的addItem函數(shù)上再使用@Validated或者@Valid,就能對Item的入?yún)⑦M行嵌套驗證。此時Item里面的props如果含有Prop的相應字段為空的情況,Spring Validation框架就會檢測出來,bindingResult就會記錄相應的錯誤。
總結(jié)一下 @Validated 和 @Valid 在嵌套驗證功能上的區(qū)別:
@Validated: 用在方法入?yún)⑸蠠o法單獨提供嵌套驗證功能。不能用在成員屬性(字段)上,也無法提示框架進行嵌套驗證。能配合嵌套驗證注解@Valid進行嵌套驗證。
@Valid: 用在方法入?yún)⑸蠠o法單獨提供嵌套驗證功能。能夠用在成員屬性(字段)上,提示驗證框架進行嵌套驗證。能配合嵌套驗證注解@Valid進行嵌套驗證。
以上就是本文的全部內(nèi)容,希望對大家的學習有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
IDEA中將SpringBoot項目提交到git倉庫的方法步驟
本文主要介紹了IDEA中將SpringBoot項目提交到git倉庫的方法步驟,文中通過示例代碼介紹的非常詳細,具有一定的參考價值,感興趣的小伙伴們可以參考一下2021-12-12SpringBoot數(shù)據(jù)庫初始化datasource配置方式
這篇文章主要為大家介紹了SpringBoot數(shù)據(jù)庫初始化datasource配置方式,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2022-12-12解決rror updating database.Cause:java.sql.SQLSyntaxE
這篇文章主要介紹了解決rror updating database.Cause:java.sql.SQLSyntaxErrorException問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-05-05Mybatis實現(xiàn)Mapper動態(tài)代理方式詳解
這篇文章主要為大家詳細介紹了Mybatis實現(xiàn)Mapper動態(tài)代理方式,具有一定的參考價值,感興趣的小伙伴們可以參考一下2017-08-08Java異常處理Guava?Throwables類使用實例解析
這篇文章主要為大家介紹了Java異常處理神器Guava?Throwables類使用深入詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進步,早日升職加薪2023-12-12