SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解進行參數(shù)校驗

更新時間：2024年08月18日 14:42:51 作者：CodeDunkster

我們經(jīng)常需要對請求參數(shù)進行校驗,本文主要介紹了SpringBoot使用@NotEmpty、@NotBlank、@NotNull注解進行參數(shù)校驗,具有一定的參考價值,感興趣的可以了解一下

在 Spring Boot 項目中，我們經(jīng)常需要對請求參數(shù)進行校驗，以確保其符合預期的格式和內(nèi)容。Spring 提供了一些注解來簡化參數(shù)校驗的工作，其中包括 @NotEmpty、@NotBlank 和 @NotNull。在本文中，我們將學習如何使用這些注解來進行參數(shù)校驗，并解釋為什么要使用它們。

1. 導入依賴

首先，在 pom.xml 文件中添加以下 Maven 依賴：

xmlCopy code
&lt;dependency&gt;
    &lt;groupId&gt;org.springframework.boot&lt;/groupId&gt;
    &lt;artifactId&gt;spring-boot-starter-validation&lt;/artifactId&gt;
&lt;/dependency&gt;

這將導入 Spring Boot 提供的參數(shù)校驗功能所需的依賴。

2. 使用 @NotEmpty、@NotBlank、@NotNull

@NotEmpty：用于檢查集合或數(shù)組等對象是否為 null 或空。該注解通常用于檢查字符串是否為空，集合是否為空等情況。
@NotBlank：用于檢查字符串是否不為空，并且去除首尾空格后長度大于 0。該注解通常用于檢查用戶輸入的字符串是否為有效值。
@NotNull：用于檢查對象(包裝類：Integer、Boolean等)是否不為 null。該注解通常用于檢查對象是否已經(jīng)被初始化。

3. 增加 @Validated 注解

為了讓參數(shù)校驗注解生效，我們需要在 Controller 或 Service 類上添加 @Validated 注解。

4. 示例

假設我們有一個簡單的 Controller 處理器，用于接收用戶的注冊請求，并需要對用戶名和密碼進行校驗：

import javax.validation.Valid;
import javax.validation.constraints.NotBlank;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Validated
public class UserController {

    @PostMapping("/register")
    public String registerUser(@Valid @RequestBody UserDTO userDTO) {
        // 處理用戶注冊邏輯
        return "User registered successfully!";
    }

    public static class UserDTO {
        @NotBlank(message = "用戶名不能為空")
        private String username;

        @NotBlank(message = "密碼不能為空")
        private String password;

        // 省略 getter 和 setter 方法
    }
}

在上面的示例中，我們定義了一個 UserDTO 類用于接收用戶注冊的請求參數(shù)。通過在 username 和 password 字段上添加 @NotBlank 注解，我們要求這兩個字段不能為空，并且不允許只包含空格。同時，在 UserController 類上添加了 @Validated 注解，以確保參數(shù)校驗生效。

5. 為什么使用 @NotEmpty、@NotBlank、@NotNull

提高代碼健壯性：通過對參數(shù)進行校驗，可以有效地防止空指針異常或無效輸入帶來的問題，提高系統(tǒng)的穩(wěn)定性和安全性。
提升開發(fā)效率：使用這些注解可以減少手動編寫參數(shù)校驗邏輯的工作量，提高開發(fā)效率，同時使代碼更加清晰易讀。
統(tǒng)一規(guī)范：采用注解方式進行參數(shù)校驗可以使代碼規(guī)范化，降低維護成本，并且有利于團隊間的協(xié)作與交流。

6.全局異常處理器

在 Spring Boot 中，如果參數(shù)校驗失敗，將會拋出 MethodArgumentNotValidException 異常或 ConstraintViolationException 異常。為了統(tǒng)一處理這些異常，可以定義一個全局異常處理器。

下面是一個簡單的全局異常處理器示例：

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.MethodArgumentNotValidException;

@ControllerAdvice
public class GlobalExceptionHandler {

	@ExceptionHandler(MethodArgumentNotValidException.class)
	public ResponseEntity<String> handleValidationExceptions(MethodArgumentNotValidException ex) {
    return new ResponseEntity<>("Invalid request: " + ex.getMessage(), HttpStatus.BAD_REQUEST);
  }

// 可以添加其他異常處理方法
}

在上面的示例中，handleValidationExceptions 方法用于處理參數(shù)校驗異常 MethodArgumentNotValidException，并返回一個包含錯誤信息的 ResponseEntity 對象。

通過定義全局異常處理器，可以集中處理所有控制器中拋出的參數(shù)校驗異常，并向客戶端返回統(tǒng)一的錯誤信息，提高了代碼的可維護性和可重用性。