閱讀本文需要Spring Boot、Java註解等背景知識

背景

我們通常需要驗證引數是否非法, 比如長度、非空、列舉範圍等.

• 二逼青年的做法是寫一堆if進行校驗

if (id == null || id <= 0) {
    throw new WrongParamException("引數id錯誤");
}

• 普通青年的做法是封裝成一個方法

public static String verifyStringOfRequire(String val, String name, int length) throws WrongParamException {
    if
 
 (val == null) {
        throw new WrongParamException("請填寫" + name);
    } else {
        val = val.trim();
        if (val.length() == 0) {
            throw new WrongParamException(name + "不能全部為空格");
        }
        if (val.length() > length) {
            throw new WrongParamException(name + "長度不能超過"
 
 + length);
        }
        return val;
    }
}

...

String name = MyUtils.verifyStringOfRequire(requestDto.getName(), "名字", 100);

兩種程式碼都混入了與業務邏輯無關的程式碼, 因此文藝青年的做法是利用spring提供的驗證框架. 以下分幾種應用場景來介紹

RequestParam和PathVariable

spring為我們提供兩個基本的註解, RequestParam和PathVariable, 可以指定我們需要的引數名、引數型別、是否必填等基本校驗, 否則返回400錯誤碼.

驗證屬性

@GetMapping("/validStringLength")
public ResponseEntity<String> validStringLength(
        @Valid
        @Size(min = 10, message = "wrong length")
        @RequestParam(value = "value") String value) {
    return ResponseEntity.ok(value);
 }

此時傳入一個長度小於10的引數, 就會報錯. 如果再配合一個全域性異常攔截, 提示message的內容, 就非常爽歪歪了.

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(value = ConstraintViolationException.class)
    public ResponseEntity<String> constraintViolationExceptionHandler(ConstraintViolationException e) {
        return ResponseEntity.badRequest().body(e.getConstraintViolations().stream()
                .map(ConstraintViolation::getMessageTemplate)
                .findFirst()
                .orElse(e.getMessage())
        );
    }
}

[1]: