spring-boot-route（四）全局异常处理

以你之姓@ 2021-09-18 05:58 253阅读 0赞

在开发中，我们经常会使用`try/catch块`来捕获异常进行处理，如果有些代码中忘记捕获异常或者不可见的一些异常出现，就会响应给前端一些不友好的提示，这时候我们可以使用全局异常处理。这样就不用在代码中写那些烦人的`try/catch块了`，代码的可读性也会提高。

SpringBoot提供的的注解`@ControllerAdvice`表示开启全局异常捕获，在自定义的异常方法上使用`ExceptionHandler`来进行统一处理。

下面一起看看如何优雅的处理全局异常！

### 一 定义响应状态码及信息的枚举类 ###

@Getter
    public enum CodeEnum { 
        
        SUCCESS(0,"请求成功"),
        ERROR(500,"未知异常"),
        ERROR_EMPTY_RESULT(1001,"查询结果为空"),
        ERROR_INCOMPLETE_RESULT(1002,"请求参数不全");
        
        private int code;
        private String message;
        CodeEnum(int code,String message){ 
            this.code = code;
            this.message = message;
        }
    }

### 二 定义响应数据的实体类 ###

@Slf4j
    @Data
    public class R<T> implements Serializable { 
    
        private static final long serialVersionUID = 572235155491705152L;
        /** * 响应的状态码 */
        private int code;
        /*** * 响应的信息 */
        private String message;
        /** * 响应数据 */
        private T data;
    
        /** * 放入响应码并返回 * @param code * @param msg * @return */
        public R fillCode(int code,String msg){ 
            this.code = code;
            this.message = msg;
            return this;
        }
    
        /** * 放入响应码并返回 * @param codeEnum * @return */
        public R fillCode(CodeEnum codeEnum){ 
            this.code = codeEnum.getCode();
            this.message = codeEnum.getMessage();
            return this;
        }
    
        /** * 放入数据并响应成功状态 * @param data * @return */
        public R fillData(T data){ 
            this.code = CodeEnum.SUCCESS.getCode();
            this.message = CodeEnum.SUCCESS.getMessage();
            this.data = data;
            return this;
        }
    }

### 三 自定义两个异常 ###

根据业务需求自定义异常，在本文中我定义了两个异常，分别用作响应结果为空时处理和请求参数错误时处理。

@Data
    public class EmptyResutlException extends RuntimeException { 
    
        private static final long serialVersionUID = -8839210969758687047L;
        private int code;
        private String message;
    
        public EmptyResutlException(CodeEnum codeEnum){ 
            this.code = codeEnum.getCode();
            this.message = codeEnum.getMessage();
        }
    }

@Data
    public class RequestParamException extends RuntimeException { 
    
        private static final long serialVersionUID = 4748844811214637041L;
        private int code;
        private String message;
    
        public RequestParamException(CodeEnum codeEnum){ 
            this.code = codeEnum.getCode();
            this.message = codeEnum.getMessage();
        }
    }

### 四 定义全局异常处理类 ###

由于这里我想要响应的结果为实体类对象，因此我直接用`@RestControllerAdvice`来代替了`@ControllerAdvice`，这两个注解的差别跟`@Controller`和`@RestController`一样，rest的响应体为json格式的数据。

@RestControllerAdvice
    @Slf4j
    public class GlobalExceptionHandler { 
    
        /** * 查询结果为空时处理 * @param e * @return */
        @ExceptionHandler(EmptyResutlException.class)
        public R emptyResultExceptionHandler(EmptyResutlException e){ 
            log.error("查询结果为空：{}",e.getMessage());
            R result = new R();
            result.fillCode(e.getCode(),e.getMessage());
            return result;
        }
    
        /** * 请求参数错误时处理 * @param e * @return */
        @ExceptionHandler(RequestParamException.class)
        public R requestParamExceptionHandler(RequestParamException e){ 
            log.error("请求参数不合法：{}",e.getMessage());
            R result = new R();
            result.fillCode(e.getCode(),e.getMessage());
            return result;
        }
    
        /** * 处理其他异常 * @param e * @return */
        @ExceptionHandler(Exception.class)
        public R exceptionHandler(Exception e){ 
            log.error("未知异常：{}",e.getMessage());
            R result = new R();
            result.fillCode(CodeEnum.ERROR);
            return result;
        }
    }

### 五 自定义接口测试异常 ###

@RestController
    public class TestController { 
    
        @GetMapping("getString")
        public R getString(String name){ 
    
            if(StringUtils.isEmpty(name)){ 
                throw new RequestParamException(1002,"请求参数name为空");
            }else if ("Java旅途".equals(name)) { 
                // 这里没有查询操作，当请求参数是Java旅途的时候，模拟成查询结果为空
                throw new EmptyResutlException(1001,"查询结果为空");
            }
            // 这里模拟一下除自定义异常外的其他两种异常
            int i = 0;
            i = 5/i;
            return new R().fillData(name);
        }
    }

