第三章 SpringBoot系列GlobalException全局异常捕获

系列文章目录

第一章 SpringBoot系列之从0搭建项目
第二章 SpringBoot系列返回json数据
第三章 SpringBoot系列GlobalException全局异常捕获
第四章 SpringBoot系列整合Mybatis做增删改查
第五章 SpringBoot系列配置JPA访问数据
第六章 SpringBoot系列使用JdbcTemplate操作数据
第七章 SpringBoot系列静态资源处理，访问磁盘文件

---

---

前言

程序异常相信大家都不陌生，有可预知的也有一些未知异常，通常我们会为异常做转义统一返回处理，从而能够更好的定位程序问题，由于过多的异常处理，我们代码中的try…catch就会很多，这样代码就会看起来很乱、不整洁、冗余，那么就会有人问，如果不这样写那么该怎么处理呢？不要慌，本章内容让你从try…catch中解救出来，咱往下看👇

---

提示：以下是本篇文章正文内容，下面案例可供参考

一、需要用到的注解

@ControllerAdvice Controller增强器，该注解就是给控制器做统一处理、操作，可入参包名/具体类来控制Controller范围。
@ExceptionHandler(value = Exception.class) 该注解作用就是异常处理，使用@ResquetMapping的方法，发生异常都会进入@ExceptionHandler注解的方法，其实我们可以在单个Controller类中写一个方法加上@ExceptionHandler注解处理，但是每个Controller类还是会有冗余，所以搭配@ControllerAdvice注解就达到了全局统一处理的效果。

二、全局异常捕获代码实现

1.创建GlobalExceptionHandler.java

代码如下（示例）：
打印请求路径，异常，为了直观看到效果放入map返回，这样能够在浏览器看到异常信息。
在exceptionHandler方法中我们可以对异常做更多的处理：
1.登录、权限相关异常特殊处理
2.不同业务异常做转义特殊处理
3.统一规范异常响应码、错误信息
3.统一做异常日志打印
…更多

package com.example.demo.interceptor;

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

import javax.servlet.http.HttpServletRequest;
import java.util.HashMap;
import java.util.Map;

@ControllerAdvice
@Slf4j
public class GlobalExceptionHandler {

     @ResponseBody
     @ExceptionHandler
     public Map<String, Object> exceptionHandler(HttpServletRequest req, Exception e) {
        log.info("url : {} , exception : {}", req.getRequestURI(), e.getMessage());
        Map<String, Object> ret = new HashMap<>();
        ret.put("url", req.getRequestURI());
        ret.put("exception", e.getMessage());
        return ret;
    }
}

2.增加抛出异常DemoController.java类globalExceptionTest方法

抛出异常DemoController.java类globalExceptionTest方法代码：
直接抛出一个Exception异常。

package com.example.demo.controller;

import com.example.demo.dto.JsonDataDTO;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/")
public class DemoController {

    @GetMapping("/test")
    public String test() {
        return "Hello World";
    }

    @RequestMapping("/getJsonData")
    public JsonDataDTO getJsonData() {
        JsonDataDTO jsonDataDTO = new JsonDataDTO();
        jsonDataDTO.setName("张三");
        jsonDataDTO.setAge(18);
        jsonDataDTO.setSex("男");
        return jsonDataDTO;
    }

    @RequestMapping("/globalExceptionTest")
    public void globalExceptionTest() throws Exception {
        throw new Exception("发生异常啦！！！");
    }
}

3.案例运行效果

访问浏览器http://localhost:8080/globalExceptionTest

程序运行日志：

2020-10-26 11:43:09.769  INFO 77800 --- [nio-8080-exec-1] c.e.d.i.GlobalExceptionHandler           : url : /globalExceptionTest , exception : 发生异常啦！！！
2020-10-26 11:43:09.865  WARN 77800 --- [nio-8080-exec-1] .m.m.a.ExceptionHandlerExceptionResolver : Resolved [java.lang.Exception: 发生异常啦！！！]

到这里也就结束了，我们可以结合本案例使用自定义业务异常等，然后判断异常类型做统一返回处理，转义等等都是可以的。

---

总结

本章我们学习使用@ControllerAdvice加@ExceptionHandler注解的方式，统一全局捕获异常处理来减少try…catch代码编写以及异常转义等等，以此减少代码量以及提高代码整洁程度，统一规范开发避免重复造轮子，喜欢的朋友点个赞吧，关注我持续更新SpringBoot系列文章。