SpringBoot统一处理异常

雨点打透心脏的1/2处 2022-05-26 09:35 248阅读 0赞

在springboot项目，报错有着默认的提示，这篇文章介绍一下如何统一处理异常。

新建项目，pom文件如下：

<?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>com.dalaoyang</groupId>
        <artifactId>springboot_error</artifactId>
        <version>0.0.1-SNAPSHOT</version>
        <packaging>jar</packaging>
    
        <name>springboot_error</name>
        <description>springboot_error</description>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>1.5.9.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-devtools</artifactId>
                <scope>runtime</scope>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>
    
    
    </project>

创建一个IndexController，里面写两个方法，index方法正常跳转，test方法是故意写的一个nullpoint的错误的方法。 代码如下：

package com.dalaoyang.Controller;
    
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    import java.util.Map;
    
    /**
     * @author dalaoyang
     * @Description
     * @project springboot_learn
     * @package com.dalaoyang.Controller
     * @email yangyang@dalaoyang.cn
     * @date 2018/4/28
     */
    @RestController
    public class IndexController {
    
        @RequestMapping("/")
        public String index(){
            return "index";
        }
    
        @RequestMapping("/test")
        public String test(){
            Map map = null;
            return map.toString();
        }
    }

启动项目访问[http://localhost:8080/][http_localhost_8080]，如下图，没有任何问题

![1][]

然后随便访问一个项目里没有的地址，比如[http://localhost:8080/aaa][http_localhost_8080_aaa]，如下图所示，404没有找到：

![2][]

访问[http://localhost:8080/test][http_localhost_8080_test]，如下图500错误：

![3][]

从图上可以看到，springboot报错的时候都在找/error这个地址，这时我们新建一个CommonErrorController来统一处理异常，这个类实现了ErrorController，代码如下：

package com.dalaoyang.Controller;
    
    import org.springframework.boot.autoconfigure.web.ErrorController;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /**
     * @author dalaoyang
     * @Description
     * @project springboot_learn
     * @package com.dalaoyang.Controller
     * @email yangyang@dalaoyang.cn
     * @date 2018/4/28
     */
    @RestController
    public class CommonErrorController implements ErrorController {
    
        private final String ERROR_PATH = "/error";
    
    
        @Override
        public String getErrorPath() {
            return ERROR_PATH;
        }
    
        @RequestMapping(value = ERROR_PATH)
        public String handleError(){
            System.out.println(getErrorPath());
            return "error";
        }
    }

重启项目，在访问http://localhost:8080/aaa和http://localhost:8080/test就都返回"error"字符串了，如下：

![4][]

源码下载 ：[大老杨码云][Link 1]

个人网站：[https://dalaoyang.cn][https_dalaoyang.cn]

[http_localhost_8080]: http://localhost:8080/
[1]: /images/20220526/3b755087cd70468aa2bf9ba2f6694d11.png
[http_localhost_8080_aaa]: http://localhost:8080/aaa
[2]: /images/20220526/5abd889dbcdd43f8b3384149c15acc35.png
[http_localhost_8080_test]: http://localhost:8080/test
[3]: /images/20220526/c1c0173362ec4e31824152c22c70f42e.png
[4]: /images/20220526/614df8f504da49e1a17bfaee833f1c1f.png
[Link 1]: https://gitee.com/dalaoyang/springboot_learn
[https_dalaoyang.cn]: https://www.dalaoyang.cn/