SpringBoot实战 - 增强器实现全局异常处理器

目录

前言

之前我们分享了对于 Spring 项目的 Controller 层,我们该如何简写我们的代码逻辑,所谓的简写就是 简化日志打印、参数校验、异常捕获和响应结果的封装 这几个步骤,让我们把更多的时间留给我们更关注的业务逻辑,这里给一个之前的文章链接,读了过后可能你会更好的理解该篇文章的意义《API接口返回体》

废话不多说了,我们看一下我们今天的主角儿,@ControllerAdvice 注解,这个是Spring3.2 提供的新注解,从名字上可以看出大体意思是控制器增强。今天我们就是使用它,来全局捕获系统中的异常,并对接口返回的的HTTP状态码做控制,下面来看代码的实现。

定义统一异常处理器

package cn.notemi.demo.handler;

import cn.notemi.demo.exceptions.BusinessException;
import cn.notemi.demo.result.DefaultErrorResult;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseStatus;
import org.springframework.web.bind.annotation.RestController;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;

/**
 * @desc 统一异常处理器
 */
@RestController
@ControllerAdvice
public class GlobalExceptionHandler extends BaseGlobalExceptionHandler {

    /** 处理400类异常 */
    @Override
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(ConstraintViolationException.class)
    public DefaultErrorResult handleConstraintViolationException(ConstraintViolationException e, HttpServletRequest request) {
        return super.handleConstraintViolationException(e, request);
    }

    @Override
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(HttpMessageNotReadableException.class)
    public DefaultErrorResult handleConstraintViolationException(HttpMessageNotReadableException e, HttpServletRequest request) {
        return super.handleConstraintViolationException(e, request);
    }

    @Override
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(BindException.class)
    public DefaultErrorResult handleBindException(BindException e, HttpServletRequest request) {
        return super.handleBindException(e, request);
    }

    @Override
    @ResponseStatus(HttpStatus.BAD_REQUEST)
    @ExceptionHandler(MethodArgumentNotValidException.class)
    public DefaultErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
        return super.handleMethodArgumentNotValidException(e, request);
    }

    /** 处理自定义异常 */
    @Override
    @ExceptionHandler(BusinessException.class)
    public ResponseEntity<DefaultErrorResult> handleBusinessException(BusinessException e, HttpServletRequest request) {
        return super.handleBusinessException(e, request);
    }

    /** 处理运行时异常 */
    @Override
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    @ExceptionHandler(Throwable.class)
    public DefaultErrorResult handleThrowable(Throwable e, HttpServletRequest request) {
        //TODO 可通过邮件、微信公众号等方式发送信息至开发人员、记录存档等操作
        return super.handleThrowable(e, request);
    }

}

说明

这里我们使用 @ControllerAdvice 注解,如果是在写resetful风格的接口时,别忘记它是跟 @RestController 联用的哦

这个类只是我们的定义,真正的实现逻辑是在其继承 BaseGlobalExceptionHandler 类中的,这样做的目的是因为在微服务系统中很多逻辑是可以共用的,所以向上抽离下代码还是很有必要的。

目前处理了简单的参数错误异常(HTTP状态码:400)、运行时异常(HTTP状态码:500)和自定义异常(HTTP状态码:根据情况定)这几大类,其中自定义业务异常会细化我们在系统中常用到的情况,例如:数据找不到时,会抛出 DataNotFoundException 返回HTTP状态码404,没有权限时,会抛出 PermissionForbiddenException 异常返回401状态码,数据已存在也就是数据冲突会抛出 DataConflictException 返回409等等的异常,所有的自定义异常都会继承我们 BusinessException 业务异常,后面我会写一个关于自定义异常的文章,到时我们在更加详细的说明其使用。

统一异常处理基础实现类

package cn.notemi.demo.handler;

import cn.notemi.demo.enums.ResultCode;
import cn.notemi.demo.exceptions.BusinessException;
import cn.notemi.demo.helper.ParameterInvalidItemHelper;
import cn.notemi.demo.model.bo.ParameterInvalidItem;
import cn.notemi.demo.result.DefaultErrorResult;
import lombok.extern.slf4j.Slf4j;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.validation.BindException;
import org.springframework.web.bind.MethodArgumentNotValidException;

import javax.servlet.http.HttpServletRequest;
import javax.validation.ConstraintViolationException;
import java.util.List;

/**
 * @desc 聚合层全局异常处理基础类
 */
@Slf4j
public abstract class BaseGlobalExceptionHandler {

