@valid注解可以實現數據的驗證,你可以定義實體,在實體的屬性上添加校驗規則,而在api接收數據時添加@valid關鍵字,這時你的實體將會開啟一個校驗的功能,具體的代碼如下,是最基本的應用:
實體:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
public class departmentdto { @apimodelproperty ( "id" ) private string id; @apimodelproperty ( "上級id" ) private string parentid; @apimodelproperty ( "編號" ) @notblank (message = "部門編號不能為空。" ) private string code; @apimodelproperty ( "名稱" ) @notblank (message = "部門名稱不能為空。" ) private string name; @apimodelproperty ( "員工集合" ) @builder . default private list<employee> employees = new arraylist<>(); } |
restful接口:
1
2
3
4
5
6
7
8
9
10
|
@postmapping () public response<clientaccount> initialaccount( @apiparam ( "客戶編號" ) @pathvariable string code, @apiparam ( "賬期" ) @pathvariable yearmonth accountperiod, @apiparam ( "請求體" ) @valid @requestbody request<departmentdto> request) { clientaccount result = clientaccountservice.initialaccount( code, accountperiod, request.getoperator(), request.getbody());{} |
上面代碼中,我們為請求體request<departmentdto>
添加了校驗,在測試時,如果你的departmnetdto.name為空字符時,當出現400的異常,麗時異常消息是『部門名稱不能為空』,這對于我們來說是沒有問題的,也是符合我們要求的,下面看另一個場景。
需要驗證的實體是另一個實休的屬性
這種方式我們也需要會看到,一個大對象,如被封裝的其它小對象組成,比如部門下面有員工,這時如果需要驗證員工的有效性,需要如何實現呢?如果我們不修改源代碼,執行結果是否定的, 它并不會校驗員工這個對象,而只針對第一層對象的屬性 。
我們將實體的員工屬性添加上@valid即可實現對這個屬性的校驗
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
public class departmentdto { @apimodelproperty ( "id" ) private string id; @apimodelproperty ( "上級id" ) private string parentid; @apimodelproperty ( "編號" ) @notblank (message = "部門編號不能為空。" ) private string code; @apimodelproperty ( "名稱" ) @notblank (message = "部門名稱不能為空。" ) private string name; @valid @apimodelproperty ( "員工集合" ) @builder . default private list<employee> employees = new arraylist<>(); } |
下面看一下驗證結果,我們的400錯誤就可以在單元測試下面正常輸出了!
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
@test public void initialaccount_employee_name_empty() { list<employee> employees = new arraylist<>(); employees.add(employee.builder() .name( "" ) .idnumber( "110111198203182012" ) .build()); list<departmentdto> departments = new arraylist<>(); departments.add(departmentdto.builder() .name( "部門" ) .description( "技術部" ) .salarytype(salarytype.researchanddevelopmentcosts) .employees(employees) .build()); clientaccountdto clientaccountdto = clientaccountdto.builder() .name( "客戶" ) .departments(departments) .build(); request<clientaccountdto> request = buildrequest(clientaccountdto); api.post() .uri( "/v1/12345/2018-03" ) .body(bodyinserters.fromobject(request)) .exchange() .expectstatus().isequalto( 400 ) .expectbody() .jsonpath( "$.errors[0].message" ).isequalto( "姓名不能為空" ); } |
結果如下,測試通過
如果是測試它是isok的話,由于用戶名為空,所以會出現錯誤提示
1
2
3
4
5
|
api.post() .uri( "/v1/12345/2018-03" ) .body(bodyinserters.fromobject(request)) .exchange() .expectstatus().isok(); |
可以看一下結果的提示信息
總結
以上所述是小編給大家介紹的springboot @valid注解對嵌套類型的校驗,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對服務器之家網站的支持!
原文鏈接:http://www.cnblogs.com/lori/p/9088380.html