springboot @Valid注解对嵌套类型的校验功能
作者:张占岭 发布时间:2023-07-01 13:02:18
标签:spring,boot,注解
@Valid注解可以实现数据的验证,你可以定义实体,在实体的属性上添加校验规则,而在API接收数据时添加@valid关键字,这时你的实体将会开启一个校验的功能,具体的代码如下,是最基本的应用:
实体:
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接口:
@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即可实现对这个属性的校验
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错误就可以在单元测试下面正常输出了!
@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("技术部")
.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的话,由于用户名为空,所以会出现错误提示
api.post()
.uri("/v1/12345/2018-03")
.body(BodyInserters.fromObject(request))
.exchange()
.expectStatus().isOk();
可以看一下结果的提示信息
总结
以上所述是小编给大家介绍的springboot @Valid注解对嵌套类型的校验网站的支持!
来源:http://www.cnblogs.com/lori/p/9088380.html
0
投稿
猜你喜欢
- Java8的groupingBy实现集合的分组,类似Mysql的group by分组功能,注意得到的是一个map对集合按照单个属性分组、分组
- 前言这是该工具的github地址:https://github.com/pingfangushi/screw一、引入pom.xml依赖<
- 在使用NavigationPage导航的时候, 我们可以给里面添加一些功能按钮, 如下所示:<ContentPage.ToolbarI
- 本文实例为大家分享了Swing拆分窗格控件JSplitPane的使用方法,供大家参考,具体内容如下package day1115;impor
- 项目中经常会使用到一对多的查询场景,但是PageHelper对这种嵌套查询的支持不够,如果是一对多的列表查询,返回的分页结果是不对的参考Gi
- 1、自定义实现该类package com.linmain.dict.handle;import org.apache.ibatis.sess
- 一、参数管理在编程系统中,为了能写出良好的代码,会根据是各种设计模式、原则、约束等去规范代码,从而提高代码的可读性、复用性、可修改,实际上个
- BeanUtils.copyProperties无法封装使用BeanUtils.copyProperties(user, memeber);
- 1、继承Thread类方式这种方式适用于执行特定任务,并且需要获取处理后的数据的场景。举例:一个用于累加数组内数据的和的线程。public
- mybatis-plus作为mybatis的增强工具,简化了开发中的数据库操作。一旦遇到left join或right join的左右连接,
- Sharding-Proxy是一个分布式数据库中间件,定位为透明化的数据库代理端。作为开发人员可以完全把它当成数据库,而它具体的分片规则在S
- 我们今天不探讨框架层面的内容,暂且认为90%的框架不存在无法容忍的性能问题。在做系统调优的过程中,面对随处可见的invoke调用,我的内心其
- 假如是在同一台机器上开发,前后端分离的工程中出现跨域问题的原因是,前端工程和后端工程运行在不同的端口上。只要协议、域名、端口有一个不同就会产
- Maven工程分模块开发完成 父工程配置了 tomcat7插件,运行 run命令执行run指令时失败,报错信息如下:D:\java\JDK8
- 一、点睛邻接矩阵通常采用一个一维数组存储图中节点的信息,采用一个二维数组存储图中节点之间的邻接关系。邻接矩阵可以用来表示无向图、有向图和网。
- 1、来源random.nextInt() 为 java.util.Random类中的方法; Math.random() 为 java.lan
- Singleton是众多设计模式中最容易理解的一种,也是众多设计模式中较为重要的一种设计模式。接下来我们看看具体介绍。Singleton模式
- Java的Arrays类中有一个sort()方法,该方法是Arrays类的静态方法,在需要对数组进行排序时,非常的好用。但是sort()的参
- Java类中字段可以不赋予初始值的原因Java虚拟机会对类的实例对象进行分配内存,在分配内存后,会将内存空间(除了对象头)全部初始化为零值。
- 摘要:这个问题算是老生常谈了,我也是一段时间没弄过了,所以感觉有些忘了,就记录一下。一、后端通过shiro在session中存储数据://