SpringMvc全局异常统一处理-蒲公英云

SpringMvc全局异常统一处理

港控/mmm° 2022-04-02 11:28 417阅读 0赞

全局异常处理还是基于AOP的思想，在SpringMvc中实现起来很简单，参照如下代码，其中的Resp是自定义的统一响应格式类，可自行设计，RespType是自定义的响应信息常量。

注意：该类所在的包必须被spring扫描到容器中。

/**
 * 统一异常处理
 */
@RestControllerAdvice
public class ControllerExceptionHandler {
    private static final Logger logger = LoggerFactory.getLogger(ControllerExceptionHandler.class);
    /**
     * 400 - Bad Request 参数绑定出错
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(BindException.class)
    public Resp<String> handleBindException(BindException e) {
        logger.error("绑定参数出错", e);
        return new Resp<String>().error(RespType.BIND_PARAM_ERROR);
    }
    /**
     * 400 - Bad Request
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public Resp<String> handleHttpMessageNotReadableException(HttpMessageNotReadableException e) {
        logger.error("请求参数读取错误", e);
        return new Resp<String>().error(RespType.BAD_REQUEST);
    }
    /**
     * 400 - Bad Request
     */
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler({MethodArgumentNotValidException.class})
    public Resp<String> handleValidationException(MethodArgumentNotValidException e) {
        logger.error("请求参数验证失败", e);
        return new Resp<String>().error(RespType.BAD_REQUEST);
    }
    /**
     * 405 - Method Not Allowed。HttpRequestMethodNotSupportedException
     * 是ServletException的子类,需要Servlet API支持
     */
    @ResponseStatus(HttpStatus.METHOD_NOT_ALLOWED)
    @ExceptionHandler(HttpRequestMethodNotSupportedException.class)
    public Resp<String> handleHttpRequestMethodNotSupportedException(HttpRequestMethodNotSupportedException e) {
        logger.error("请求方法不支持", e);
        return new Resp<String>().error(RespType.METHOD_NOT_ALLOWED);
    }
    /**
     * 415 - Unsupported Media Type。HttpMediaTypeNotSupportedException
     * 是ServletException的子类,需要Servlet API支持
     */
    @ResponseStatus(HttpStatus.UNSUPPORTED_MEDIA_TYPE)
    @ExceptionHandler({HttpMediaTypeNotSupportedException.class})
    public Resp<String> handleHttpMediaTypeNotSupportedException(Exception e) {
        logger.error("content-type类型不支持", e);
        return new Resp<String>().error(RespType.UNSUPPORTED_MEDIA_TYPE);
    }
    /**
     * 500 - Internal Server Error
     */
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Exception.class)
    public Resp<String> handleException(Exception e) {
        logger.error("服务器内部错误", e);
        return new Resp<String>().error(RespType.INTERNAL_SERVER_ERROR);
    }
}