SpringMVC设置全局异常处理器的步骤

 更新时间:2024年03月29日 14:27:05   作者:水岸齐天  
在项目中我们有需求做一个全局异常处理,来规范所有出去的异常信息,这篇文章主要介绍了SpringMVC设置全局异常处理器,需要的朋友可以参考下

背景

在项目中我们有需求做一个全局异常处理,来规范所有出去的异常信息。

参考:官方文档

分析

首先 ControllerAdvice(RestControllerAdvice ) ,ControllerAdvice 是无法处理过滤器和拦截器中的异常的。

引用一张图

下面介绍controller层的全局异常设置

全局异常处理也有多种方式

使用@ControllerAdvice(@RestControllerAdvice)+@ExceptionHandler实现全局异常

import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
    /**
     * 处理参数错误的异常
     * @param e
     * @return
     */
    @ResponseBody
    @ExceptionHandler(value = IllegalParamsException.class)
    public ResultVO<Object> handleIllegalParamsException(IllegalParamsException e) {
        ResultVO<Object> resultVo = new ResultVO<>();
        resultVo.setStatus(HttpStatus.BAD_REQUEST.value());
        resultVo.setErrorCode(e.getErrorInfo().getErrorCode());
        resultVo.setErrorMsg(e.getErrorInfo().getErrorDesc());
        return resultVo;
    }
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public ResultVO<Object> handleException(Exception e) {
        ResultVO<Object> resultVo = new ResultVO<>();
        resultVo.setStatus(HttpStatus.INTERNAL_SERVER_ERROR.value());
        resultVo.setErrorMsg(e.getMessage());
        return resultVo;
    }
}
@Data
@AllArgsConstructor
@NoArgsConstructor
public class ResultVO<T> {
    private Integer status;
    private String errorCode;
    private String errorMsg;
    private T data;
    public ResultVO(Integer status, String errorCode, String errorMsg) {
        this.status = status;
        this.errorCode = errorCode;
        this.errorMsg = errorMsg;
    }
}
public class IllegalParamsException extends RuntimeException {
    private static final long serialVersionUID = -6298406656682893468L;
    private OperationErrorEnum errorInfo;
    public IllegalParamsException(OperationErrorEnum errorInfo) {
        this.errorInfo = errorInfo;
    }
    public IllegalParamsException(String message, OperationErrorEnum errorInfo) {
        super(message);
        this.errorInfo = errorInfo;
    }
    public IllegalParamsException(String message, Throwable cause, OperationErrorEnum errorInfo) {
        super(message, cause);
        this.errorInfo = errorInfo;
    }
    public IllegalParamsException(Throwable cause, OperationErrorEnum errorInfo) {
        super(cause);
        this.errorInfo = errorInfo;
    }
    public IllegalParamsException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace, OperationErrorEnum errorInfo) {
        super(message, cause, enableSuppression, writableStackTrace);
        this.errorInfo = errorInfo;
    }
    public OperationErrorEnum getErrorInfo() {
        return errorInfo;
    }
}

全局异常处理-多个处理器匹配顺序

参考:参考

多个处理器的两种情况:

存在一个类中

子类异常处理器优先

存在不同的类中

与多个异常处理类放入LinkedHashMap的顺序有关,
可以利用Order指定顺序,如果没有,则默认最小顺序;

那么,如果都没有指定顺序的话,那就是list中的顺序

对于过滤器和拦截器中的异常,有两种思路可以考虑

1、catch后通过转发到异常页面(设置ModelAndView)
参考:参考

2、拦截器中发生异常,拦截器中直接返回错误(通过response.getOutputStream().write() 直接写错误信息)
如:

         @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
     try {
     // 业务代码
 } catch (Exception e) {
            response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
            ResultVO<Object> resultVo = new ResultVO<>();
            resultVo.setStatus(HttpStatus.UNAUTHORIZED.value());
            resultVo.setErrorMsg(ACCESS_PARAM_ERROR.getErrorDesc());
            response.getOutputStream().write(new String(JSON.toJSONString(resultVo)).getBytes(StandardCharsets.UTF_8));
            logger.error("==== WhiteListAndAuthenticationInterceptor拦截器拦截到了方法:{} 解析鉴权参数异常  ====", methodName);
            return false;
        }
    }

到此这篇关于SpringMVC设置全局异常处理器的步骤的文章就介绍到这了,更多相关SpringMVC全局异常处理器内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • java中HttpClient使用方法举例详解

    java中HttpClient使用方法举例详解

    这篇文章主要介绍了java中HttpClient使用方法的相关资料,HttpClient提供了发送HTTP请求和接收HTTP响应的功能,简化了HTTP通信的处理,减少了对外部库的依赖,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2024-12-12
  • Java计时器StopWatch实现方法代码实例

    Java计时器StopWatch实现方法代码实例

    这篇文章主要介绍了Java计时器StopWatch实现方法代码实例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-07-07
  • MyEclipse+Tomcat配置详解(图文)

    MyEclipse+Tomcat配置详解(图文)

    这篇文章主要介绍了MyEclipse+Tomcat配置详解(图文),小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • Spring Security OAuth过期的解决方法

    Spring Security OAuth过期的解决方法

    这篇文章主要介绍了Spring Security OAuth过期的解决方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • Java基础之选择结构与循环结构

    Java基础之选择结构与循环结构

    这篇文章主要介绍了Java基础之选择结构与循环结构,文中有非常详细的代码示例,对正在学习java基础的小伙伴们有非常好的帮助,需要的朋友可以参考下
    2021-04-04
  • Spring @Cacheable读取配置常量方式

    Spring @Cacheable读取配置常量方式

    这篇文章主要介绍了Spring @Cacheable读取配置常量方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-12-12
  • Java8接口中引入default关键字的本质原因详析

    Java8接口中引入default关键字的本质原因详析

    Default方法是在java8中引入的关键字,也可称为Virtual extension methods—虚拟扩展方法,这篇文章主要给大家介绍了关于Java8接口中引入default关键字的本质原因,需要的朋友可以参考下
    2022-01-01
  • JDBC 程序的常见错误及调试方法

    JDBC 程序的常见错误及调试方法

    本文是《Java Web开发教程——入门与提高篇(JSP+Servlet)》一书《第9章 JDBC技术》的补充内容。
    2009-06-06
  • java程序代码与文本对比实用工具简介

    java程序代码与文本对比实用工具简介

    可以对两段文本进行对比,检测/比较两个文本有什么不同的差异,以便修改,常用于程序代码,就是不需要人工查看,尤其是大文件,有几百上千行的代码,这时候就建议使用比较工具了,不用浪费过多时间去寻找
    2021-09-09
  • Java解压缩zip - 解压缩多个文件或文件夹实例

    Java解压缩zip - 解压缩多个文件或文件夹实例

    本篇文章主要介绍了Java解压缩zip - 解压缩多个文件或文件夹实例,非常具有实用价值,有需要的可以了解一下。
    2016-12-12

最新评论