在实际开发中可以自定义响应状态码的枚举类和自定义异常以满足需求。

--------------------

#### 本文示例代码已上传至[github][]，点个`star`支持一下！ ####

## Spring Boot系列教程目录 ##

[spring-boot-route（一）Controller接收参数的几种方式][spring-boot-route_Controller]

[spring-boot-route（二）读取配置文件的几种方式][spring-boot-route]

[spring-boot-route（三）实现多文件上传][spring-boot-route 1]

[spring-boot-route（四）全局异常处理][spring-boot-route 2]

[spring-boot-route（五）整合swagger生成接口文档][spring-boot-route_swagger]

[spring-boot-route（六）整合JApiDocs生成接口文档][spring-boot-route_JApiDocs]

[spring-boot-route（七）整合jdbcTemplate操作数据库][spring-boot-route_jdbcTemplate]

[spring-boot-route（八）整合mybatis操作数据库][spring-boot-route_mybatis]

[spring-boot-route（九）整合JPA操作数据库][spring-boot-route_JPA]

[spring-boot-route（十）多数据源切换][spring-boot-route 3]

[spring-boot-route（十一）数据库配置信息加密][spring-boot-route 4]

[spring-boot-route（十二）整合redis做为缓存][spring-boot-route_redis]

[spring-boot-route（十三）整合RabbitMQ][spring-boot-route_RabbitMQ]

[spring-boot-route（十四）整合Kafka][spring-boot-route_Kafka]

[spring-boot-route（十五）整合RocketMQ][spring-boot-route_RocketMQ]

[spring-boot-route（十六）使用logback生产日志文件][spring-boot-route_logback]

[spring-boot-route（十七）使用aop记录操作日志][spring-boot-route_aop]

[spring-boot-route（十八）spring-boot-adtuator监控应用][spring-boot-route_spring-boot-adtuator]

[spring-boot-route（十九）spring-boot-admin监控服务][spring-boot-route_spring-boot-admin]

[spring-boot-route（二十）Spring Task实现简单定时任务][spring-boot-route_Spring Task]

[spring-boot-route（二十一）quartz实现动态定时任务][spring-boot-route_quartz]

[spring-boot-route（二十二）实现邮件发送功能][spring-boot-route 5]

[spring-boot-route（二十三）开发微信公众号][spring-boot-route 6]

[spring-boot-route（二十四）分布式session的一致性处理][spring-boot-route_session]

[spring-boot-route（二十五）两行代码实现国际化][spring-boot-route 7]

[spring-boot-route（二十六）整合webSocket][spring-boot-route_webSocket]

[github]: https://github.com/binzh303/spring-boot-route
[spring-boot-route_Controller]: https://javatip.cn/archives/66
[spring-boot-route]: https://javatip.cn/archives/72
[spring-boot-route 1]: https://javatip.cn/archives/74
[spring-boot-route 2]: https://javatip.cn/archives/79
[spring-boot-route_swagger]: https://javatip.cn/archives/90
[spring-boot-route_JApiDocs]: https://javatip.cn/archives/91
[spring-boot-route_jdbcTemplate]: https://javatip.cn/archives/92
[spring-boot-route_mybatis]: https://javatip.cn/archives/93
[spring-boot-route_JPA]: https://javatip.cn/archives/94
[spring-boot-route 3]: https://javatip.cn/archives/95
[spring-boot-route 4]: https://javatip.cn/archives/113
[spring-boot-route_redis]: https://javatip.cn/archives/114
[spring-boot-route_RabbitMQ]: https://javatip.cn/archives/115
[spring-boot-route_Kafka]: https://javatip.cn/archives/116
[spring-boot-route_RocketMQ]: https://javatip.cn/archives/117
[spring-boot-route_logback]: https://javatip.cn/archives/118
[spring-boot-route_aop]: https://javatip.cn/archives/119
[spring-boot-route_spring-boot-adtuator]: https://javatip.cn/archives/120
[spring-boot-route_spring-boot-admin]: https://javatip.cn/archives/121
[spring-boot-route_Spring Task]: https://javatip.cn/archives/122
[spring-boot-route_quartz]: https://javatip.cn/archives/123
[spring-boot-route 5]: https://javatip.cn/archives/124
[spring-boot-route 6]: https://javatip.cn/archives/125
[spring-boot-route_session]: https://javatip.cn/archives/284
[spring-boot-route 7]: https://javatip.cn/archives/256
[spring-boot-route_webSocket]: https://javatip.cn/archives/255