參數(shù)驗(yàn)證 @Validated 和 @Valid 的區(qū)別

Spring Validation驗(yàn)證框架對(duì)參數(shù)的驗(yàn)證機(jī)制提供了@Validated（Spring’s JSR-303 規(guī)范，是標(biāo)準(zhǔn) JSR-303 的一個(gè)變種），javax提供了@Valid（標(biāo)準(zhǔn)JSR-303規(guī)范），配合 BindingResult 可以直接提供參數(shù)驗(yàn)證結(jié)果。其中對(duì)于字段的特定驗(yàn)證注解比如

@Null限制只能為null@NotNull限制必須不為null@AssertFalse限制必須為false@AssertTrue限制必須為true@DecimalMax(value)限制必須為一個(gè)不大于指定值的數(shù)字@DecimalMin(value)限制必須為一個(gè)不小于指定值的數(shù)字@Digits(integer,fraction)限制必須為一個(gè)小數(shù)，且整數(shù)部分的位數(shù)不能超過integer，小數(shù)部分的位數(shù)不能超過fraction@Future限制必須是一個(gè)將來(lái)的日期@Max(value)限制必須為一個(gè)不大于指定值的數(shù)字@Min(value)限制必須為一個(gè)不小于指定值的數(shù)字@Past驗(yàn)證注解的元素值（日期類型）比當(dāng)前時(shí)間早@Pattern(value)限制必須符合指定的正則表達(dá)式@Size(max,min)限制字符長(zhǎng)度必須在min到max之間@NotEmpty驗(yàn)證注解的元素值不為null且不為空（字符串長(zhǎng)度不為0、集合大小不為0）@NotBlank驗(yàn)證注解的元素值不為空（不為null、去除首位空格后長(zhǎng)度為0），不同于@NotEmpty，@NotBla只應(yīng)用于字符串且在比較時(shí)會(huì)去除字符串的空格@Email驗(yàn)證注解的元素值是Email，也可以通過正則表達(dá)式和flag指定自定義的email格式

在檢驗(yàn) Controller 的入?yún)⑹欠穹弦?guī)范時(shí)，使用 @Validated 或者 @Valid 在基本驗(yàn)證功能上沒有太多區(qū)別。但是在分組、注解地方、嵌套驗(yàn)證等功能上兩個(gè)有所不同：

分組
@Validated：提供了一個(gè)分組功能，可以在入?yún)Ⅱ?yàn)證時(shí)，根據(jù)不同的分組采用不同的驗(yàn)證機(jī)制，這個(gè)網(wǎng)上也有資料，不詳述。

@Valid：作為標(biāo)準(zhǔn)JSR-303規(guī)范，還沒有吸收分組的功能。

注解地方
@Validated：可以用在類型、方法和方法參數(shù)上。但是不能用在成員屬性（字段）上

@Valid：可以用在方法、構(gòu)造函數(shù)、方法參數(shù)和成員屬性（字段）上

兩者是否能用于成員屬性（字段）上直接影響能否提供嵌套驗(yàn)證的功能。

嵌套驗(yàn)證
在比較兩者嵌套驗(yàn)證時(shí)，先說(shuō)明下什么叫做嵌套驗(yàn)證。比如我們現(xiàn)在有個(gè)實(shí)體叫做Item：

public class Item {@NotNull(message = "id不能為空")@Min(value = 1, message = "id必須為正整數(shù)")private Long id;@NotNull(message = "props不能為空")@Size(min = 1, message = "至少要有一個(gè)屬性")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; }

屬性這個(gè)實(shí)體也有自己的驗(yàn)證機(jī)制，比如屬性和屬性值id不能為空，屬性名和屬性值不能為空等。在Java技術(shù)棧微信公眾號(hào)回復(fù)關(guān)鍵字：web，獲取更多 Java Web 開發(fā)系列文章。推薦閱讀：SpringMVC表單驗(yàn)證器的使用

現(xiàn)在我們有個(gè) ItemController 接受一個(gè)Item的入?yún)?#xff0c;想要對(duì)Item進(jìn)行驗(yàn)證，如下所示：

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

在上圖中，如果Item實(shí)體的props屬性不額外加注釋，只有@NotNull和@Size，無(wú)論入?yún)⒉捎?#64;Validated還是@Valid驗(yàn)證，Spring Validation框架只會(huì)對(duì)Item的id和props做非空和數(shù)量驗(yàn)證，不會(huì)對(duì)props字段里的Prop實(shí)體進(jìn)行字段驗(yàn)證，也就是@Validated和@Valid加在方法參數(shù)前，都不會(huì)自動(dòng)對(duì)參數(shù)進(jìn)行嵌套驗(yàn)證。也就是說(shuō)如果傳的List中有Prop的pid為空或者是負(fù)數(shù)，入?yún)Ⅱ?yàn)證不會(huì)檢測(cè)出來(lái)。

為了能夠進(jìn)行嵌套驗(yàn)證，必須手動(dòng)在Item實(shí)體的props字段上明確指出這個(gè)字段里面的實(shí)體也要進(jìn)行驗(yàn)證。由于@Validated不能用在成員屬性（字段）上，但是@Valid能加在成員屬性（字段）上，而且@Valid類注解上也說(shuō)明了它支持嵌套驗(yàn)證功能，那么我們能夠推斷出：@Valid加在方法參數(shù)時(shí)并不能夠自動(dòng)進(jìn)行嵌套驗(yàn)證，而是用在需要嵌套驗(yàn)證類的相應(yīng)字段上，來(lái)配合方法參數(shù)上@Validated或@Valid來(lái)進(jìn)行嵌套驗(yàn)證。

我們修改Item類如下所示：

public class Item {@NotNull(message = "id不能為空")@Min(value = 1, message = "id必須為正整數(shù)")private Long id;@Valid // 嵌套驗(yàn)證必須用@Valid@NotNull(message = "props不能為空")@Size(min = 1, message = "props至少要有一個(gè)自定義屬性")private List<Prop> props; }

然后我們?cè)贗temController的addItem函數(shù)上再使用@Validated或者@Valid，就能對(duì)Item的入?yún)⑦M(jìn)行嵌套驗(yàn)證。此時(shí)Item里面的props如果含有Prop的相應(yīng)字段為空的情況，Spring Validation框架就會(huì)檢測(cè)出來(lái)，bindingResult就會(huì)記錄相應(yīng)的錯(cuò)誤。

總結(jié)一下 @Validated 和 @Valid 在嵌套驗(yàn)證功能上的區(qū)別：

@Validated： 用在方法入?yún)⑸蠠o(wú)法單獨(dú)提供嵌套驗(yàn)證功能。不能用在成員屬性（字段）上，也無(wú)法提示框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。
@Valid： 用在方法入?yún)⑸蠠o(wú)法單獨(dú)提供嵌套驗(yàn)證功能。能夠用在成員屬性（字段）上，提示驗(yàn)證框架進(jìn)行嵌套驗(yàn)證。能配合嵌套驗(yàn)證注解@Valid進(jìn)行嵌套驗(yàn)證。

總結(jié)

以上是生活随笔為你收集整理的Spring Validation验证框架参数验证 @Validated 和 @Valid 的区别的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。