SpringBoot實體多層嵌套判空字段的方式

更新時間：2024年09月02日 08:22:42 作者：xbhog

這篇文章主要介紹了SpringBoot實體多層嵌套如何判空字段,最近在公司了接了個需求：需要開發(fā)一個中間系統(tǒng),進行三方聯調,文中通過代碼示例介紹的非常詳細,需要的朋友可以參考下

前言

最近在公司了接了個需求；需要開發(fā)一個中間系統(tǒng)；進行三方聯調；有接口開發(fā)經驗的朋友都知道；參數校驗是必備的一項操作；怎么優(yōu)雅的校驗卻是個問題；

我翻找了網絡上的一些校驗方式；都比較參差不齊；多層嵌套下的判空校驗寫的也莫名其妙；不是很爽；所以這是寫這篇文章的目的。

代碼部分會把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();
        // 創(chuàng)建一個 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校驗時，要小心避免循環(huán)引用的情況，即對象之間相互校驗可能導致無限遞歸

@NotBlank：此注解專門用來驗證字符串（String），它檢查字符串是否為null，長度是否為零，或者是否只包含空白字符。如果字符串包含至少一個非空白字符，則認為是有效的。
@NotNull：這個注解用來驗證一個字段或者屬性是否為null。它并不關心字符串中的內容，只要對象不是null即可。