一起来学SpringBoot | 第十八篇：轻松搞定全局异常

淩亂°似流年 2022-05-19 10:05 168阅读 0赞

>  *  **本文作者：**唐亚峰
>  *  **本文链接：**[http://blog.battcn.com/2018/06/01/springboot/v2-other-exception/][http_blog.battcn.com_2018_06_01_springboot_v2-other-exception]
>  *  **版权声明：**本博客所有文章除特别声明外，均采用[CC BY-NC-SA 3.0][]许可协议。转载请注明出处！

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

> `SpringBoot`是为了简化`Spring`应用的创建、运行、调试、部署等一系列问题而诞生的产物，**`自动装配的特性让我们可以更好的关注业务本身而不是外部的XML配置，我们只需遵循规范，引入相关的依赖就可以轻易的搭建出一个 WEB 工程`**

实际项目开发中，程序往往会发生各式各样的异常情况，特别是身为服务端开发人员的我们，总是不停的编写接口提供给前端调用，分工协作的情况下，避免不了异常的发生，如果直接将错误的信息直接暴露给用户，这样的体验可想而知，且对黑客而言，详细异常信息往往会提供非常大的帮助…

## 初窥异常 ##

一个简单的异常请求的接口

@GetMapping("/test1")
    public String test1() {
        // TODO 这里只是模拟异常，假设业务处理的时候出现错误了，或者空指针了等等...
        int i = 10 / 0;
        return "test1";
    }

打开浏览器访问它的时候发现

![浏览器中的异常信息][1.png]

又或者是用`postman`等模拟工具

![postman 的异常信息][postman]

如果这接口是给第三方调用或者是自己公司的系统，看到这种错误估计得暴走吧….

> 笨方法（极其不建议）

采用`try-catch`的方式，手动捕获异常信息，然后返回对应的结果集，相信很多人都看到过类似的代码（如：封装成Result对象）；该方法虽然间接性的解决错误暴露的问题，同样的弊端也很明显，增加了大量的代码量，当异常过多的情况下对应的`catch`层愈发的多了起来，很难管理这些业务异常和错误码之间的匹配，所以最好的方法就是通过简单配置全局掌控….

@GetMapping("/test2")
    public Map<String, String> test2() {
        Map<String, String> result = new HashMap<>(16);
        // TODO 直接捕获所有代码块，然后在 cache
        try {
            int i = 10 / 0;
            result.put("code", "200");
            result.put("data", "具体返回的结果集");
        } catch (Exception e) {
            result.put("code", "500");
            result.put("message", "请求错误");
        }
        return result;
    }

## 具体代码 ##

通过上面的阅读大家也大致能了解到为啥需要对异常进行全局捕获了，接下来就看看`Spring Boot`提供的解决方案

### 导入依赖 ###

在`pom.xml`中添加上`spring-boot-starter-web`的依赖即可

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

### 自定义异常 ###

在应用开发过程中，除系统自身的异常外，不同业务场景中用到的异常也不一样，为了与标题**`轻松搞定全局异常`**更加的贴切，定义个自己的异常，看看如何捕获…

package com.winterchen.exception;
    
    /** * 自定义异常 * Created by Donghua.Chen on 2018/7/24. */
    public class CustomException extends RuntimeException { 
    
        private static final long serialVersionUID = 4564124491192825748L;
    
        private int code;
    
        public CustomException() {
            super();
        }
    
        public CustomException(int code, String message) {
            super(message);
            this.setCode(code);
        }
    
        public int getCode() {
            return code;
        }
    
        public void setCode(int code) {
            this.code = code;
        }
    }

### 异常信息模板 ###

定义返回的异常信息的格式，这样异常信息风格更为统一

package com.winterchen.exception;
    
    /** * 异常信息模板 * Created by Donghua.Chen on 2018/7/24. */
    public class ErrorResponseEntity { 
    
        private int code;
        private String message;
    
        public ErrorResponseEntity(int code, String message) {
            this.code = code;
            this.message = message;
        }
    
        // 省略 get/set
    }

### 控制层 ###

仔细一看是不是和平时正常写的代码没啥区别，不要急，接着看….

package com.winterchen.controller;
    
    import com.winterchen.exception.CustomException;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /** * Created by Donghua.Chen on 2018/7/24. */
    @RestController
    public class ExceptionController { 
    
        @GetMapping("/test3")
        public String test3(Integer num) {
            // TODO 演示需要，实际上参数是否为空通过 @RequestParam(required = true) 就可以控制
            if (num == null) {
                throw new CustomException(400, "num不能为空");
            }
            int i = 10 / num;
            return "result:" + i;
        }
    }

### 异常处理（关键） ###

> 注解概述

*  **`@ControllerAdvice`**捕获`Controller`层抛出的异常，如果添加`@ResponseBody`返回信息则为`JSON`格式。
 *  **`@RestControllerAdvice`**相当于`@ControllerAdvice`与`@ResponseBody`的结合体。
 *  **`@ExceptionHandler`**统一处理一种类的异常，减少代码重复率，降低复杂度。

创建一个`GlobalExceptionHandler`类，并添加上`@RestControllerAdvice`注解就可以定义出异常通知类了，然后在定义的方法中添加上`@ExceptionHandler`即可实现异常的捕捉…

package com.winterchen.config;
    
    import com.winterchen.exception.CustomException;
    import com.winterchen.exception.ErrorResponseEntity;
    import org.springframework.http.HttpHeaders;
    import org.springframework.http.HttpStatus;
    import org.springframework.http.ResponseEntity;
    import org.springframework.web.bind.MethodArgumentNotValidException;
    import org.springframework.web.bind.annotation.ExceptionHandler;
    import org.springframework.web.bind.annotation.RestControllerAdvice;
    import org.springframework.web.context.request.WebRequest;
    import org.springframework.web.method.annotation.MethodArgumentTypeMismatchException;
    import org.springframework.web.servlet.mvc.method.annotation.ResponseEntityExceptionHandler;
    
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletResponse;
    
    /** * 全局异常处理 * Created by Donghua.Chen on 2018/7/24. */
    @RestControllerAdvice
    public class GlobalExceptionHandler extends ResponseEntityExceptionHandler { 
    
        /** * 定义要捕获的异常 可以多个 @ExceptionHandler({}) * * @param request request * @param e exception * @param response response * @return 响应结果 */
        @ExceptionHandler(CustomException.class)
        public ErrorResponseEntity customExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            CustomException exception = (CustomException) e;
            return new ErrorResponseEntity(exception.getCode(), exception.getMessage());
        }
    
        /** * 捕获 RuntimeException 异常 * TODO 如果你觉得在一个 exceptionHandler 通过 if (e instanceof xxxException) 太麻烦 * TODO 那么你还可以自己写多个不同的 exceptionHandler 处理不同异常 * * @param request request * @param e exception * @param response response * @return 响应结果 */
        @ExceptionHandler(RuntimeException.class)
        public ErrorResponseEntity runtimeExceptionHandler(HttpServletRequest request, final Exception e, HttpServletResponse response) {
            response.setStatus(HttpStatus.BAD_REQUEST.value());
            RuntimeException exception = (RuntimeException) e;
            return new ErrorResponseEntity(400, exception.getMessage());
        }
    
        /** * 通用的接口映射异常处理方 */
        @Override
        protected ResponseEntity<Object> handleExceptionInternal(Exception ex, Object body, HttpHeaders headers,
                                                                 HttpStatus status, WebRequest request) {
            if (ex instanceof MethodArgumentNotValidException) {
                MethodArgumentNotValidException exception = (MethodArgumentNotValidException) ex;
                return new ResponseEntity<>(new ErrorResponseEntity(status.value(), exception.getBindingResult().getAllErrors().get(0).getDefaultMessage()), status);
            }
            if (ex instanceof MethodArgumentTypeMismatchException) {
                MethodArgumentTypeMismatchException exception = (MethodArgumentTypeMismatchException) ex;
                logger.error("参数转换失败，方法：" + exception.getParameter().getMethod().getName() + "，参数：" + exception.getName()
                        + ",信息：" + exception.getLocalizedMessage());
                return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "参数转换失败"), status);
            }
            return new ResponseEntity<>(new ErrorResponseEntity(status.value(), "参数转换失败"), status);
        }
    }

