SpringBoot实体多层嵌套判空字段的方式_Java

前言

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

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

代码部分会把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 和 defaultmessage
            string 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;

    @notnull
    private 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即可。