介紹

JSR-380是 J2EE 的一個(gè)規(guī)范，用于校驗(yàn)實(shí)體屬性，它是JSR-303的升級版，在 Spring Boot 中可以基于它優(yōu)雅實(shí)現(xiàn)參數(shù)校驗(yàn)。

示例

在沒有使用JSR-380之前，我們一般都會將參數(shù)校驗(yàn)硬編碼在controller類中，示例：

public Result add(@RequestBody User user){
    if(StringUtils.isBlank(user.getName())){
        return Result.error("用戶名不能為空");
    }
    // ...
}

而使用JSR-380只需要通過添加對應(yīng)的注解即可實(shí)現(xiàn)校驗(yàn)，示例：

@Data
public class User{
    @NotBlank
    private String name;
    private Integer age;
}

public Result register(@Validated @RequestBody User user){
    // ...
}

這樣看起來代碼是不是清爽了很多，只需要在需要校驗(yàn)的字段上加上對應(yīng)的校驗(yàn)注解，然后對需要校驗(yàn)的地方加上@Validated注解，然后框架就會幫我們完成校驗(yàn)。

通過全局異常自定義錯(cuò)誤響應(yīng)

框架校驗(yàn)失敗之后會拋出異常，需要捕獲這個(gè)異常然后來自定義校驗(yàn)不通過的錯(cuò)誤響應(yīng)，這里直接貼代碼，兼容@RequestBody、@ModelAttribute、@RequestParam三種入?yún)⒌男ｒ?yàn)：

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = {MethodArgumentNotValidException.class, BindException.class})
    public ResponseEntity<Result> methodArgumentNotValidHandler(HttpServletRequest request, Exception e) {
        BindingResult bindingResult;
        if (e instanceof MethodArgumentNotValidException) {
            //@RequestBody參數(shù)校驗(yàn)
            bindingResult = ((MethodArgumentNotValidException) e).getBindingResult();
        } else {
            //@ModelAttribute參數(shù)校驗(yàn)
            bindingResult = ((BindException) e).getBindingResult();
        }
        FieldError fieldError = bindingResult.getFieldError();
        return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + fieldError.getField() + "]" + fieldError.getDefaultMessage()));
    }

    //@RequestParam參數(shù)校驗(yàn)
    @ExceptionHandler(value = {ConstraintViolationException.class, MissingServletRequestParameterException.class})
    public ResponseEntity<Result> constraintViolationHandler(Exception e) {
        String field;
        String msg;
        if (e instanceof ConstraintViolationException) {
            ConstraintViolation<?> constraintViolation = ((ConstraintViolationException) e).getConstraintViolations().stream().findFirst().get();
            List<Path.Node> pathList = StreamSupport.stream(constraintViolation.getPropertyPath().spliterator(), false)
                    .collect(Collectors.toList());
            field = pathList.get(pathList.size() - 1).getName();
            msg = constraintViolation.getMessage();
        } else {
            // 這個(gè)不是JSR標(biāo)準(zhǔn)返回的異常，要自定義提示文本
            field = ((MissingServletRequestParameterException) e).getParameterName();
            msg = "不能為空";
        }
        return ResponseEntity.ok(Result.fail(Result.CODE_PARAMS_INVALID, "[" + field + "]" + msg));
    }
}

然后再訪問一下接口，可以看到錯(cuò)誤提示已經(jīng)按自定義的規(guī)范顯示了：

可以看到都不需要寫任何提示文本就可以完成校驗(yàn)和提示，上圖的不能為空是框架內(nèi)置的I18N國際化支持，每個(gè)注解都內(nèi)置相應(yīng)的提示模板。

常用校驗(yàn)注解

附錄

本文完整代碼放在github。

• Java Bean Validation Basics
• JSR-380 規(guī)范

本文首發(fā)于我的博客：https://monkeywie.cn，歡迎收藏！不定期分享JAVA、Golang、前端、docker、k8s等干貨知識。