spring中的统一异常处理

news/2024/7/4 9:17:14

在具体的SSM项目开发中,由于Controller层为处于请求处理的最顶层,再往上就是框架代码的。
因此,肯定需要在Controller捕获所有异常,并且做适当处理,返回给前端一个友好的错误码。

不过,Controller一多,我们发现每个Controller里都有大量重复的、冗余的异常处理代码,很是啰嗦。
能否将这些重复的部分抽取出来,这样保证Controller层更专注于业务逻辑的处理,
同时能够使得异常的处理有一个统一的控制中心点。

<!-- more -->

全局异常处理

HandlerExceptionResolver接口

public interface HandlerExceptionResolver {

    /**
     * Try to resolve the given exception that got thrown during on handler execution,
     * returning a ModelAndView that represents a specific error page if appropriate.
     * <p>The returned ModelAndView may be {@linkplain ModelAndView#isEmpty() empty}
     * to indicate that the exception has been resolved successfully but that no view
     * should be rendered, for instance by setting a status code.
     * @param request current HTTP request
     * @param response current HTTP response
     * @param handler the executed handler, or {@code null} if none chosen at the
     * time of the exception (for example, if multipart resolution failed)
     * @param ex the exception that got thrown during handler execution
     * @return a corresponding ModelAndView to forward to,
     * or {@code null} for default processing
     */
    ModelAndView resolveException(
            HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex);
}

使用全局异常处理器只需要两步:

  1. 实现HandlerExceptionResolver接口。
  2. 将实现类作为Spring Bean,这样Spring就能扫描到它并作为全局异常处理器加载。

在resolveException中实现异常处理逻辑。
从参数上,可以看到,不仅能够拿到发生异常的函数和异常对象,还能够拿到HttpServletResponse对象,从而控制本次请求返回给前端的行为。

此外,函数还可以返回一个ModelAndView对象,表示渲染一个视图,比方说错误页面。
不过,在前后端分离为主流架构的今天,这个很少用了。如果函数返回的视图为空,则表示不需要视图。

使用示例

来看一个例子:

@Component
@Slf4j
public class CustomHandlerExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        Method method = null;
        if (handler != null && handler instanceof HandlerMethod) {
            method = ((HandlerMethod) handler).getMethod();
        }

        log.error("[{}] system error", method, ex);
        ResponseDTO response = ResponseDTO.builder()
        .errorCode(ErrorCode.SYSTEM_ERROR)
        .build();
        byte[] bytes = JSON.toJSONString(response).getBytes(StandardCharsets.UTF_8));
        try {
            FileCopyUtils.copy(bytes, response.getOutputStream());
        } catch (IOException e) {
            log.error("error", e);
            throw new RuntimeException(e);
        }
        return new ModelAndView();
    }
}

逻辑很显然,在发生异常时,将ResponseDTO序列化为json给前端。

Controller局部异常处理

使用示例

这种异常处理只局部于某个Controller内,如:

@Controller
@Slf4j
@RequestMapping("/api/demo")
public class DemoController {

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseDTO<?> exceptionHandler(Exception e) {
        log.error("[{}] system error", e);
        return ResponseDTO.builder()
        .errorCode(ErrorCode.SYSTEM_ERROR)
        .build();
    }
}
  1. 所有Controller方法(即被RequestMapping注解的方法)抛出的异常,会被该异常处理方法处理。
  2. 使用上,在Controller内部,用@ExceptionHandler注解的方法,就会作为该Controller内部的异常处理方法。
  3. 并且,它的参数中可以注入如WebRequest、NativeWebRequest等,用来拿到请求相关的数据。
  4. 它可以返回String代表一个view名称,也可以返回一个对象并且用@ResponseBody修饰,由框架的其它机制帮你序列化。

此外,它还能够对异常类型进行细粒度的控制,通过注解可以有选择的指定异常处理方法应用的异常类型:

@ExceptionHandler({BusinessException.class, DataBaseError.class })

虽然说全局异常处理HandlerExceptionResolver通过条件判断也能做到,
但是使用这种注解方式明显更具有可读性。

一个问题

刚才说到异常处理函数可以用@ResponseBody修饰,就像一般的Controller方法一样。

然而,非常遗憾的是,如果使用自定义的HandlerMethodReturnValueHandler,却不生效。
比如:

    @ExceptionHandler(Exception.class)
    @JsonResponse
    public ResponseDTO<?> exceptionHandler(Exception e) {
        log.error("[{}] system error", e);
        return ResponseDTO.builder()
        .errorCode(ErrorCode.SYSTEM_ERROR)
        .build();
    }

不知道是我的使用姿势不对,还是什么情况?各种google后无果。

所以,目前的解决方案是,如果能够控制@JsonResponse注解相关的定义代码,将处理返回值这部分逻辑抽取出来,然后在异常处理函数中手动调用。

ControllerAdvice

使用示例

刚才介绍的是Controller局部的异常处理,用于处理该Controller内部的特有的异常处理十分有用。
首先,定义一个存放异常处理函数的类,并使用@ControllerAdvice修饰。

@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})
public class ExceptionAdvice {

    @ExceptionHandler(ErrorCodeWrapperException.class)
    @ResponseBody
    public ResponseDTO<?> exceptionHandler(ErrorCodeWrapperException e) {
        if ((errCodeException.getErrorCode().equals(ErrorCode.SYSTEM_ERROR))) {
            log.error(e);
        }
        return ResponseDTO.ofErroCodeWrapperException(errCodeException);
    }
}

@ExceptionHanlder修饰的方法的写法和Controller内的异常处理函数写法是一样的。

控制生效的Controller范围

