springboot @Valid注解對(duì)嵌套類型的校驗(yàn)功能
@Valid注解可以實(shí)現(xiàn)數(shù)據(jù)的驗(yàn)證,你可以定義實(shí)體,在實(shí)體的屬性上添加校驗(yàn)規(guī)則,而在API接收數(shù)據(jù)時(shí)添加@valid關(guān)鍵字,這時(shí)你的實(shí)體將會(huì)開啟一個(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 = "部門編號(hào)不能為空。") private String code; @ApiModelProperty("名稱") @NotBlank(message = "部門名稱不能為空。") private String name; @ApiModelProperty("員工集合") @Builder.Default private List<Employee> employees = new ArrayList<>(); }
Restful接口:
@PostMapping() public Response<ClientAccount> initialAccount( @ApiParam("客戶編號(hào)") @PathVariable String code, @ApiParam("賬期") @PathVariable YearMonth accountPeriod, @ApiParam("請(qǐng)求體") @Valid @RequestBody Request<DepartmentDto> request) { ClientAccount result = clientAccountService.initialAccount( code, accountPeriod, request.getOperator(), request.getBody());{}
上面代碼中,我們?yōu)檎?qǐng)求體Request<DepartmentDto>
添加了校驗(yàn),在測(cè)試時(shí),如果你的DepartmnetDto.name為空字符時(shí),當(dāng)出現(xiàn)400的異常,麗時(shí)異常消息是『部門名稱不能為空』,這對(duì)于我們來說是沒有問題的,也是符合我們要求的,下面看另一個(gè)場(chǎng)景。
需要驗(yàn)證的實(shí)體是另一個(gè)實(shí)休的屬性
這種方式我們也需要會(huì)看到,一個(gè)大對(duì)象,如被封裝的其它小對(duì)象組成,比如部門下面有員工,這時(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 = "部門編號(hào)不能為空。") private String code; @ApiModelProperty("名稱") @NotBlank(message = "部門名稱不能為空。") private String name; @Valid @ApiModelProperty("員工集合") @Builder.Default private List<Employee> employees = new ArrayList<>(); }
下面看一下驗(yàn)證結(jié)果,我們的400錯(cuò)誤就可以在單元測(cè)試下面正常輸出了!
@Test public void initialAccount_employee_name_empty() { List<Employee> employees = new ArrayList<>(); employees.add(Employee.builder() .name("") .email("zzl@sina.com") .idNumber("110111198203182012") .build()); List<DepartmentDto> departments = new ArrayList<>(); departments.add(DepartmentDto.builder() .name("部門") .description("技術(shù)部") .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("姓名不能為空"); }
結(jié)果如下,測(cè)試通過
如果是測(cè)試它是IsOk的話,由于用戶名為空,所以會(huì)出現(xiàn)錯(cuò)誤提示
api.post() .uri("/v1/12345/2018-03") .body(BodyInserters.fromObject(request)) .exchange() .expectStatus().isOk();
可以看一下結(jié)果的提示信息
總結(jié)
以上所述是小編給大家介紹的springboot @Valid注解對(duì)嵌套類型的校驗(yàn),希望對(duì)大家有所幫助,如果大家有任何疑問請(qǐng)給我留言,小編會(huì)及時(shí)回復(fù)大家的。在此也非常感謝大家對(duì)腳本之家網(wǎng)站的支持!
相關(guān)文章
java反射機(jī)制的一些學(xué)習(xí)心得小結(jié)
這篇文章主要給大家介紹了關(guān)于java反射機(jī)制的一些學(xué)習(xí)心得,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2021-02-02rabbitmq的消息持久化處理開啟,再關(guān)閉后,消費(fèi)者啟動(dòng)報(bào)錯(cuò)問題
這篇文章主要介紹了rabbitmq的消息持久化處理開啟,再關(guān)閉后,消費(fèi)者啟動(dòng)報(bào)錯(cuò)問題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-11-11Java正則驗(yàn)證IP的方法實(shí)例分析【測(cè)試可用】
這篇文章主要介紹了Java正則驗(yàn)證IP的方法,結(jié)合實(shí)例形式對(duì)比分析了網(wǎng)上常見的幾種針對(duì)IP的正則驗(yàn)證方法,最終給出了一個(gè)比較靠譜的IP正則驗(yàn)證表達(dá)式,需要的朋友可以參考下2017-08-08Springboot集成MongoDB無認(rèn)證與開啟認(rèn)證的配置方式
本文主要介紹了Springboot集成MongoDB無認(rèn)證與開啟認(rèn)證的配置方式,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2024-03-03redis 使用lettuce 啟動(dòng)內(nèi)存泄漏錯(cuò)誤的解決方案
這篇文章主要介紹了redis 使用lettuce 啟動(dòng)內(nèi)存泄漏錯(cuò)誤的解決方案,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2021-04-04使用Jenkins自動(dòng)化構(gòu)建工具進(jìn)行敏捷開發(fā)
這篇文章主要為大家介紹了使用Jenkins自動(dòng)化構(gòu)建工具進(jìn)行敏捷開發(fā),有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步早日升職加薪2022-04-04