Java工具-Valid校验异常捕获全局拦截器

该博客主要展示了如何在Spring Boot应用中处理HTTP请求的验证异常。通过@RestControllerAdvice和@Slf4j注解实现全局异常处理,针对Get和Post请求的BindException、MethodArgumentNotValidException以及ConstraintViolationException异常进行了捕获和处理。当验证失败时,返回包含错误代码和错误信息的ResponseResult对象。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

import com.alibaba.fastjson.JSONObject;
import com.epro.commons.response.ArgumentCode;
import com.epro.commons.response.ResponseResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindException;
import org.springframework.validation.BindingResult;
import org.springframework.validation.ObjectError;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.RestControllerAdvice;

import javax.validation.ConstraintViolation;
import javax.validation.ConstraintViolationException;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * @author zss
 * @description: TODO
 * @date 2021/11/3 10:43
 */
@RestControllerAdvice
@Slf4j
public class RestExceptionHandler {


    /**
     * 处理Get请求的验证异常
     *
     * @param result
     * @return com.flyduck.cms.vo.ApiResult
     */
    @ExceptionHandler(BindException.class)
    public ResponseResult bindExceptionHandle(BindingResult result) {

        if (result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
          /*  List<String> list = new ArrayList<>();
            errors.forEach(p ->{
                FieldError fieldError = (FieldError) p;
                list.add(fieldError.getDefaultMessage());
            });*/
            if (!errors.isEmpty() && !StringUtils.isEmpty(errors.get(0).getDefaultMessage())) {
                return new ResponseResult(false, ArgumentCode.PARAMS_ERROR.getCode(), errors.get(0).getDefaultMessage(), null);
            }

        }

        return new ResponseResult(ArgumentCode.PARAMS_ERROR);
    }

    /**
     * 处理Post请求的验证异常
     *
     * @param exception
     * @return com.flyduck.cms.vo.ApiResult
     */
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseResult methodArgumentNotValidHandler(MethodArgumentNotValidException exception) {

        BindingResult result = exception.getBindingResult();
        if (result != null && result.hasErrors()) {
            List<ObjectError> errors = result.getAllErrors();
            /*List<String> list = new ArrayList<>();
            errors.forEach(p ->{
                FieldError fieldError = (FieldError) p;
                list.add(fieldError.getDefaultMessage());
            });*/
            if (!errors.isEmpty() && !StringUtils.isEmpty(errors.get(0).getDefaultMessage())) {
                return new ResponseResult(false, ArgumentCode.PARAMS_ERROR.getCode(), errors.get(0).getDefaultMessage(), null);
            }

        }

        return new ResponseResult(ArgumentCode.PARAMS_ERROR);
    }

    /**
     * 处理请求参数格式的验证异常
     *
     * @param exception
     * @return com.flyduck.cms.vo.ApiResult
     */
    @ExceptionHandler(ConstraintViolationException.class)
    public ResponseResult constraintViolationHandler(ConstraintViolationException exception) {
        Set<ConstraintViolation<?>> violations = exception.getConstraintViolations();
        if (violations.size() > 0) {
            List<String> list = new ArrayList<>();
            for (ConstraintViolation<?> violation : violations) {
                list.add(violation.getMessage());
            }
            if (!list.isEmpty()) {
                return new ResponseResult(false, ArgumentCode.PARAMS_ERROR.getCode(), list.get(0), null);
            }
        }

        return new ResponseResult(ArgumentCode.PARAMS_ERROR);
    }

    @ExceptionHandler(CustomException.class)
    public ResponseResult exception(Exception e) {
        log.error("---------------------error:{}-------------------------", e.getMessage());
        Map map = JSONObject.parseObject(e.getMessage(), Map.class);
        return ResponseResult.create().msg((Integer) map.get("code"), (String) map.get("msg")).success((Boolean) map.get("success"));
    }

}

在Spring Boot中,可以使用`@ExceptionHandler`注解来捕获`@Valid`注解抛出的异常,并返回自定义的错误提示信息。 首先,需要在控制器类中定义一个异常处理方法,并在该方法上添加`@ExceptionHandler`注解。在该注解中,需要指定需要捕获异常类型。例如: ```java @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(MethodArgumentNotValidException.class) @ResponseStatus(HttpStatus.BAD_REQUEST) public ErrorResponse handleValidationException(MethodArgumentNotValidException ex) { BindingResult bindingResult = ex.getBindingResult(); List<FieldError> fieldErrors = bindingResult.getFieldErrors(); String errorMsg = fieldErrors.stream().map(FieldError::getDefaultMessage).collect(Collectors.joining(";")); return new ErrorResponse(HttpStatus.BAD_REQUEST.value(), errorMsg); } } ``` 在上面的代码中,`@RestControllerAdvice`注解用于定义全局异常处理类。`@ExceptionHandler(MethodArgumentNotValidException.class)`注解用于指定需要捕获异常类型,即`@Valid`注解抛出的异常。当该异常捕获时,会执行`handleValidationException()`方法,并返回自定义的错误提示信息。 在`handleValidationException()`方法中,可以通过`MethodArgumentNotValidException`对象获取校验失败的详细信息,并将其封装成自定义的错误响应体`ErrorResponse`返回给前端。`@ResponseStatus(HttpStatus.BAD_REQUEST)`注解用于指定响应状态码为400,表示请求参数有误。 最后,需要在`ErrorResponse`类中定义错误响应体的格式,例如: ```java public class ErrorResponse { private int code; private String message; public ErrorResponse(int code, String message) { this.code = code; this.message = message; } // 省略getter和setter方法 } ``` 以上就是在Spring Boot中拦截`@Valid`注解抛出的异常并提示的方法。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值