springboot之统一处理异常

Posted 2021-07-17 程序逸

springboot项目中访问页面出错等是默认的报错页面，我们可以统一一下，这样可以增加用户的体验，比如报404返回一个漂亮的404页面，这样用户也不会心浮气躁了。

1.创建一个springboot项目，依赖如下：

<?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 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>
    <groupId>com.ctvit</groupId>
    <artifactId>unified-exception-demo</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>unified-exception-demo</name>
    <description>Demo project for Spring Boot</description>
    <properties>
        <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-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
            <scope>runtime</scope>
            <optional>true</optional>
        </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>

2.创建一个控制器IndexController,里面写两个方法，一个正常访问，一个访问错误。

package com.ctvit.unifiedexceptiondemo.controller;

import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import java.util.Map;

@RestController
public class IndexController {

    @RequestMapping("/")
    public String index(){
        return "index";
    }

    @RequestMapping("/test")
    public String test(){
        Map map = null;
        return map.toString()
    }
}

3.此时启动项目，访问，会出现一个正常，一个空指针异常，再加一个项目没有的访问路径。

可以看到，这个页面多唬人，如果用户看到这个页面内心肯定不好受。我们可以看到，当出现错误时，都会去找一个/error的路径，此时我们可以创建一个控制器来统一这个异常处理。

4.新建一个CommonErrorController实现ErrorController。

package com.ctvit.unifiedexceptiondemo.controller;

import org.springframework.boot.web.servlet.error.ErrorController;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class CommonErrorController implements ErrorController {
    private final String ERROR_PATH = "/error";

    public String getErrorPath() {
        return ERROR_PATH;
    }

    @RequestMapping(value = ERROR_PATH)
    public String handleError(){
        System.out.println(getErrorPath());
        return "error";
    }
}

5.再次访问，效果如下,可以看到访问报500错误的页面和404的都显示的同一个页面：