【java】项目统一的全局异常处理

阳光穿透心脏的1/2处 2022-12-07 01:15 139阅读 0赞

## 使用 @ControllerAdvice 或者 @RestControllerAdvice 注解作为统一异常处理的核心。 ##

这两个注解都是 Spring MVC 提供的。作用于 控制层 的一种切面通知。  
功能：  
　　全局异常处理。  
　　全局数据绑定。  
　　全局数据预处理。

【@ControllerAdvice 与 @RestControllerAdvice 区别：】
        @RestControllerAdvice 注解包含了 @ControllerAdvice 与 @ResponseBody 注解。
        类似于 @Controller 与 @RestController 的区别。
        @RestControllerAdvice 返回 json 数据时不需要添加 @ResponseBody 注解。

## 使用 @ControllerAdvice 或者 @RestControllerAdvice 注解标记一个 全局异常处理类。 ##

全局异常处理类内部使用 @ExceptionHandler 注解去捕获异常。  
　　可以自定义一个异常信息收集类，用于处理项目中的异常，并收集异常信息。

## 代码实现： ##

Step1（可选操作）：  
　　　　自定义一个异常类，用于处理项目中的异常，并收集异常信息。

【代码实现：】
    
    package com.lyh.common.exception;
    
    import lombok.Data;
    import org.apache.http.HttpStatus;
    
    /** * 自定义异常， * 可以自定义 异常信息 message 以及 响应状态码 code（默认为 500）。 * * 依赖信息说明： * 此处使用 @Data 注解，需导入 lombok 相关依赖文件。 * 使用 HttpStatus 的常量表示 响应状态码，需导入 httpcore 相关依赖文件。 */
    @Data
    public class GlobalException extends RuntimeException { 
        /** * 保存异常信息 */
        private String message;
    
        /** * 保存响应状态码 */
        private Integer code = HttpStatus.SC_INTERNAL_SERVER_ERROR;
    
        /** * 默认构造方法，根据异常信息 构建一个异常实例对象 * @param message 异常信息 */
        public GlobalException(String message) { 
            super(message);
            this.message = message;
        }
    
        /** * 根据异常信息、响应状态码构建 一个异常实例对象 * @param message 异常信息 * @param code 响应状态码 */
        public GlobalException(String message, Integer code) { 
            super(message);
            this.message = message;
            this.code = code;
        }
    
        /** * 根据异常信息，异常对象构建 一个异常实例对象 * @param message 异常信息 * @param e 异常对象 */
        public GlobalException(String message, Throwable e) { 
            super(message, e);
            this.message = message;
        }
    
        /** * 根据异常信息，响应状态码，异常对象构建 一个异常实例对象 * @param message 异常信息 * @param code 响应状态码 * @param e 异常对象 */
        public GlobalException(String message, Integer code, Throwable e) { 
            super(message, e);
            this.message = message;
            this.code = code;
        }
    }

Step2：  
　　定义一个全局的异常处理类 GlobalExceptionHandler。  
　　使用 @RestControllerAdvice 注解标记这个类。  
　　内部使用 @ExceptionHandler 注解去捕获异常。

【代码实现：】
    
    package com.lyh.common.exception;
    
    import com.lyh.common.util.Result;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestControllerAdvice;
    
    /** * 全局异常处理类。 * 使用 slf4j 保存日志信息。 * 此处使用了 统一结果处理 类 Result 用于包装异常信息。 */
    @RestControllerAdvice
    public class GlobalExceptionHandler { 
        private Logger logger = LoggerFactory.getLogger(getClass());
    
        /** * 处理 Exception 异常 * @param e 异常 * @return 处理结果 */
        @ExceptionHandler(Exception.class)
        public Result handlerException(Exception e) { 
            logger.error(e.getMessage(), e);
            return Result.error().message("系统异常");
        }
    
        /** * 处理空指针异常 * @param e 异常 * @return 处理结果 */
        @ExceptionHandler(NullPointerException.class)
        public Result handlerNullPointerException(NullPointerException e) { 
            logger.error(e.getMessage(), e);
            return Result.error().message("空指针异常");
        }
    
        /** * 处理自定义异常 * @param e 异常 * @return 处理结果 */
        @ExceptionHandler(GlobalException.class)
        public Result handlerGlobalException(GlobalException e) { 
            logger.error(e.getMessage(), e);
            return Result.error().message(e.getMessage()).code(e.getCode());
        }
    }

## 测试 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMjcxNDYx_size_16_color_FFFFFF_t_70_pic_center]  
启动服务并访问：  
　　参数不存在时：

{
        "success": false,
        "code": 500,
        "message": "空指针异常",
        "data": {}
    }

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzMzMjcxNDYx_size_16_color_FFFFFF_t_70_pic_center]: /images/20221123/3e7534acb55c44c0a9ba8849d56bd442.png