当前位置：首页 > news >正文

【SpringBoot】实体多层嵌套如何判空字段？

news 来源：原创 2024/9/19 12:02:15

前言

最近在公司了接了个需求；需要开发一个中间系统；进行三方联调；有接口开发经验的朋友都知道；参数校验是必备的一项操作；怎么优雅的校验却是个问题；

我翻找了网络上的一些校验方式；都比较参差不齐；多层嵌套下的判空校验写的也莫名其妙；不是很爽；所以这是写这篇文章的目的。

代码部分会把GitHub或者gitee链接贴出来。正文部分只贴核心出装。

涉及的知识点简单列一下；不需要的朋友可以关闭文章。

单层实体字段的判空方式
实体嵌套字段的判空方式
@NotEmpty、@Valid、@NotBlank、@NotNull注解介绍和使用场景
代码地址： https://gitee.com/xbhog/screw-demo.git

正文

单层实体判空方式

构建springboot项目等基础设置就不说了；

先来引包：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-validation</artifactId>
</dependency>

流程非常简单；

新建实体类；写两个字段；使用@NotBlank注解修饰在某个字段上就可以进行判空操作了。
新建接口；接收User实体进行映射即可；需要注意的是接口实体前面需要有 @Valid注解修饰对象才校验的住
字段校验失败的返回信息获取：BindingResult bindingResult

@GetMapping("/save_user")
public String saveUser(@Valid User u, BindingResult bindingResult) {if(bindingResult.hasErrors()){// 获取校验不通过字段的提示信息List<FieldError> fieldErrors = bindingResult.getFieldErrors();return JSON.toJSONString(fieldErrors);}return "user will save: name=" + u.getName() + ", age=" + u.getAge();
}
// ---------------------
@GetMapping("/save_user")
public String saveUser(@Valid User u, BindingResult bindingResult) {if(bindingResult.hasErrors()){// 获取校验不通过字段的提示信息List<FieldError> fieldErrors = bindingResult.getFieldErrors();// 创建一个 List 来存储每条错误信息List<String> errorMessages = new ArrayList<>();// 遍历 FieldError 列表for (FieldError fieldError : fieldErrors) {// 获取 field 和 defaultMessageString field = fieldError.getField();String defaultMessage = fieldError.getDefaultMessage();// 拼接成一条完整的错误信息String errorMessage = "字段位置 '" + field + "' " + defaultMessage;// 添加到 errorMessages 列表中errorMessages.add(errorMessage);}// 如果需要将所有错误信息合并成一个字符串return String.join("; ", errorMessages);}return "user will save: name=" + u.getName() + ", age=" + u.getAge();
}

看到这里；有朋友应该反应过来是不是可以对JSON进行一些微操？只返回我们需要的格式。 字段位置 'name' 用户名不能为空

[{"arguments": [{"code": "name","codes": ["user.name","name"],"defaultMessage": "name"}],"bindingFailure": false,"code": "NotBlank","codes": ["NotBlank.user.name","NotBlank.name","NotBlank.java.lang.String","NotBlank"],"defaultMessage": "用户名不能为空","field": "name","objectName": "user","rejectedValue": ""}
]

实体嵌套判空方式

接口请求格式；其中包含List嵌套、实体嵌套等。

{"empNo": "empNo_a9f8f3b460d9","empName": "empName_7a907030695b","job": "job_a518f90c4ea3","dept": [{"deptNo": "deptNo_3bcb556444f4","deptName": "deptName_9ccf2be206d3","users": [{"name": "name_c387b61bc96f","age": 0}]}],"test": {"test1": "test1_4f553816ae20","test2": "test2_89b1507abe90"}
}

来看使用：@Valid、@NotEmpty、@NotNull通过这三者的匹配就可以完成List以及实体的校验了。

@Data
public class Emp {@NotBlank(message = "员工编号不能为空")private  String empNo;@NotBlank(message = "员工姓名不能为空")private  String empName;@NotBlank(message = "员工职位不能为空")private  String job;@Valid@NotEmpty(message = "部门列表不能为空")private List<Dept> dept;@NotNullprivate Test test;
}
-------------------------------
@Data
public class Dept {@NotBlank(message = "部门编号不能为空")private String  deptNo;@NotBlank(message = "部门名称不能为空")private String  deptName;@Valid@NotEmpty(message = "部门中的用户列表不能为空")private List<User> users;
}
--------------------------------
@Data
public class User {@NotBlank(message = "用户名不能为空")private String name;private Integer age;
}

接口请求的方式同单层实例一样；响应结果：可以完全定位到某个List下的某个实体中的某个字段

字段位置 'dept[0].deptName' 部门名称不能为空; 
字段位置 'empName' 员工姓名不能为空; 
字段位置 'dept[0].users[0].name' 用户名不能为空; 
字段位置 'dept[0].deptNo' 部门编号不能为空; 
字段位置 'empNo' 员工编号不能为空; 
字段位置 'job' 员工职位不能为空

注解说明

@NotEmpty：这个注解检查字符串（String）是否为空（“”），或者集合（Collection）、地图（Map）是否为空或者为null。它不会检查字符串中的空白字符。
@Valid：这是一个递归验证注解，意味着它会深入到对象的属性中去验证那些也是复杂对象的属性。当你希望验证一个对象的所有属性都符合定义好的约束时，可以使用@Valid。

- 当使用 @Valid校验时，要小心避免循环引用的情况，即对象之间相互校验可能导致无限递归

@NotBlank：此注解专门用来验证字符串（String），它检查字符串是否为null，长度是否为零，或者是否只包含空白字符。如果字符串包含至少一个非空白字符，则认为是有效的。
@NotNull：这个注解用来验证一个字段或者属性是否为null。它并不关心字符串中的内容，只要对象不是null即可。