Springboot配置捕捉validate校验参数异常统一处理并自定义validate校验返回格式

一、自定义修改validate校验返回格式

@Valid ，@NotBlank，@NotNull是比较常用的参数校验注解

但是validate参数校验失败后，返回的json数据可能并不是咱们最终想要的，下图就是校验失败后它默认返回的数据

一般情况下，咱们可能只需要图中标红的那个提示信息就OK了

那怎么改它的返回数据呢？

只要添加一个异常处理类就行了

/**
 * validate校验 异常统一捕捉处理类
 */
@ControllerAdvice
public class WebExceptionHandler {

    /**
     * 处理请求参数格式错误 @RequestBody上使用@Valid 实体上使用@NotNull等，验证失败后抛出的异常是MethodArgumentNotValidException异常
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    @ResponseBody
    public JsonData MethodArgumentNotValidExceptionHandler(MethodArgumentNotValidException e) {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        return JsonData.buildCodeAndMsg(BASE_VAILD_EXCEPTION.getCode(),message);
    }

    /**
     * 处理Get请求中 使用@Valid 验证路径中请求实体校验失败后抛出的异常
     */
    @ExceptionHandler(BindException.class)
    @ResponseBody
    public JsonData BindExceptionHandler(BindException e) {
        String message = e.getBindingResult().getAllErrors().stream().map(DefaultMessageSourceResolvable::getDefaultMessage).collect(Collectors.joining());
        return JsonData.buildCodeAndMsg(BASE_VAILD_EXCEPTION.getCode(),message);
    }

    /**
     * 处理请求参数格式错误 @RequestParam上validate失败后抛出的异常是ConstraintViolationException
     */
    @ExceptionHandler(ConstraintViolationException.class)
    @ResponseBody
    public JsonData ConstraintViolationExceptionHandler(ConstraintViolationException e) {
        String message = e.getConstraintViolations().stream().map(ConstraintViolation::getMessage).collect(Collectors.joining());
        return JsonData.buildCodeAndMsg(BASE_VAILD_EXCEPTION.getCode(),message);
    }

    /**
     * 参数格式异常
     */
    @ExceptionHandler(HttpMessageNotReadableException.class)
    @ResponseBody
    public JsonData HttpMessageNotReadableExceptionHandler(HttpMessageNotReadableException e) {
        return JsonData.buildCodeAndMsg(BASE_VAILD_EXCEPTION.getCode(),"参数格式异常");
    }


}

配置完，看下效果

可以看到现在返回的数据已经是咱们自定义的数据了

二、配置校验快速失败：只要出现校验失败的情况，就结束校验，不再进行后续的校验

validate参数校验默认的是一个参数校验失败后，还会继续校验后面的参数，如下图，它会返回多个信息

但是实际情况一般是只要有一个参数校验失败了，就结束返回。那怎么改成想要的这样呢？

很简单，也是加一个配置类就好了（但是有的版本是不生效的）

/**
 * validate参数校验默认的是一个参数校验失败后，还会继续校验后面的参数
 * 通过这个配置改成：校验参数时只要出现校验失败的情况，就立即抛出对应的异常，结束校验，不再进行后续的校验
 */
@Configuration
public class WebConfig {

    @Bean
    public Validator validator() {
        ValidatorFactory validatorFactory = Validation.byProvider(HibernateValidator.class)
                .configure()
                //failFast的意思只要出现校验失败的情况，就立即结束校验，不再进行后续的校验。
                .failFast(true)
                .buildValidatorFactory();
        return validatorFactory.getValidator();
    }

    @Bean
    public MethodValidationPostProcessor methodValidationPostProcessor() {
        MethodValidationPostProcessor methodValidationPostProcessor = new MethodValidationPostProcessor();
        methodValidationPostProcessor.setValidator(validator());
        return methodValidationPostProcessor;
    }

}

配置好后，重启项目，看下效果

 可以看到就只返回了一条检验失败的提示。

觉得对你有帮助的话，可以点个关注，点个赞，3Q~