Spring Boot web程序如何定製錯誤頁面

我們使用Spring Boot開發web程序,登錄不存在的path時會有錯誤提示頁面。如何設置該錯誤頁面以便更好地提示用戶了?下面針對這個問題做個簡要總結。

默認的錯誤頁面

設置錯誤頁面幾種方式

設置錯誤頁面-Thymeleaf

1, 默認的錯誤頁面

當我們的程序沒有專門設置錯誤頁面時,我們可以看到啓動日誌中有類似信息(注,因爲我使用了swagger所以有/swagger-resources 、/swagger-ui.html等map映射)

2018-07-21 21:33:34.881  INFO 1912 --- [ost-startStop-1] o.s.b.w.servlet.FilterRegistrationBean   : Mapping filter: 'characterEncodingFilter' to: [/*]
2018-07-21 21:33:35.237  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/user/users],methods=[GET],produces=[application/json;charset=UTF-8]}" onto public java.lang.Iterable<com.yq.domain.User> com.yq.controller.UserController.findAllUsers()
2018-07-21 21:33:35.238  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/user/users/{userId}],methods=[GET],produces=[application/json;charset=UTF-8]}" onto public com.yq.domain.User com.yq.controller.UserController.getUser(java.lang.String)
2018-07-21 21:33:35.244  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/swagger-resources/configuration/security]}" onto public org.springframework.http.ResponseEntity<springfox.documentation.swagger.web.SecurityConfiguration> springfox.documentation.swagger.web.ApiResourceController.securityConfiguration()
2018-07-21 21:33:35.245  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/swagger-resources]}" onto public org.springframework.http.ResponseEntity<java.util.List<springfox.documentation.swagger.web.SwaggerResource>> springfox.documentation.swagger.web.ApiResourceController.swaggerResources()
2018-07-21 21:33:35.246  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/swagger-resources/configuration/ui]}" onto public org.springframework.http.ResponseEntity<springfox.documentation.swagger.web.UiConfiguration> springfox.documentation.swagger.web.ApiResourceController.uiConfiguration()
2018-07-21 21:33:35.254  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error]}" onto public org.springframework.http.ResponseEntity<java.util.Map<java.lang.String, java.lang.Object>> org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.error(javax.servlet.http.HttpServletRequest)
2018-07-21 21:33:35.254  INFO 1912 --- [           main] s.w.s.m.m.a.RequestMappingHandlerMapping : Mapped "{[/error],produces=[text/html]}" onto public org.springframework.web.servlet.ModelAndView org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController.errorHtml(javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse)
2018-07-21 21:33:35.395  INFO 1912 --- [           main] pertySourcedRequestMappingHandlerMapping : Mapped URL path [/v2/api-docs] onto method [public org.springframework.http.ResponseEntity<springfox.documentation.spring.web.json.Json> springfox.documentation.swagger2.web.Swagger2Controller.getDocumentation(java.lang.String,javax.servlet.http.HttpServletRequest)]
2018-07-21 21:33:35.443  INFO 1912 --- [           main] o.s.w.s.handler.SimpleUrlHandlerMapping  : Mapped URL path [/swagger-ui.html] onto handler of type [class org.springframework.web.servlet.resource

我們登錄頁面,直接提示錯誤(注, 我們配置任何頁面,因此主頁會直接報錯)
這裏寫圖片描述

2, 設置錯誤頁面幾種方式

Spring Boot自動配置名稱爲error的錯誤對應的視圖,因此只要我們配置視圖解析器就能實現錯誤頁面的定製。

a, 提供一個實現了Spring的view接口的Bean,將該bean ID命名爲error
b, 如果配置了Thymeleaf,提供名稱爲error.html的Thymeleaf模板
c, 如果配置了FreeMaker,提供名稱爲error.ftll的FreeMaker模板
d, 如果配置了Velocity,提供名稱爲error.vml的Velocity模板
e, 如果使用JSP視圖,提供名稱爲error.jsp的JSP頁面

3, 設置錯誤頁面-Thymeleaf

我們選擇使用Thymeleaf, 提供名稱爲error.html的Thymeleaf模板。

3.1 首先, 我們在pom文件中添加依賴

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

3.2 然後, 我們在resources目錄下面的templates目錄提供error.html文件

<!DOCTYPE html>
<html>
<head>
    <meta charset="UTF-8" />
    <title>錯誤頁面!</title>
    <link rel="stylesheet" th:href="@{/style.css}"></link>
</head>
<html>
<div class="errorPage">
    <span class="oops">錯誤Path!</span><br/>
    <p>There seems to be a problem with the page you requested
        (<span th:text="${path}"></span>).</p>
    <p th:text="${'Details: ' + message}"></p>
</div>
</html>

3.3 最後,運行效果截圖
這裏寫圖片描述

代碼在這裏,歡迎加星,fork.

有關使用ErrorController會在其他篇章介紹。

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章