Spring Boot 2.x Whitelabel Error Page 源码分析以及解决方案

最新推荐文章于 2024-05-01 11:27:15 发布

weixin_34174132

最新推荐文章于 2024-05-01 11:27:15 发布

阅读量351

点赞数

文章标签： python java

原文链接：https://my.oschina.net/itlangz/blog/3007534

版权

2019独角兽企业重金招聘Python工程师标准>>>

在使用 Spring Boot 如果出现错误会出现 Whitelabel Error Page 页面，这个是 Spring Boot 默认处理错误的一个页面，是一硬编码的形式创建的。我们可以替换调，使用自己的error页面，并且美化它。

网上也有很多类似的文章，不过看了很多有的不全面、有的根本就是错误的(比如设置server.error.whitelabel.enabled=false添加error.html，这是有前提的)，今天我们从源码的角度来分析它并给出解决方案。

首选Spring Boot 如果出现错误，比如：500、503、404等，均是有 org.springframework.boot.autoconfigure.web.servlet.error.BasicErrorController 处理的，我们也可以重写它（如果你重写了它，你会惊奇的发现：下面的内容是多余的，哈哈）实现自己的逻辑;

从图上可以看出 Spring Boot 想的很周全，同步和异步均有处理，这里我们只讨论同步的问题, 因为只有同步会出现Whitelabel Error Page

我们定位到解析视图的那句代码

ModelAndView modelAndView = resolveErrorView(request, response, status, model);

resolveErrorView 是由父类AbstractErrorControllers实现

ErrorViewResolver 的默认实现是 DefaultErrorViewResolver

从resolve方法中我们可以拆分一下几步 1、找到可用的模版引擎提供者

假如出现的错误是 500 则此时errorViewName="error/500"

查找逻辑交给了TemplateAvailabilityProviders类的getProvider方法，此方法会缓存已经存在的模板引擎提供者, 具体由findProvider去查找，若findProvider也没找到会默认注册一个NoTemplateAvailabilityProvider
注意 this.providers 这是 Spring Boot 在容器启动的时候就会添加的，通过模板引擎类名是否存在来判断是否添加某个的模板引擎提供者，默认Spring Boot 会注册一下几个模板引擎提供者；
加载模板引擎提供者

loadFactories 加载的是spring-boot-autoconfigure-2.xxxx.jar下面的META-INF/spring.factories, 此方法可以获取父类所有的实现类

这里以ThymeleafTemplateAvailabilityProvider为例
从图中可以看出找的是classpath:/templates/error/500.html 所以若出现500错误我们可以在src/main/resources/ 下新建目录templates/error在新建一个thymeleaf的500.html模板就可以了；404错误同理
从这里我们不难看出若想成功找到错误模板必须满足一下条件

类路径存在模板引擎的jar
classpath下存在存在当前错误模板(例:500.html)

2、若第1步中的provider找到则不用继续下一步，直接返回找到的视图

3、若第1步中没有满足条件的provider则交给resolveResource处理；我们来看看resolveResource的逻辑
这一步主要的直接获取静态的html；一般500和404可以直接使用静态的HTML资源展示一个友好的提示即可，所以这里直接获取静态的资源文件默认查找位置如下

可以通过配置改变

假如出现的错误是500，查找结果如图;我们只需要创建资源文件，就可以访问<staticLocations>/error/5xx.html

4、如果以上三步都没满足，怎么办？从BasicErrorController 中可以看到最后会有个error默认view，就会去找classpath:/templates/error.html,处理逻辑同上；如果依然找不到Spring Boot 就会默认交给 ErrorMvcAutoConfiguration中的 StaticView 去渲染

前提是 server.error.whitelabel.enabled=true

private static class StaticView implements View {

    private static final Log logger = LogFactory.getLog(StaticView.class);

    @Override
    public void render(Map<String, ?> model, HttpServletRequest request,
            HttpServletResponse response) throws Exception {
        if (response.isCommitted()) {
            String message = getMessage(model);
            logger.error(message);
            return;
        }
        StringBuilder builder = new StringBuilder();
        Date timestamp = (Date) model.get("timestamp");
        Object message = model.get("message");
        Object trace = model.get("trace");
        if (response.getContentType() == null) {
            response.setContentType(getContentType());
        }
        builder.append("<html><body><h1>Whitelabel Error Page</h1>").append(
                "<p>This application has no explicit mapping for /error, so you are seeing this as a fallback.</p>")
                .append("<div id='created'>").append(timestamp).append("</div>")
                .append("<div>There was an unexpected error (type=")
                .append(htmlEscape(model.get("error"))).append(", status=")
                .append(htmlEscape(model.get("status"))).append(").</div>");
        if (message != null) {
            builder.append("<div>").append(htmlEscape(message)).append("</div>");
        }
        if (trace != null) {
            builder.append("<div style='white-space:pre-wrap;'>")
                    .append(htmlEscape(trace)).append("</div>");
        }
        builder.append("</body></html>");
        response.getWriter().append(builder.toString());
    }

    private String htmlEscape(Object input) {
        return (input != null) ? HtmlUtils.htmlEscape(input.toString()) : null;
    }

    private String getMessage(Map<String, ?> model) {
        Object path = model.get("path");
        String message = "Cannot render error page for request [" + path + "]";
        if (model.get("message") != null) {
            message += " and exception [" + model.get("message") + "]";
        }
        message += " as the response has already been committed.";
        message += " As a result, the response may have the wrong status code.";
        return message;
    }

    @Override
    public String getContentType() {
        return "text/html";
    }

}

这就是 Whitelabel Error Page 来源

综上所述，共有如下解决方案

若项目中使用了模板引擎比如thymeleaf freemarker
此时server.error.whitelabel.enabled关闭和开启无关

在classpath下新建模板 /templates/error/5xx.html /templates/error/4xx.html
在classpath下新建静态资源 /<staticlocation>/error/5xx.html /<staticlocation>/error/4xx.html
在classpath下直接新建模板 /templates/error.html