注意到,我是这样编写注解的:

@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})

它用来限定这些异常处理函数起作用的Controller的范围。如果不写,则默认对所有Controller有效。

这也是ControllerAdvice进行统一异常处理的优点,它能够细粒度的控制该异常处理器针对哪些Controller有效,这样的好处是:

  1. 一个系统里就能够存在不同的异常处理器,Controller也可以有选择的决定使用哪个,更加灵活。
  2. 不同的业务模块可能对异常处理的方式不同,通过该机制就能做到。
  3. 设想一个一开始并未使用全局异常处理的系统,如果直接引入全局范围内生效的全局异常处理,势必可能会改变已有Controller的行为,有侵入性。

也就是说,如果不控制生效范围,即默认对所有Controller生效。如果控制生效范围,则默认对所有Controller不生效,降低侵入性。

如刚才示例中的例子,只针对实现了GlobalExceptionHandlerMixin接口的类有效:

@Controller
@Slf4j
@RequestMapping("/api/demo")
public class DemoController implements GlobalExceptionHandlerMixin {
}

ControllerAdvice支持的限定范围:

  1. 按注解:@ControllerAdvice(annotations = RestController.class)
  2. 按包名:@ControllerAdvice("org.example.controllers")
  3. 按类型:@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})

总结

以上几种方式是Spring专门为异常处理设计的机制。
就我个人而言,由于ControllerAdvice具有更细粒度的控制能力,所以我更偏爱于在系统中使用ControllerAdvice进行统一异常处理。
除了用异常来传递系统中的意外错误,也会用它来传递处于接口行为一部分的业务错误。
这也是异常的优点之一,如果接口的实现比较复杂,分多层函数实现,如果直接传递错误码,那么到Controller的路径上的每一层函数都需要检查错误码,退回到了C语言那种可怕的“写一行语句检查一下错误码”的模式。

当然,理论上,任何能够给Controller加切面的机制都能变相的进行统一异常处理。比如:

  1. 在拦截器内捕获Controller的异常,做统一异常处理。
  2. 使用Spring的AOP机制,做统一异常处理。

http://www.niftyadmin.cn/n/2747048.html

相关文章

arraylist从大到小排序_十大经典排序算法最强总结(内含代码实现),建议收藏!...

点击上方“Java之间”&#xff0c;选择“置顶或者星标”你关注的就是我关心的&#xff01;来源&#xff1a;cnblogs.com/cndarren/p/11787368.html上一篇&#xff1a;ArrayList集合为什么不能使用foreach增删改01 算法分类 十种常见排序算法可以分为两大类&#xff1a;比较类…

ret和retf

ret指令用栈中的数据&#xff0c;修改IP的内容&#xff0c;从而实现近转移; retf指令用栈中的数据&#xff0c;修改CS和IP的内容&#xff0c;从而实现远转移。 CPU执行ret指令时&#xff0c;进行下面两步操作: (IP) ((ss)*16(sp))(sp)(sp)2CPU执行retf指令时&#xff0c;进行下…

opengl实现经纹理映射的旋转立方体_立方体纹理

立方体纹理就是包含6个2D纹理的纹理.6个纹理有序排列在立方体的6个面.其可以通过方向向量采样立方体纹理上的纹素.创建立方体贴图跟创建2D贴图一样,但是绑定到GL_TEXTURE_CUBE_MAP上.glGenTextures(1, &CubeMapID); glBindTexture(GL_TEXTURE_CUBE_MAP, CubeMapID);立方体纹…

rocketmq广播消息为什么不能重试_RocketMQ系列(五)广播与延迟消息

今天要给大家介绍RocketMQ中的两个功能&#xff0c;一个是“广播”&#xff0c;这个功能是比较基础的&#xff0c;几乎所有的mq产品都是支持这个功能的&#xff1b;另外一个是“延迟消费”&#xff0c;这个应该算是RocketMQ的特色功能之一了吧。接下来&#xff0c;我们就分别看…

数据结构 二叉树 根据后序和中序遍历输出先序遍历

根据后序和中序遍历输出先序遍历 题目描述&#xff1a; 本题要求根据给定的一棵二叉树的后序遍历和中序遍历结果&#xff0c;输出该树的先序遍历结果。 输入格式: 第一行给出正整数N(≤30)&#xff0c;是树中结点的个数。随后两行&#xff0c;每行给出N个整数&#xff0c;分别…

adplayer移植【转】

本文转载自&#xff1a;https://blog.csdn.net/qq361294382/article/details/50525412 这两天做madplayer移植&#xff0c;由于是刚装的ubuntu14.04&#xff0c;所以有好多库没装&#xff0c;还有其它未配置起来的地方&#xff0c;搞起来有几个问题&#xff0c;不过组后按着教程…

梯度下降的超参数大于等于2什么意思_梯度、散度、旋度与矢量分析

矢量分析在场论中非常重要&#xff0c;而三个基本算子&#xff08;梯度、散度与旋度&#xff09;又是构成各种复杂关系式的基础&#xff0c;下面逐一介绍&#xff0c;应特别注意散度与旋度的基本定义。对于矢量恒等式&#xff0c;在此列出是为了使用时查找方便&#xff0c;具体…

维护盘pe linux,不进入pe系统也能轻松维护硬盘,简直神器!

原标题&#xff1a;不进入pe系统也能轻松维护硬盘&#xff0c;简直神器&#xff01;相对其他器件而言&#xff0c;硬盘就属于比较脆弱的一类&#xff0c;如果硬盘没有保护好很容易出现问题&#xff0c;一旦遭遇硬盘损坏&#xff0c;将会带来很大的麻烦&#xff0c;所以我们需要…