    /**
     * 违反约束异常
     */
    protected DefaultErrorResult handleConstraintViolationException(ConstraintViolationException e, HttpServletRequest request) {
        log.info("handleConstraintViolationException start, uri:{}, caused by: ", request.getRequestURI(), e);
        List<ParameterInvalidItem> parameterInvalidItemList = ParameterInvalidItemHelper.convertCVSetToParameterInvalidItemList(e.getConstraintViolations());
        return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST, parameterInvalidItemList);
    }

    /**
     * 处理验证参数封装错误时异常
     */
    protected DefaultErrorResult handleConstraintViolationException(HttpMessageNotReadableException e, HttpServletRequest request) {
        log.info("handleConstraintViolationException start, uri:{}, caused by: ", request.getRequestURI(), e);
        return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST);
    }

    /**
     * 处理参数绑定时异常(反400错误码)
     */
    protected DefaultErrorResult handleBindException(BindException e, HttpServletRequest request) {
        log.info("handleBindException start, uri:{}, caused by: ", request.getRequestURI(), e);
        List<ParameterInvalidItem> parameterInvalidItemList = ParameterInvalidItemHelper.convertBindingResultToMapParameterInvalidItemList(e.getBindingResult());
        return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST, parameterInvalidItemList);
    }

    /**
     * 处理使用@Validated注解时,参数验证错误异常(反400错误码)
     */
    protected DefaultErrorResult handleMethodArgumentNotValidException(MethodArgumentNotValidException e, HttpServletRequest request) {
        log.info("handleMethodArgumentNotValidException start, uri:{}, caused by: ", request.getRequestURI(), e);
        List<ParameterInvalidItem> parameterInvalidItemList = ParameterInvalidItemHelper.convertBindingResultToMapParameterInvalidItemList(e.getBindingResult());
        return DefaultErrorResult.failure(ResultCode.PARAM_IS_INVALID, e, HttpStatus.BAD_REQUEST, parameterInvalidItemList);
    }

    /**
     * 处理通用自定义业务异常
     */
    protected ResponseEntity<DefaultErrorResult> handleBusinessException(BusinessException e, HttpServletRequest request) {
        log.info("handleBusinessException start, uri:{}, exception:{}, caused by: {}", request.getRequestURI(), e.getClass(), e.getMessage());

        DefaultErrorResult defaultErrorResult = DefaultErrorResult.failure(e);
        return ResponseEntity
                .status(HttpStatus.valueOf(defaultErrorResult.getStatus()))
                .body(defaultErrorResult);
    }

    /**
     * 处理未预测到的其他错误(反500错误码)
     */
    protected DefaultErrorResult handleThrowable(Throwable e, HttpServletRequest request) {
        log.error("handleThrowable start, uri:{}, caused by: ", request.getRequestURI(), e);
        return DefaultErrorResult.failure(ResultCode.SYSTEM_INNER_ERROR, e, HttpStatus.INTERNAL_SERVER_ERROR);
    }

}

说明

上面的代码如果你粘贴至本地是会有错误的,因为我们并没有将代码完全贴出,这里只是给你提供一个异常处理的思路。

在处理 RuntimeException 时,我们可通过邮件、微信公众号、短信等等方式发送信息至开发人员并记录存档等操作,这对线上的排查错误很是有帮助的(当然如果你们有自己的监控系统或使用开源的 cat 系统可以在此处做埋点处理)。

也许你会注意到我们的异常实现类叫聚合层全局异常处理类,这是因为我们使用的是微服务架构,服务会分为 网关层、聚合层、原子层,对于异常可能每个层次的处理逻辑会有一些不同,这里我们给了最常用的处理业务聚合层的异常处理逻辑。

GitHub地址:https://github.com/FlickerMi/notemi-demo

全局异常处理注意事项

  1. 要根据不同的异常返回合适的 HTTP 状态码。

  2. 异常结果返回时,不要将详细的异常堆栈信息由接口返回给前端(这可能会暴漏一些敏感信息,造成安全隐患,再者说前端开发根本不会关心这些)。

  3. 约定 HTTP 状态码为 500 时,都是后端程序上的错误,一定要修复掉。

  4. 对于系统的错误,一定要详细的打印好日志,要将异常的详细堆栈上下文信息都打印出来(有的同学只打印 e.getMessage() 当问题出现时,就变得很尴尬,难以一眼定位问题),方便线上排查问题。

  5. Filter 中的异常,@ControllerAdvice 无法捕获到,原因:

    SpringBoot下全局异常处理的几种方式:

    BasicExceptionController——SpringBoot默认处理异常方式,用于异常跳转到/error,可实现自定义错误页面请求。
    
    @ExceptionHandle注解——只能在控制器中定义异常处理方法。
    
    @ControllerAdvice+@ExceptionHandler——增强控制前Controller实现异常拦截。
    
    SimpleMappingExceptionResolver——拦截异常跳转到error页面。
    
    HandlerExceptionResolver——实现HandlerExceptionResolver拦截异常。

    上面几种方式只能拦截到控制层的异常,而Filter在Controller之前,Controller层的异常捕获,是无法捕获到还没有请求到Controller时发生的异常的。

    那怎么实现对Filter异常的捕获呢?本文不展开讲了,可以看看下面的文章:

标签: spring 企业实战 springboot

声明:本博客如无特殊说明皆为原创,转载请注明来源:SpringBoot实战 - 增强器实现全局异常处理器谢谢!

相关文章

发表评论:

icon_question.pngicon_razz.pngicon_sad.pngicon_evil.pngicon_exclaim.pngicon_smile.pngicon_redface.pngicon_biggrin.pngicon_surprised.pngicon_eek.pngicon_confused.pngicon_cool.pngicon_lol.pngicon_mad.pngicon_twisted.pngicon_rolleyes.pngicon_wink.pngicon_idea.pngicon_arrow.pngicon_neutral.pngicon_cry.pngicon_mrgreen.png