轉發:原博客
基本概念
Spring Validation 驗證框架對參數的驗證機制提供了@Validated(Spring's JSR-303規范,是標准JSR-303的一個變種),javax提供了@Valid(標准JSR-303規范),配合BindingResult可以直接提供參數驗證結果。其中對於字段的特定驗證注解,比如@NotNull。
主要區別
在檢驗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; }