首页 » Spring Boot实战 » Spring Boot实战全文在线阅读

《Spring Boot实战》3.3 定制应用程序错误页面

关灯直达底部

错误总是会发生的,那些在生产环境里最健壮的应用程序偶尔也会遇到麻烦。虽然减小用户遇到错误的概率很重要,但让应用程序展现一个好的错误页面也同样重要。

近年来,富有创意的错误页已经成为了一种艺术。如果你曾见到过GitHub.com的星球大战错误页,或者是DropBox.com的Escher立方体错误页的话,你就能明白我在说什么了。

我不知道你在使用阅读列表应用程序时有没有碰到错误,如果有的话,你看到的页面应该和图3-1里的很像。

Spring Boot默认提供这个“白标”(whitelabel)错误页,这是自动配置的一部分。虽然这比Stacktrace页面要好一点,但和网上那些伟大的错误页艺术品却不可同日而语。为了让你的应用程序故障页变成大师级作品,你需要为应用程序创建一个自定义的错误页。

Spring Boot自动配置的默认错误处理器会查找名为error的视图,如果找不到就用默认的白标错误视图,如图3-1所示。因此,最简单的方法就是创建一个自定义视图,让解析出的视图名为error。

图 3-1 Spring Boot的默认白标错误页面

这一点归根到底取决于错误视图解析时的视图解析器。

  • 实现了Spring的View接口的Bean,其 ID为error(由Spring的BeanNameViewResolver所解析)。

  • 如果配置了Thymeleaf,则有名为error.html的Thymeleaf模板。

  • 如果配置了FreeMarker,则有名为error.ftl的FreeMarker模板。

  • 如果配置了Velocity,则有名为error.vm的Velocity模板。

  • 如果是用JSP视图,则有名为error.jsp的JSP模板。

因为我们的阅读列表应用程序使用了Thymeleaf,所以我们要做的就是创建一个名为error.html的文件,把它和其他的应用程序模板一起放在模板文件夹里。代码清单3-7是一个简单有效的错误页,可以用来代替默认的白标错误页。

代码清单3-7 阅读列表应用程序的自定义错误页

<html>  <head>    <title>Oops!</title>    <link rel="stylesheet" th:href="@{/style.css}"></link>  </head>  <html>    <p>      <span>Oops!</span><br/>      <img th:src="@{/MissingPage.png}"></img>      <p>There seems to be a problem with the page you requested         (<span th:text="${path}"></span>).</p>     ←---显示请求路径      <p th:text="${'Details: ' + message}"></p>    ←---显示错误明细    </p>  </html></html>  

这个自定义的错误模板应该命名为error.html,放在模板目录里,这样Thymeleaf模板解析器才能找到它。在典型的Maven或Gradle项目里,这就意味着要把该文件放在src/main/resources/ templates中,运行时它就在Classpath的根目录里。

基本上,这个简单的Thymeleaf模板就是显示一张图片和一些提示错误的文字。其中有两处特别的信息需要呈现:错误的请求路径和异常消息。但这还不是错误页上的全部细节。默认情况下,Spring Boot会为错误视图提供如下错误属性。

  • timestamp:错误发生的时间。

  • status:HTTP状态码。

  • error:错误原因。

  • exception:异常的类名。

  • message:异常消息(如果这个错误是由异常引起的)。

  • errorsBindingResult异常里的各种错误(如果这个错误是由异常引起的)。

  • trace:异常跟踪信息(如果这个错误是由异常引起的)。

  • path:错误发生时请求的URL路径。

其中某些属性,比如path,在向用户交待问题时还是很有用的。其他的,比如trace,用起来要保守一点,将其隐藏,或者用得聪明点,让错误页尽可能对用户友好。

请注意,模板里还引用了一张名为MissingPage.png的图片。图片的实际内容并不重要,所以尽情挑选适合你的图片就好了,但请一定将它放在src/main/resources/static或src/main/resources/public里,这样应用程序运行时才能找到它。

图3-2是发生错误时用户会看到的页面。虽然它算不上一件艺术品,但还是把应用程序错误页的艺术水准稍微提高了那么一点。

图 3-2 遇到错误时展现的自定义错误页