SpringBoot系列教程web篇之404、500異常頁面配置

本文轉載自查看原文 2019-10-10 19:34 3169 Java/ 中間件/ Spring

接着前面幾篇web處理請求的博文，本文將說明，當出現異常的場景下，如404請求url不存在，，403無權，500服務器異常時，我們可以如何處理

原文友鏈: SpringBoot系列教程web篇之404、500異常頁面配置

I. 環境搭建

首先得搭建一個web應用才有可能繼續后續的測試，借助SpringBoot搭建一個web應用屬於比較簡單的活;

創建一個maven項目，pom文件如下

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.1.7</version>
    <relativePath/> <!-- lookup parent from update -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <spring-cloud.version>Finchley.RELEASE</spring-cloud.version>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>com.alibaba</groupId>
        <artifactId>fastjson</artifactId>
        <version>1.2.45</version>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/milestone</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

依然是一般的流程，pom依賴搞定之后，寫一個程序入口

/**
 * Created by @author yihui in 15:26 19/9/13.
 */
@SpringBootApplication
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class);
    }
}

II. 異常頁面配置

在SpringBoot項目中，本身提供了一個默認的異常處理頁面，當我們希望使用自定義的404,500等頁面時，可以如何處理呢？

1. 默認異常頁面配置

在默認的情況下，要配置異常頁面非常簡單，在資源路徑下面，新建 error 目錄，在下面添加400.html, 500html頁面即可

項目結構如上，注意這里的實例demo是沒有使用模板引擎的，所以我們的異常頁面放在static目錄下；如果使用了如FreeMaker模板引擎時，可以將錯誤模板頁面放在template目錄下

接下來實際測試下是否生效, 我們先定義一個可能出現服務器500的服務

@Controller
@RequestMapping(path = "page")
public class ErrorPageRest {

    @ResponseBody
    @GetMapping(path = "divide")
    public int divide(int sub) {
        System.out.println("divide1");
        return 1000 / sub;
    }
}

請求一個不存在的url，返回我們定義的400.html頁面

<html>
<head>
    <title>404頁面</title>
</head>
<body>
<h3>頁面不存在</h3>
</body>
</html>

請求一個服務器500異常，返回我們定義的500.html頁面

<html>
<head>
    <title>500頁面</title>
</head>
<body>
<h2 style="color: red;">服務器出現異常!!!</h2>
</body>
</html>

2. BasicErrorController

看上面的使用比較簡單，自然會有個疑問，這個異常頁面是怎么返回的呢？

從項目啟動的日志中，注意一下RequestMappingHandlerMapping

可以發現里面有個/error的路徑不是我們自己定義的，從命名上來看，這個多半就是專門用來處理異常的Controller -> BasicErrorController，部分代碼如下

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {

	@Override
	public String getErrorPath() {
		return this.errorProperties.getPath();
	}

	@RequestMapping(produces = "text/html")
	public ModelAndView errorHtml(HttpServletRequest request,
			HttpServletResponse response) {
		HttpStatus status = getStatus(request);
		Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(
				request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
		response.setStatus(status.value());
		ModelAndView modelAndView = resolveErrorView(request, response, status, model);
		return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
	}

	@RequestMapping
	@ResponseBody
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		Map<String, Object> body = getErrorAttributes(request,
				isIncludeStackTrace(request, MediaType.ALL));
		HttpStatus status = getStatus(request);
		return new ResponseEntity<>(body, status);
	}
}

這個Controller中，一個返回網頁的接口，一個返回Json串的接口；我們前面使用的應該是第一個，那我們什么場景下會使用到第二個呢？