Spring Boot自定义错误页面，Whitelabel Error Page处理方式

绝地灬酷狼 2022-05-13 07:26 261阅读 0赞

转自：[https://www.cnblogs.com/ityouknow/p/5662753.html][https_www.cnblogs.com_ityouknow_p_5662753.html]

Spring Boot以一种新的微服务的方式来替代以Spring Framework构建项目的传统方式，我已经计划在后续的项目开发中使用它。它已经帮我们做了90%的工作，剩下10%的工作需要我们自己去完成。对于我来说，自定义错误页面就是其中之一。比如404错误，如果不处理的话，会出现“This application has no explicit mapping for /error, so you are seeing this as a fallback.”的错误信息，如图所示：

![Whitelabel Error Page][]

Spring Boot默认使用嵌入式Tomcat，默认没有页面来处理404等常见错误。因此，为了给用户最佳的使用体验，404等常见错误需要我们自定义页面来处理。

我们需要用org.springframework.boot.context.embedded.EmbeddedServletContainerCustomizer类来实现该功能，在Spring Boot的启动类（main方法所在类）当中，添加如下代码：

@Bean
    public EmbeddedServletContainerCustomizer containerCustomizer() {
    
       return (container -> {
            ErrorPage error401Page = new ErrorPage(HttpStatus.UNAUTHORIZED, "/401.html");
            ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
            ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");
    
            container.addErrorPages(error401Page, error404Page, error500Page);
       });
    }

这是使用Java 8的lambda表达式来简化实现的方式，在代码中创建了三个ErrorPage实例来处理三个通用的HTTP错误状态码，并将他们添加到container当中。ErrorPage类是一个封装了错误信息的类，它可以在Jetty和Tomcat环境下使用。

这是使用Java 7内部类的一个等价实现方式：

@Bean
    public EmbeddedServletContainerCustomizer containerCustomizer() {
    
        return new EmbeddedServletContainerCustomizer() {
            @Override
            public void customize(ConfigurableEmbeddedServletContainer container) {
    
                ErrorPage error401Page = new ErrorPage(HttpStatus.UNAUTHORIZED, "/401.html");
                ErrorPage error404Page = new ErrorPage(HttpStatus.NOT_FOUND, "/404.html");
                ErrorPage error500Page = new ErrorPage(HttpStatus.INTERNAL_SERVER_ERROR, "/500.html");
    
                container.addErrorPages(error401Page, error404Page, error500Page);
            }
        };
    }

错误页面需要放在Spring Boot web应用的static内容目录下，它的默认位置是：src/main/resources/static，如下图所示：

![这里写图片描述][20151206212409248]

[点击链接][Link 1]下载图中的三个文件的压缩文件，这些文件使用 [HTML5 Boilerplate][]制作。

现在，就可以看到一个简易版本的错误页面，可以根据自己的需要对它进行一些美化。

编译自：[http://www.sporcic.org/2014/05/custom-error-pages-with-spring-boot/][http_www.sporcic.org_2014_05_custom-error-pages-with-spring-boot]。

[https_www.cnblogs.com_ityouknow_p_5662753.html]: https://www.cnblogs.com/ityouknow/p/5662753.html
[Whitelabel Error Page]: /images/20220513/42abdf71965d4b53982824222bd7b4aa.png
[20151206212409248]: /images/20220513/0adc95bef2a742d3b1b6c0e2a24dbbb3.png
[Link 1]: http://download.csdn.net/detail/github_32521685/9331627
[HTML5 Boilerplate]: https://html5boilerplate.com/
[http_www.sporcic.org_2014_05_custom-error-pages-with-spring-boot]: http://www.sporcic.org/2014/05/custom-error-pages-with-spring-boot/