Like Share Discussion Bookmark Smile

J.J. Huang   2019-04-03   Spring Boot   瀏覽次數:

SpringBoot - 第二十章 | 資料驗證(二)

再往下這篇文章之前,建議先去看上一篇文章,看這篇有簡單的使用和介紹 第十九章 - SpringBoot 資料驗證(一) ,以下將要介紹 @Validated 和 @Valid 的區別和嵌套驗證的說明。

簡單介紹

@Validated 是 @Valid 的一次封裝,是Spring提供的校驗機制使用。@Valid不提供分組功能。

  • JSR303/JSR-349: JSR303是一項標準,只提供規範不提供實現,規定一些校驗規範即校驗註解,如@Null,@NotNull,@Pattern,位於javax.validation.constraints包下。 JSR-349是其的升級版本,添加了一些新特性。

  • hibernate validation:hibernate validation是對這個規範的實現,並增加了一些其他校驗註解,如@Email,@Length,@Range等等。

  • spring validation:spring validation對hibernate validation進行了二次封裝,在springmvc模組中添加了自動校驗,並將校驗訊息封裝進了特定的類中。


簡單範例

建立 Customer

建立 DemoController

測試

以上兩個測試使用了 @Validated ,其結果與 @Valid 是一樣的結果,這邊就不再特別貼出拉了。


@Validated @Valid 區別

分組

  • @Validated:提供了一個分組功能,可以在入參驗證時,根據不同的分組採用不同的驗證機制。

  • @Valid:作為標準JSR-303規範,還沒有吸收分組的功能。

分組的教學會在下一章節特別說明。

註解位置

  • @Validated:可以用在類型、方法和方法參數上。但是不能用在成員屬性(字段)上

  • @Valid:可以用在方法、構造函數、方法參數和成員屬性(字段)上

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

嵌套驗證

在比較兩者嵌套驗證時,先說明下什麼叫做嵌套驗證。

建立 Item

建立 Prop

Item裡面有,id和prop,針對這兩個有做一些驗證。
Prop裡面有,pid、pidName、vid、vidName,針對這些參數也有屬於自己的驗證。

建立 ItemController

測試

我們預期是會驗證 Item 的 id 還有 Prop 裡面的 pid、vid、pdiName、vidName。

Postman參數:

1
2
3
4
5
6
7
8
#完整參數:
{"id":1,"props":[{"pid":2,"vid":3,"pidName":"Test1","vidName":"Test2"}]}

#缺漏參數
{"id":1}

#props錯誤參數:(缺pid,vid為負數,pidName為空)
{"id":1,"props":[{"vid":-3,"pidName":"","vidName":"Test1"}]}
  • 完整參數結果
    Console:驗證完全通過。

  • 缺漏參數結果
    Console:「props不能為空」。

  • 錯誤參數結果
    Console:驗證完全通過。

預期「錯誤參數結果」應該要跳出缺pid,vid為負數,pidName為空,但是卻沒有做驗證,這就是沒有嵌套驗證。
如果Item實體的props屬性不額外加註釋,只有@NotNull和@Size,無論入參採用@Validated還是@Valid驗證,Spring Validation框架只會對Item的id和props做非空和數量驗證,不會對props字段裡的Prop實體進行字段驗證,也就是@Validated和@Valid加在方法參數前,都不會自動對參數進行嵌套驗證。也就是說如果傳的List中有Prop的pid為空或者是負數,入參驗證不會檢測出來。

編輯 Item

為了能夠進行嵌套驗證,必須手動在Item實體的props字段上明確指出這個字段裡面的實體也要進行驗證。由於@Validated不能用在成員屬性(字段)上,但是@Valid能加在成員屬性(字段)上,而且@Valid類註解上也說明了它支持嵌套驗證功能,那麼我們能夠推斷出:@Valid加在方法參數時並不能夠自動進行嵌套驗證,而是用在需要嵌套驗證類的相應字段上,來配合方法參數上@Validated或@Valid來進行嵌套驗證。

1
2
3
4
@NotNull(message = "props不能為空")
@Size(min = 1, message = "至少要有一個屬性")
@Valid
private List<Prop> props;
  • 再次使用錯誤參數來做測試
    Console:vid必須為正整數、pidName不能為空、pid不能為空。

總結一下 @Validated 和 @Valid 在嵌套驗證的區別

  • @Validated: 用在方法入參上無法單獨提供嵌套驗證功能。不能用在成員屬性(字段)上,也無法提示框架進行嵌套驗證。能配合嵌套驗證註解@Valid進行嵌套驗證。

  • @Valid: 用在方法入參上無法單獨提供嵌套驗證功能。能夠用在成員屬性(字段)上,提示驗證框架進行嵌套驗證。能配合嵌套驗證註解@Valid進行嵌套驗證。

註:以上參考了
JSR 303: Bean Validation
The Bean Validation reference implementation
oKongSpringBoot | 第八章:统一异常、数据校验处理文章。
spring boot validator 验证
参数验证 @Validated 和 @Valid 的区别