### 主函数 ###

package com.winterchen;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    
    @SpringBootApplication
    public class SpringBootExceptionApplication { 
    
        public static void main(String[] args) {
            SpringApplication.run(SpringBootExceptionApplication.class, args);
        }
    }

### 测试 ###

完成准备事项后，启动`Chapter17Application`，通过下面的测试结果可以发现，真的是`so easy`，代码变得整洁了，扩展性也变好了…

> 访问[http://localhost:8080/test3][http_localhost_8080_test3]

{"code":400,"message":"num不能为空"}

> 访问[http://localhost:8080/test3?num=0][http_localhost_8080_test3_num_0]

{"code":400,"message":"/ by zero"}

> 访问[http://localhost:8080/test3?num=5][http_localhost_8080_test3_num_5]

result:2

## 总结 ##

目前很多大佬都写过关于**`SpringBoot`**的教程了，如有雷同，请多多包涵，本教程基于最新的`spring-boot-starter-parent：2.0.2.RELEASE`编写，包括新版本的特性都会一起介绍…

## 说点什么 ##

springboot技术交流群：681513531

个人博客：[https://blog.winterchen.com][https_blog.winterchen.com]

全文代码：[https://github.com/WinterChenS/springboot-learning-experience][https_github.com_WinterChenS_springboot-learning-experience]

[http_blog.battcn.com_2018_06_01_springboot_v2-other-exception]: http://blog.battcn.com/2018/06/01/springboot/v2-other-exception/
[CC BY-NC-SA 3.0]: https://creativecommons.org/licenses/by-nc-sa/3.0/
[1.png]: /images/20220519/83ec5bccabee4300a2012ba1821e9d6d.png
[postman]: /images/20220519/863b941e02254e439256dc173535c59c.png
[http_localhost_8080_test3]: http://localhost:8080/test3
[http_localhost_8080_test3_num_0]: http://localhost:8080/test3?num=0
[http_localhost_8080_test3_num_5]: http://localhost:8080/test3?num=5
[https_blog.winterchen.com]: https://blog.winterchen.com
[https_github.com_WinterChenS_springboot-learning-experience]: https://github.com/WinterChenS/springboot-learning-experience