Spring boot 拾遗 —— 错误验证

1 前言

Spring 的验证框架为我们提供了强大的验证功能，我们不但要会使用它，更要知道它工作的原理，这一文将简要点出 验证的基础基础流程，包括

• spring 如果确定入参需要参与验证
• spring 如何决定是抛出各种验证错误，还是将错误信息传递给开发人员
• spring 如何为表单验证与 JSON 请求体验证产生的不同类型的错误
• spring 如何调用我们编写的自定义全局错误处理器

最后改写默认的全局错误处理器以尽可能覆盖各种错误

2 从表单验证方式说起

spring boot 提供了我们多种验证方式, 通常我们遵循 spring mvc 提供的思想，在控制层写下如下代码:

    @PostMapping("register")
    public Object register(@Validated RegisterForm form, BindiningResult result, HttpServletResponse response) {
        if (result.hasErrors()) {
            Map<String, String> map = new HashMap<>(4);
            result.getFieldErrors().forEach(e -> map.put(e.getObjectName(), e.getDefaultMessage()));
            response.setStatus(HttpServletResponse.SC_BAD_REQUEST);
            return map;
        }
        return userService.register(form) ? "success" : "fail";
    }

 

在实际的开发中如果采用这种方式，太多重复性劳动的方式会使得开发变得枯燥且不好维护。

2.1 抛弃 BindiningResult

让我们抛弃 BindingResult，改写方法成下方这一简单的形式，然后提交一个表单

    @PostMapping("register")
    public Object register(@Validated RegisterForm form) {
        return userService.register(form) ? "success" : "fail";
    }

然后观察其抛出的错误：

 

2.2 RestControllerAdvice 捕捉 BindException 错误

上边的返回是不可读的，不可能直接交付给前端，下边是一个适用于 RestController 的全局错误处理器，没有什么特别的

/**
 * @author pancc
 * @version 1.0
 */
@RestControllerAdvice(annotations = RestController.class) 
 6 public class ExceptionResolver {

    @ExceptionHandler(BindException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Map<String, String> bindException(@Nonnull BindException ex) {
        Map<String, String> map = new HashMap<>(4);
        ex.getFieldErrors().forEach(e -> map.put(e.getField(), e.getDefaultMessage()));
        return map;
    }
}

2.3 BindException 错误的产生来源

在 spring 调用 ModelAttributeMethodProcessor#resolveArgument 方法处理方法参数的时候，

会调用 validateIfApplicable 尝试对每一个有 Validated 或者 Valid 注解的参数进行验证，

如果验证的结果存在错误，就会检查是否调用的方法是否入参存在  Errors 的实现，即我们传进去的 BindingResult，如果有则将错误信息放进去  BindingResult ， 否则抛出一个 BindException 错误。 

2.4 RestControllerAdvice 的查找与调用

spring 调用 ExceptionHandlerExceptionResolver#getExceptionHandlerMethod 方法查找我们配置的 ExceptionHandler 

 

并且测试是否我们配置的 Handler 是否支持这个方法，在这里我们配置了支持注解 @RestController，需要注意的是，如果  @ExceptionHandler 注解上没有任何属性，将会直接匹配到

 

 2.4.1 ReponseStatus 的查找

3 JSON 请求体验证

与表单验证类似，但是验证是在 RequestResponseBodyMethodProcessor#resolveArgument 方法中进行的，抛出的类型也不同，是：MethodArgumentNotValidException。

3.1 验证代码准备

    @PostMapping("register")
    public Object register(@RequestBody @Validated RegisterForm form) {
        return userService.register(form) ? "success" : "fail";
    }

3.2 RestControllerAdvice 捕捉 BindException 错误

与表单验证不同，我们这次要捕捉 MethodArgumentNotValidException 错误：

    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    public Map<String, String> methodArgumentNotValidException(@Nonnull MethodArgumentNotValidException ex) {
        Map<String, String> map = new HashMap<>(4);
        ex.getBindingResult().getFieldErrors().forEach(e -> map.put(e.getField(), e.getDefaultMessage()));
        return map;
    }

4 预设的全局错误处理

作为一个普通的开发人员，总会有很多遗漏，此时，让我们的 全局错误处理器  继承 ResponseEntityExceptionHandler 是个不错的选择，相应的，我们只要重写对应的表单验证与 JSON 请求验证的相关逻辑：

package cn.pancc.springboot.examples.security.global;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RestControllerAdvice;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;

import java.util.HashMap;
import java.util.Map;

/**
 * @author pancc
 * @version 1.0
 */
@RestControllerAdvice(annotations = RestController.class)
public class ErrorHandlerExceptionResolver extends ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        Map<String, String> errors = new HashMap<>(4);
        ex.getBindingResult().getFieldErrors().forEach(e -> errors.put(e.getField(), e.getDefaultMessage()));
        return new ResponseEntity<>(errors, status);
    }

    @Override
    protected ResponseEntity<Object> handleBindException(BindException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        Map<String, String> errors = new HashMap<>(4);
        ex.getBindingResult().getFieldErrors().forEach(e -> errors.put(e.getField(), e.getDefaultMessage()));
        return new ResponseEntity<>(errors, status);
    }
}