@ControllerAdvice + @ExceptionHandler 全局处理 Controller 层异常理解

本文探讨了在SSM项目中如何通过@ControllerAdvice和@ExceptionHandler注解实现全局异常处理,避免在Controller层进行try-catch操作,提升代码可读性和维护性。

前言:
对于ssm项目通常会把事务配置在service层,这样service层就必须将运行时异常抛到controller进行try-catch进行处理,将异常信息返回前台及记录日志(如下代码),带来的直接后果就是代码可读性差,而且必须根据service层返回的不同异常进行不同处理。

  @RequestMapping(value = "updateConsultant", method = RequestMethod.POST)
    public Object updateConsultant(HttpServletRequest request) {
        try {
            Map<String, String> data = RequestUtil.getQueryParams(request);
            studyService.update("updateConsultant", data);
            return ResponseData.success();
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
            return JSON.toJSONString(ResponseData.failure(e.getMessage()));
        }
    }

使用 @ControllerAdvice + @ExceptionHandler 进行全局的 Controller 层异常处理,只要设计得当,就再也不用在 Controller 层进行 try-catch 了。

基本使用用例:
使用时必须确保 BaseExceptionHandler 类被加载进了spring容器<context:component-scan base-package=“com.zkcb.**.controller” />,类要写到对应的controller里面,可以声明各种不同的异常。

@ControllerAdvice
public class BaseExceptionHandler {

    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResultData error(Exception e){
        e.printStackTrace();
        System.out.println("调用了异常处理");
       // logger.error(e.getMessage(), e);
       return  new ResultData(1,e.getMessage());
    }
}
@ExceptionHandler注解是用来定义具体的异常处理方法的,用法是在Controller中的任意一个方法上使用该注解,当该方法中抛出对应的异常时,就会执行对应的处理方法。 @ControllerAdvice注解是一个全局异常处理器,可以用来统一处理所有Controller中抛出的异常,它可以定义一个或多个@ExceptionHandler方法,用来捕获不同的异常并进行统一处理。 而枚举实现全局异常统一处理可以通过定义一个枚举类来实现,每个枚举值代表一种错误类型,包括错误码和错误信息。在@ControllerAdvice中,可以定义一个@ExceptionHandler方法,在该方法中根据不同的异常类型和错误码返回对应的错误信息。这样,当有异常抛出时,就会根据所对应的错误类型和错误码返回对应的错误信息。 例如: ``` @RequiredArgsConstructor @ControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(value = BusinessException.class) @ResponseBody public ApiResponse handleBusinessException(BusinessException e) { return ApiResponse.fail(e.getErrorCode(), e.getMessage()); } } @AllArgsConstructor @Getter public enum ErrorCode { SUCCESS("00000", "操作成功"), UNKNOWN_ERROR("-1", "系统繁忙,请稍后再试"),; private String code; private String message; } ``` 在上面的代码中,我们定义了一个枚举类ErrorCode,它包含了成功和未知错误两种类型的错误码和错误信息。我们在GlobalExceptionHandler类中定义了一个handleBusinessException方法,用来处理BusinessException异常,该方法返回一个ApiResponse对象,其中使用了e.getErrorCode()和e.getMessage()方法获取异常的错误码和错误信息,并返回给前端。 如此一来,我们就可以实现全局异常统一处理,并且在ApiException和BusinessException中添加对应的错误码和错误信息,方便日后维护和管理。
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值