Spring?Boot常用的參數(shù)驗證技巧和使用方法

更新時間：2023年09月11日 14:49:00 作者：曾幾何時…

Spring Boot是一個使用Java編寫的開源框架，用于快速構建基于Spring的應用程序，這篇文章主要介紹了Spring?Boot常用的參數(shù)驗證技巧和使用方法,需要的朋友可以參考下

簡介

Spring Boot是一個使用Java編寫的開源框架，用于快速構建基于Spring的應用程序。在實際開發(fā)中，經常需要對輸入?yún)?shù)進行驗證，以確保數(shù)據(jù)的完整性和準確性。Spring Boot提供了多種方式來進行參數(shù)驗證，并且可以很方便地集成到應用程序中。

1. 使用JSR-303注解進行參數(shù)驗證

JSR-303是Java Validation API的規(guī)范之一，它定義了一套用于參數(shù)驗證的注解。Spring Boot支持使用這些注解來驗證方法參數(shù)、請求參數(shù)和實體類字段等。

@RestController
public class UserController {
    @PostMapping("/user")
    public ResponseEntity<String> createUser(@Valid @RequestBody UserRequest request) {
        // 處理請求
        return ResponseEntity.ok("User created successfully");
    }
}

在上面的例子中， @Valid 注解用于標記需要驗證的參數(shù)， @RequestBody 注解用于指定該參數(shù)為請求體。而 UserRequest 則是一個自定義的實體類，使用了JSR-303注解來驗證字段。

public class UserRequest {
    @NotBlank(message = "用戶名不能為空")
    private String username;
    @Size(min = 6, max = 12, message = "密碼長度必須在6到12個字符之間")
    private String password;
    // getter 和 setter 方法省略
}

在 UserRequest 類中，我們使用了 @NotBlank 注解來驗證 username 字段不能為空，使用了 @Size 注解來驗證 password 字段的長度在6到12個字符之間。當參數(shù)驗證失敗時，框架會自動拋出 MethodArgumentNotValidException 異常，并返回相應的錯誤信息。

2. 使用自定義驗證器

除了使用JSR-303注解外，你還可以編寫自己的參數(shù)驗證器。這對于一些特殊的驗證需求，或者需要復雜邏輯的驗證場景非常有用。

@Component
public class AgeValidator implements ConstraintValidator<ValidAge, Integer> {
    @Override
    public boolean isValid(Integer age, ConstraintValidatorContext context) {
        // 實現(xiàn)自定義的驗證邏輯
        return age >= 18 && age <= 60;
    }
}

首先，我們需要編寫一個實現(xiàn)了 ConstraintValidator 接口的驗證器類。在上面的例子中，我們定義了一個 AgeValidator 類，用于驗證年齡是否在合法范圍內（18到60歲）。然后，我們需要在需要驗證的地方使用 @ValidAge 注解來標記需要驗證的參數(shù)。

@RestController
public class UserController {
    @PostMapping("/user")
    public ResponseEntity<String> createUser(@ValidAge @RequestParam("age") Integer age) {
        // 處理請求
        return ResponseEntity.ok("User created successfully");
    }
}

在上述代碼中，我們使用了 @ValidAge 注解來驗證 age 參數(shù)的合法性。當參數(shù)驗證失敗時，框架會自動拋出 MethodArgumentNotValidException 異常，并返回相應的錯誤信息。

3. 自定義驗證錯誤處理

除了使用框架提供的默認錯誤處理方式外，你還可以定制化錯誤處理?？梢酝ㄟ^編寫全局異常處理器來對參數(shù)驗證失敗時的異常進行捕獲和處理。

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<String> handleMethodArgumentNotValid(MethodArgumentNotValidException ex) {
        BindingResult result = ex.getBindingResult();
        List<ObjectError> errors = result.getAllErrors();
        StringBuilder errorMessage = new StringBuilder();
        for (ObjectError error : errors) {
            errorMessage.append(error.getDefaultMessage()).append("; ");
        }
        return ResponseEntity.badRequest().body(errorMessage.toString());
    }
}

在上述代碼中，我們使用 @ControllerAdvice 注解將該類聲明為全局異常處理器，并使用 @ExceptionHandler 注解來指定處理 MethodArgumentNotValidException 異常。當參數(shù)驗證失敗時，會自動進入到這個處理方法中，我們可以從異常對象中獲取詳細的錯誤信息并進行處理。