Spring Boot的统一异常处理

Posted nuist__NJUPT

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了Spring Boot的统一异常处理相关的知识，希望对你有一定的参考价值。

Spring Boot的统一异常处理

在Spring Boot应用开发中，不管是对底层数据库的操作，对业务层的操作，还是对控制层的操作，都会不可避免的遇到各种未知的异常需要处理，如果每个过程都单独处理异常，那么系统的代码耦合度高，工作量大且不好统一，以后维护的工作量也很大。

如果能将所有类型的异常处理从各层中解耦出来，则既保证了相关处理过程的功能单一，也实现了异常信息的统一处理和维护。幸运的是，Spring的框架支持这样的实现，本节将从自定义error页面，@ExceptionHandler注解以及@ControllerAdvice注解3种方式学习Spring Boot应用的异常统一处理。

首先学习一下自定义error页面，在SpringBoot Web应用的src/main/resources/templates目录下添加error.html页面，访问发生错误或者异常发生时，Spring Boot将自动找到该页面作为错误页面，Spring Boot为错误页面提供了以下属性：
1-timestamp:错误发生时间
2-status:HTTP状态码
3-error:错误原因
4-exception:异常的类名
5-message：异常消息(如果这个错误是由异常引起的)
6-errors:BindingResult异常里的各种错误
7-trace：异常跟踪信息，如果这个错误是由异常引起的
8-path:错误发生时请求的URL路径

下面通过一个示例学习一下自定义error页面。
具体实现步骤如下：

1-通过maven创建基于Thymeleaf模板引擎的Spring Boot Web应用，并在pom.xml文件中添加相关依赖。

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>org.example</groupId>
    <artifactId>Thymeleaf</artifactId>
    <version>1.0-SNAPSHOT</version>
    <parent>
        <!--配置SpringBoot的核心启动器-->
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.1.4.RELEASE</version>
    </parent>
    <dependencies>
    <dependency>
        <!--添加starter模块-->
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

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

2-在src/main/java目录下创建com.exception包，在该包中创建自定义异常类MyException。

public class MyException extends Exception {
    private static final long serialVersionUID = 1L ;
    public MyException(){
        super() ;
    }
    public MyException(String message){
        super(message) ;
    }
}

3-在src/main/java包中创建控制器类TestHandlerExceptionController，该控制器类中有四个处理方法，一个为页面导航方法，另外三个分别抛出不同的异常。

import com.exception.MyException;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

import java.sql.SQLException;

@Controller
public class TestHandlerExceptionController {
    @RequestMapping("/index1")
    public String index(){ //页面导航
        return "index1" ;
    }
    @RequestMapping("/db")
    public void db() throws SQLException{
        throw new SQLException("数据库异常") ;
    }
    @RequestMapping("/my")
    public void my() throws MyException{
        throw new MyException("自定义异常") ;
    }
    @RequestMapping("/no")
    public void no() throws  Exception{
        throw new Exception("未知异常") ;
    }
    @RequestMapping("/nofound")
    public void nofound() throws Exception{
        throw new Exception("404错误") ;
    }
}

4-整理脚本样式和静态文件，在src/main/resources/static目录下引入BootStrap框架。

5-创建View视图页面。Thymeleaf模板默认将视图页面放在src/main/resources/templates目录下，因此需要在该目录下创建包含4哥个链接的导航页面index.html和错误处理页面error.html，访问发生错误或者异常发生时，Spring Boot将自动找到erro.html页面作为错误页面，在error.html中为错误页面提供的属性显示错误消息。

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8">
    <title>错误消息页面</title>
    <!--引入BootStrap框架-->
    <link rel = "stylesheet" th:href = "@{css/bootstrap.min.css}"/>
    <link rel = "stylesheet" th:href = "@{css/bootstrap-theme.min.css}"/>
</head>
<body>
<div class = "panel-l container clearfix">
    <div class = "error">
        <p class = "title"><span class = "code" th:text = "${status}"></span>非常抱歉，没有您要查看的页面</p>
        <div class = "common-hint-word">
            <div th:text = "${#dates.format(timestamp, 'yyyy-MM-dd HH:mm:ss')}"></div>
            <div th:text = "${message}"></div>
            <div th:text = "${error}"></div>
        </div>
    </div>
</div>
</body>
</html>在这里插入代码片

6-编写启动类并运行，在src/main/java目录下创建com.test包，在该包中编写启动类，并运行。


import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication(scanBasePackages = {"com"})
public class TestApplication {
    public static void main(String[] args) {
        SpringApplication.run(TestApplication.class, args) ;
    }
}

7-访问 http://localhost:8080/index1 ，运行效果如下：
单击图中的超链接，SpringBoot根据链接请求，找到相应的处理，如图，点击处理数据库异常的链接，将执行控制器中的db（）方法，该方法仅仅抛出SQL异常，但是并没有做异常处理，当SpringBoot发现有异常没有处理，则自动从src/main/resources/templates目录下找到error.html页面显示异常信息。

从图中可以看出，自定义的error.html页面并没有真正处理异常，而是将异常或者错误消息显示给客户端，在服务器客户端控制台上还是会抛出异常。

@ExceptionHandler注解以及@ControllerAdvice注解方式学习Spring Boot应用的异常统一处理见下一篇博文。

以上是关于Spring Boot的统一异常处理的主要内容，如果未能解决你的问题，请参考以下文章

知识点-Spring Boot 统一异常处理汇总

spring boot 2 统一异常处理

基于Spring Boot的统一异常处理设计

Spring Boot 统一异常处理

基于spring boot的统一异常处理

Spring Boot2 系列教程 (十四) | 统一异常处理