SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

程序员文章站 2022-03-08 14:03:21

...

一、SpringBoot默认错误处理

新建SpringBoot项目，pom.xml

  <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

先只创建一个TestController，此处写个除零异常，请求这个路径它会报500错误

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

运行项目，请求路径：渲染了这样一个页面，它说没有匹配到/error

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

这说明它是有自动配置这些问题的，SpringBoot它默认是会去找/error路径对应的页面，如果没找到才会渲染这个页面。那我们就顺藤摸瓜，来下图这个自动配置里找一下。

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

先看BasicErrorController 如果请求头中的Content-Type是text/html

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

那就创建一个error页面看看它是否会跳转去：

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

再次请求后，确实跳到这个页面了

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

再来看一下DefaultErrorViewResolver(默认的错误视图解析)：这里如果模板引擎可以解析这个视图地址就用模板引擎解析，模板引擎可用的情况下就返回errorViewName指定的视图地址。模板引擎不可用就去静态资源文件夹下找errorViewName对应的视图。而resolveErrorView 可以很明显看到它是根据状态码定制页面了。

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

二、实现ErrorController自定义错误页面

新建CustomErrorController 实现ErrorController，在templates文件夹下新建exception文件夹，对应状态码定义几个页面，为区分error页面，我在新建的error页面中输入模板引擎错误页

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

运行项目发起请求

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理

三、`@ControllerAdvice`和`@ExceptionHandler实现`

新建一个全局异常处理类 GlobalExceptionHandler 这里的@Controller和@RestController或者@RestControllerAdvice要灵活运用。我这里要返回一个视图

@Controller
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(value = Exception.class)
    public Object doExceptionHandler(Exception e, HttpServletRequest request){
        ModelAndView mav = new ModelAndView();
        mav.addObject("message", e);
        mav.addObject("url", request.getRequestURL());
        mav.setViewName("exception/error");
        return mav;
    }
}

修改error模板：

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8">
    <title>error</title>
</head>
<body>
<h1>模板引擎错误页</h1>
<h2 th:text="${message}"></h2>
<h2 th:text="${url}"></h2>
</body>
</html>

运行项目，再次请求

SpringBoot系列记录（九）——从默认处理机制到优雅的统一异常处理