快捷導(dǎo)航

SpringBoot實(shí)體多層嵌套判空字段的方式

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

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

前言

最近在公司了接了個(gè)需求；需要開(kāi)發(fā)一個(gè)中間系統(tǒng)；進(jìn)行三方聯(lián)調(diào)；有接口開(kāi)發(fā)經(jīng)驗(yàn)的朋友都知道；參數(shù)校驗(yàn)是必備的一項(xiàng)操作；怎么優(yōu)雅的校驗(yàn)卻是個(gè)問(wèn)題；

我翻找了網(wǎng)絡(luò)上的一些校驗(yàn)方式；都比較參差不齊；多層嵌套下的判空校驗(yàn)寫(xiě)的也莫名其妙；不是很爽；所以這是寫(xiě)這篇文章的目的。

代碼部分會(huì)把GitHub或者gitee鏈接貼出來(lái)。正文部分只貼核心出裝。

涉及的知識(shí)點(diǎn)簡(jiǎn)單列一下；不需要的朋友可以關(guān)閉文章。

單層實(shí)體字段的判空方式
實(shí)體嵌套字段的判空方式
@NotEmpty、@Valid、@NotBlank、@NotNull注解介紹和使用場(chǎng)景
代碼地址： https://gitee.com/xbhog/screw-demo.git

正文

單層實(shí)體判空方式

構(gòu)建springboot項(xiàng)目等基礎(chǔ)設(shè)置就不說(shuō)了；

先來(lái)引包：

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

流程非常簡(jiǎn)單；

新建實(shí)體類；寫(xiě)兩個(gè)字段；使用@NotBlank注解修飾在某個(gè)字段上就可以進(jìn)行判空操作了。
新建接口；接收User實(shí)體進(jìn)行映射即可；需要注意的是接口實(shí)體前面需要有 @Valid注解修飾對(duì)象才校驗(yàn)的住
字段校驗(yàn)失敗的返回信息獲取：BindingResult bindingResult

@GetMapping("/save_user")
public String saveUser(@Valid User u, BindingResult bindingResult) {
    if(bindingResult.hasErrors()){
        // 獲取校驗(yàn)不通過(guò)字段的提示信息
        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()){
        // 獲取校驗(yàn)不通過(guò)字段的提示信息
        List<FieldError> fieldErrors = bindingResult.getFieldErrors();
        // 創(chuàng)建一個(gè) List 來(lái)存儲(chǔ)每條錯(cuò)誤信息
        List<String> errorMessages = new ArrayList<>();

        // 遍歷 FieldError 列表
        for (FieldError fieldError : fieldErrors) {
            // 獲取 field 和 defaultMessage
            String field = fieldError.getField();
            String defaultMessage = fieldError.getDefaultMessage();

            // 拼接成一條完整的錯(cuò)誤信息
            String errorMessage = "字段位置 '" + field + "' " + defaultMessage;

            // 添加到 errorMessages 列表中
            errorMessages.add(errorMessage);
        }

        // 如果需要將所有錯(cuò)誤信息合并成一個(gè)字符串
        return String.join("; ", errorMessages);

    }
    return "user will save: name=" + u.getName() + ", age=" + u.getAge();
}

看到這里；有朋友應(yīng)該反應(yīng)過(guò)來(lái)是不是可以對(duì)JSON進(jìn)行一些微操？只返回我們需要的格式。 字段位置 '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": ""
    }
]

實(shí)體嵌套判空方式

接口請(qǐng)求格式；其中包含List嵌套、實(shí)體嵌套等。

{
  "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"
  }
}

來(lái)看使用：@Valid、@NotEmpty、@NotNull通過(guò)這三者的匹配就可以完成List以及實(shí)體的校驗(yàn)了。

@Data
public class Emp {
    @NotBlank(message = "員工編號(hào)不能為空")
    private  String empNo;
    @NotBlank(message = "員工姓名不能為空")
    private  String empName;
    @NotBlank(message = "員工職位不能為空")
    private  String job;

    @Valid
    @NotEmpty(message = "部門(mén)列表不能為空")
    private List<Dept> dept;

    @NotNull
    private Test test;
}
-------------------------------
@Data
public class Dept {
    @NotBlank(message = "部門(mén)編號(hào)不能為空")
    private String  deptNo;
    @NotBlank(message = "部門(mén)名稱不能為空")
    private String  deptName;

    @Valid
    @NotEmpty(message = "部門(mén)中的用戶列表不能為空")
    private List<User> users;
}
--------------------------------
@Data
public class User {

    @NotBlank(message = "用戶名不能為空")
    private String name;

    private Integer age;
}

接口請(qǐng)求的方式同單層實(shí)例一樣；響應(yīng)結(jié)果：可以完全定位到某個(gè)List下的某個(gè)實(shí)體中的某個(gè)字段

字段位置 'dept[0].deptName' 部門(mén)名稱不能為空; 
字段位置 'empName' 員工姓名不能為空; 
字段位置 'dept[0].users[0].name' 用戶名不能為空; 
字段位置 'dept[0].deptNo' 部門(mén)編號(hào)不能為空; 
字段位置 'empNo' 員工編號(hào)不能為空; 
字段位置 'job' 員工職位不能為空

注解說(shuō)明

@NotEmpty：這個(gè)注解檢查字符串（String）是否為空（""），或者集合（Collection）、地圖（Map）是否為空或者為null。它不會(huì)檢查字符串中的空白字符。
@Valid：這是一個(gè)遞歸驗(yàn)證注解，意味著它會(huì)深入到對(duì)象的屬性中去驗(yàn)證那些也是復(fù)雜對(duì)象的屬性。當(dāng)你希望驗(yàn)證一個(gè)對(duì)象的所有屬性都符合定義好的約束時(shí)，可以使用@Valid。

- 當(dāng)使用 @Valid校驗(yàn)時(shí)，要小心避免循環(huán)引用的情況，即對(duì)象之間相互校驗(yàn)可能導(dǎo)致無(wú)限遞歸

@NotBlank：此注解專門(mén)用來(lái)驗(yàn)證字符串（String），它檢查字符串是否為null，長(zhǎng)度是否為零，或者是否只包含空白字符。如果字符串包含至少一個(gè)非空白字符，則認(rèn)為是有效的。
@NotNull：這個(gè)注解用來(lái)驗(yàn)證一個(gè)字段或者屬性是否為null。它并不關(guān)心字符串中的內(nèi)容，只要對(duì)象不是null即可。