SpringBoot 接口對參數(shù)進行校驗

作者：理工男二號 2023-03-16 08:23:33

在 Spring Boot 中，我們可以使用 Java Bean Validation API（JSR 303）來對接口參數(shù)進行校驗，該 API 遵循標準的注解格式進行參數(shù)校驗。

以下是一些常見的注解：

@NotNull：校驗對象是否為 null；
@Size(min, max)：校驗字符串的長度是否在 min 和 max 之間；
@Min：校驗數(shù)字是否大于等于指定值；
@Max：校驗數(shù)字是否小于等于指定值；
@Email：校驗字符串是否符合 Email 格式。

下面是一個例子，假設我們有一個用戶注冊接口，需要校驗用戶名和密碼：

@RestController
public class UserController {

    @PostMapping("/register")
    public ResponseEntity<?> registerUser(@RequestBody @Valid UserDto userDto) {
        // 處理用戶注冊請求
        return ResponseEntity.ok().build();
    }

    public static class UserDto {
        @NotNull
        private String username;

        @NotNull
        @Size(min = 6, max = 20)
        private String password;

        public String getUsername() {
            return username;
        }

        public void setUsername(String username) {
            this.username = username;
        }

        public String getPassword() {
            return password;
        }

        public void setPassword(String password) {
            this.password = password;
        }
    }
}

在上面的例子中，我們在 UserDto 類上使用了 @Valid 注解，該注解會告訴 Spring Boot 對該對象進行校驗。在 UserDto 類中，我們使用了 @NotNull 和 @Size 注解對 username 和 password 進行校驗，保證它們不為 null，且 password 的長度在 6 到 20 之間。

如果校驗失敗，Spring Boot 會拋出MethodArgumentNotValidException 異常，我們可以在 @ExceptionHandler 中捕獲該異常，并返回一個包含錯誤信息的 JSON 響應，例如：

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<?> handleMethodArgumentNotValidException(MethodArgumentNotValidException ex) {
        List<String> errors = ex.getBindingResult()
                .getAllErrors()
                .stream()
                .map(DefaultMessageSourceResolvable::getDefaultMessage)
                .collect(Collectors.toList());
        return ResponseEntity.badRequest().body(errors);
    }
}

在上面的例子中，我們定義了一個全局異常處理器，并在其中捕獲MethodArgumentNotValidException 異常，將校驗失敗的錯誤信息封裝成一個列表并返回。

通過上述方式，我們就可以對接口參數(shù)進行校驗，并在校驗失敗時返回錯誤信息，提高接口的健壯性和可靠性。

責任編輯：姜華來源：今日頭條

SpringBoot 參數(shù)校驗

成人免费xxxxx在线视频软件_久久精品久久久_亚洲国产精品久久久_天天色天天色_亚洲人成一区_欧美一级欧美三级在线观看

SpringBoot 接口對參數(shù)進行校驗