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:
1
2
3
4
5
6
7
8
9
10
|
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,屬性名和屬性值,如下所示:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
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進行驗證,如下所示:
1
2
3
4
5
6
7
8
|
@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類如下所示:
1
2
3
4
5
6
7
8
9
10
11
|
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進行嵌套驗證。
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持服務器之家。
原文鏈接:https://segmentfault.com/a/1190000017962734