微服务架构定义全局异常处理(@ControllerAdvice + @ExceptionHandler)没有生效

12 篇文章 0 订阅
5 篇文章 0 订阅

最近在学习基于SpringCloud和SpringBoot的微服务架构,想实现全局异常处理这样一个功能,实现后的效果就是所有服务抛出的异常都在这个全局异常处理里面统一处理,而不是在每个服务里面都写一套异常的处理,先大概说一下我的项目结构,

既然要做一个全局异常处理,那么肯定要写在一个公用的地方,这里我有一个基础服务,它不是一个独立的服务,没有启动类,也不需要注册到Eureka,它的作用是提供一些公用的组件、工具类和依赖等等,如BaseModel类,Lombok包等,基础服务继承自SpringBoot

然后其他的服务继承自基础平台,我的思路就是在这个基础平台里实现全局的异常处理,主要是使用@ControllerAdvice + @ExceptionHandler来实现,这两个注解的概念我就不给大家一一解读了,网上有很多解释的很清楚的文章,下面就写一下全局异常处理的代码层面的实现

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
import priv.cwr.platform.commom.exception.ApiException;

import javax.servlet.http.HttpServletRequest;

/**
 * @author chenwenrui
 * @date 08/01/2019
 * @description class controller的全局错误处理handler
 */

@ControllerAdvice
public class GlobalExceptionHandler extends ResponseEntityExceptionHandler {

    /**
     * 全局异常处理
     *
     * @param request http 请求
     * @param e       exception
     * @return error
     */
    @ResponseBody
    @ExceptionHandler(Exception.class)
    ResponseEntity<?> handleControllerException(HttpServletRequest request, Throwable e) {
        if (e instanceof ApiException) {
            //自定义异常
        } else if (e instanceof NullPointerException) {
            //空指针异常
        } else {
            //其他异常
        }
        return null;
    }
}

@ExceptionHandler中设置的就是你需要拦截的异常的类型,这里就是拦截了所有Exception,然后在方法体中去判断具体的异常类型,当然你也可以不用这种形式,使用多个@ExceptionHandler去拦截对应的异常也是可以的,这样一个简单的全局异常处理就完成了。

但是看看标题,发现这个事情并没有这么简单,正当我很开心的测试效果的时候发现,这个定义的全局异常处理并没有生效,而且也没有报错,当前的效果如下:

然后我花了两个小时的时间去寻找解决问题的方法,但是未果,正当我准备放弃的时候,我似乎找到了一些答案,我看到网上有的人说@ControllerAdvice注解的类,必须要让spring扫描到才能生效,这句话提醒了我,于是我开始思考没有生效是不是因为没有被spring扫描到?启动类的扫描范围是启动类同级以及子级的包,于是我把用户服务的启动类的配置做了如下更改:

// @SpringBootApplication
@SpringBootApplication(scanBasePackages = "priv.cwr")

当前结果如下:

这个和之前的结果是完全不同的,其中code是我自己定义的错误码,ApiException是我自定义的异常,所以这里全局异常处理是生效了。

我的猜测是这样的,启动类会去扫描同级以及子级的包,但是应该只会扫描当前项目的包,但是我的全局异常的处理是放在基础服务中的,虽然是继承关系,但是实际上毕竟是两个项目,所以无法扫描到,但是加了包扫描的范围之后,就能扫描到基础服务中的包(因为所有的服务的包名都是以priv.cwr开头的)

为了验证的我猜测,我把基础服务的包改为了priv.cwr.....,这样的话启动类是扫描不到配置的全局异常处理的,如果更改之后全局异常处理没有生效,那基本上可以验证我的猜想,结果也是和我预测的一样,和第一张图是一样的效果。

总结

其实严格来说这个问题和微服务没有多少联系,只是单纯的两个项目之间的协作问题,只不是在搭建微服务架构的过程中出现的问题,所以我才用这样的标题,如果有错误或者补充,请留言评论。

  • 15
    点赞
  • 8
    收藏
    觉得还不错? 一键收藏
  • 7
    评论
好的,您想了解关于使用 @ExceptionHandler + @ControllerAdvice +枚举实现全局异常统一处理的内容,这是一个常用的方案,可以实现全局异常的捕获和处理,让程序更加健壮和稳定。 @ExceptionHandler注解用于标记一个方法,该方法用于处理指定的异常类型。@ControllerAdvice注解用于标记一个类,该类用于处理全局异常。枚举则可以用于定义异常类型,方便异常处理时的统一管理。 在实现全局异常处理时,我们可以通过 @ExceptionHandler 注解来捕获指定的异常类型,并在方法中进行相应的处理。@ControllerAdvice注解可以让我们在一个类中定义多个 @ExceptionHandler方法,用于处理不同类型的异常。同时,我们也可以使用枚举来定义不同的异常类型,方便管理和调用。 下面是一个简单的示例,演示如何使用 @ExceptionHandler + @ControllerAdvice +枚举实现全局异常统一处理: ```java @ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(value = BusinessException.class) @ResponseBody public ResultVO handleBusinessException(BusinessException e) { return ResultVO.error(e.getCode(), e.getMessage()); } } public enum ExceptionEnum { PARAMETER_ERROR(1001, "参数错误"), DATA_NOT_FOUND(1002, "数据不存在"), SYSTEM_ERROR(5000, "系统错误"); private final int code; private final String message; ExceptionEnum(int code, String message) { this.code = code; this.message = message; } public int getCode() { return code; } public String getMessage() { return message; } } public class BusinessException extends RuntimeException { private final int code; public BusinessException(int code, String message) { super(message); this.code = code; } public BusinessException(ExceptionEnum exceptionEnum) { super(exceptionEnum.getMessage()); this.code = exceptionEnum.getCode(); } public int getCode() { return code; } } ``` 在上面的示例中,GlobalExceptionHandler类标记了@ControllerAdvice注解,用于全局异常处理。其中,handleBusinessException方法用于处理BusinessException异常,返回一个ResultVO对象,其中包含错误码和错误信息。 BusinessException则是一个自定义的异常类,它包含一个code属性和一个message属性,用于表示异常的错误码和错误信息。同时,它还提供了一个构造方法,可以根据ExceptionEnum来构造一个BusinessException对象。 ExceptionEnum则是一个枚举类,包含了不同的异常类型,每个异常类型都有一个对应的错误码和错误信息。 在实际开发中,我们可以根据实际需求来定义不同的异常类型和错误码,以便更好地管理和调用。
评论 7
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值