這篇文章主要介紹springboot中如何實(shí)現(xiàn)@Valid注解對(duì)嵌套類(lèi)型的校驗(yàn)功能,文中介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們一定要看完!
10年積累的網(wǎng)站設(shè)計(jì)、網(wǎng)站建設(shè)經(jīng)驗(yàn),可以快速應(yīng)對(duì)客戶(hù)對(duì)網(wǎng)站的新想法和需求。提供各種問(wèn)題對(duì)應(yīng)的解決方案。讓選擇我們的客戶(hù)得到更好、更有力的網(wǎng)絡(luò)服務(wù)。我雖然不認(rèn)識(shí)你,你也不認(rèn)識(shí)我。但先網(wǎng)站設(shè)計(jì)后付款的網(wǎng)站建設(shè)流程,更有安義免費(fèi)網(wǎng)站建設(shè)讓你可以放心的選擇與我們合作。
@Valid注解可以實(shí)現(xiàn)數(shù)據(jù)的驗(yàn)證,你可以定義實(shí)體,在實(shí)體的屬性上添加校驗(yàn)規(guī)則,而在API接收數(shù)據(jù)時(shí)添加@valid關(guān)鍵字,這時(shí)你的實(shí)體將會(huì)開(kāi)啟一個(gè)校驗(yàn)的功能,具體的代碼如下,是最基本的應(yīng)用:
實(shí)體:
public class DepartmentDto { @ApiModelProperty("id") private String id; @ApiModelProperty("上級(jí)Id") private String parentId; @ApiModelProperty("編號(hào)") @NotBlank(message = "部門(mén)編號(hào)不能為空。") private String code; @ApiModelProperty("名稱(chēng)") @NotBlank(message = "部門(mén)名稱(chēng)不能為空。") private String name; @ApiModelProperty("員工集合") @Builder.Default private Listemployees = new ArrayList<>(); }
Restful接口:
@PostMapping() public ResponseinitialAccount( @ApiParam("客戶(hù)編號(hào)") @PathVariable String code, @ApiParam("賬期") @PathVariable YearMonth accountPeriod, @ApiParam("請(qǐng)求體") @Valid @RequestBody Request request) { ClientAccount result = clientAccountService.initialAccount( code, accountPeriod, request.getOperator(), request.getBody());{}
上面代碼中,我們?yōu)檎?qǐng)求體Request
添加了校驗(yàn),在測(cè)試時(shí),如果你的DepartmnetDto.name為空字符時(shí),當(dāng)出現(xiàn)400的異常,麗時(shí)異常消息是『部門(mén)名稱(chēng)不能為空』,這對(duì)于我們來(lái)說(shuō)是沒(méi)有問(wèn)題的,也是符合我們要求的,下面看另一個(gè)場(chǎng)景。
需要驗(yàn)證的實(shí)體是另一個(gè)實(shí)休的屬性
這種方式我們也需要會(huì)看到,一個(gè)大對(duì)象,如被封裝的其它小對(duì)象組成,比如部門(mén)下面有員工,這時(shí)如果需要驗(yàn)證員工的有效性,需要如何實(shí)現(xiàn)呢?如果我們不修改源代碼,執(zhí)行結(jié)果是否定的, 它并不會(huì)校驗(yàn)員工這個(gè)對(duì)象,而只針對(duì)第一層對(duì)象的屬性 。
我們將實(shí)體的員工屬性添加上@Valid即可實(shí)現(xiàn)對(duì)這個(gè)屬性的校驗(yàn)
public class DepartmentDto { @ApiModelProperty("id") private String id; @ApiModelProperty("上級(jí)Id") private String parentId; @ApiModelProperty("編號(hào)") @NotBlank(message = "部門(mén)編號(hào)不能為空。") private String code; @ApiModelProperty("名稱(chēng)") @NotBlank(message = "部門(mén)名稱(chēng)不能為空。") private String name; @Valid @ApiModelProperty("員工集合") @Builder.Default private Listemployees = new ArrayList<>(); }
下面看一下驗(yàn)證結(jié)果,我們的400錯(cuò)誤就可以在單元測(cè)試下面正常輸出了!
@Test public void initialAccount_employee_name_empty() { Listemployees = new ArrayList<>(); employees.add(Employee.builder() .name("") .email("zzl@sina.com") .idNumber("110111198203182012") .build()); List departments = new ArrayList<>(); departments.add(DepartmentDto.builder() .name("部門(mén)") .description("技術(shù)部") .salaryType(SalaryType.ResearchAndDevelopmentCosts) .employees(employees) .build()); ClientAccountDto clientAccountDto = ClientAccountDto.builder() .name("客戶(hù)") .departments(departments) .build(); Request request = buildRequest(clientAccountDto); api.post() .uri("/v1/12345/2018-03") .body(BodyInserters.fromObject(request)) .exchange() .expectStatus().isEqualTo(400) .expectBody() .jsonPath("$.errors[0].message").isEqualTo("姓名不能為空"); }
結(jié)果如下,測(cè)試通過(guò)
如果是測(cè)試它是IsOk的話(huà),由于用戶(hù)名為空,所以會(huì)出現(xiàn)錯(cuò)誤提示
api.post() .uri("/v1/12345/2018-03") .body(BodyInserters.fromObject(request)) .exchange() .expectStatus().isOk();
可以看一下結(jié)果的提示信息
以上是“springboot中如何實(shí)現(xiàn)@Valid注解對(duì)嵌套類(lèi)型的校驗(yàn)功能”這篇文章的所有內(nèi)容,感謝各位的閱讀!希望分享的內(nèi)容對(duì)大家有幫助,更多相關(guān)知識(shí),歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道!