springboot 自定义错误页面

已于 2024-10-29 15:01:59 修改
阅读量1.2k 收藏 21
点赞数 14
分类专栏： springboot 文章标签： spring boot 后端 java
于 2024-10-29 14:42:14 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/loveLifeLoveCoding/article/details/143328854
版权

自定义错误页面

背景：当我们访问应用程序不存在的接口路径或者参数传递不规范时，springboot 默认提示 如下页面
在这里插入图片描述
该页面对用户不友好，我们可以自定义展示错误页来改善。

优化后的简洁效果，可对 html 页面进一步美化，这里只说明修改默认错误页方法。
在这里插入图片描述

demo地址

https://gitee.com/stormlong/springboot-errorpage

官方文档

https://docs.spring.io/spring-boot/docs/2.7.18/reference/html/web.html#web.servlet.spring-mvc.error-handling.error-pages
在这里插入图片描述
在这里插入图片描述

静态页面

resources\public\error
不引入任何模板引擎时，在这个目录下寻找
且文件名和错误状态码保持一致

动态页面

resources\templates\error
引入模板引擎时，在这个目录下寻找
例 :

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

且文件名和错误状态码保持一致

优先级

html 文件命名也可以为 4xx 或者是 5xx ,这里的 xx 代表了 404, 401等异常错误

不引入任何模板引擎时，优先具体的错误码页面，然后是 4xx页面，即

  1. \public\error\404.html
  2. \public\error\4xx.html

引入模板引擎时，优先级

  1. \templates\error 目录下的 404.html
  2. \public\error 目录下的 404.html
  3. \templates\error 目录下的 4xx.html
  4. \public\error 目录下的 4xx.html

没有任何错误页面时，默认来到 SpringBoot 默认的错误提示页面

总结：优先具体的错误码页面，然后动态目录下的 4xx 页面
在这里插入图片描述

原理解析

处理异常类

在spring boot中，我们可以找到 BasicErrorController，这个类主要用来处理异常

@Controller
//如果没有配置server.error.path就去error.path找，如果没有配置默认路径为/error
@RequestMapping({"${server.error.path:${error.path:/error}}"})
public class BasicErrorController extends AbstractErrorController {
    ...
}

即我们可以通过 server.error.path 来定义错误的目录，缺省则使用默认 /error 目录

server:
  error:
    path: /error

默认 yaml 配置

server:
  port: 8080
  error:
    path: /error

spring:
  thymeleaf:
    cache: false
    # 以下均为默认配置 可从该类 ThymeleafProperties 下看到 
    prefix: classpath:/templates/
    suffix: .html
    mode: html
    encoding: UTF-8
    servlet:
      content-type: text/html

返回错误信息

SpringBoot默认返回的错误信息，通过DefaultErrorAttruites类可以找到

//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//

package org.springframework.boot.web.servlet.error;

import java.io.PrintWriter;
import java.io.StringWriter;
import java.util.Date;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.boot.web.error.ErrorAttributeOptions;
import org.springframework.boot.web.error.ErrorAttributeOptions.Include;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.http.HttpStatus;
import org.springframework.util.ObjectUtils;
import org.springframework.util.StringUtils;
import org.springframework.validation.BindingResult;
import org.springframework.web.context.request.RequestAttributes;
import org.springframework.web.context.request.WebRequest;
import org.springframework.web.servlet.HandlerExceptionResolver;
import org.springframework.web.servlet.ModelAndView;

@Order(-2147483648)
public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver, Ordered {
    private static final String ERROR_INTERNAL_ATTRIBUTE = DefaultErrorAttributes.class.getName() + ".ERROR";

    public DefaultErrorAttributes() {
    }

    public int getOrder() {
        return -2147483648;
    }

    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) {
        this.storeErrorAttributes(request, ex);
        return null;
    }

    private void storeErrorAttributes(HttpServletRequest request, Exception ex) {
        request.setAttribute(ERROR_INTERNAL_ATTRIBUTE, ex);
    }

    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        Map<String, Object> errorAttributes = this.getErrorAttributes(webRequest, options.isIncluded(Include.STACK_TRACE));
        if (!options.isIncluded(Include.EXCEPTION)) {
            errorAttributes.remove("exception");
        }

        if (!options.isIncluded(Include.STACK_TRACE)) {
            errorAttributes.remove("trace");
        }

        if (!options.isIncluded(Include.MESSAGE) && errorAttributes.get("message") != null) {
            errorAttributes.remove("message");
        }

        if (!options.isIncluded(Include.BINDING_ERRORS)) {
            errorAttributes.remove("errors");
        }

        return errorAttributes;
    }

    private Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> errorAttributes = new LinkedHashMap();
        errorAttributes.put("timestamp", new Date());
        this.addStatus(errorAttributes, webRequest);
        this.addErrorDetails(errorAttributes, webRequest, includeStackTrace);
        this.addPath(errorAttributes, webRequest);
        return errorAttributes;
    }

    private void addStatus(Map<String, Object> errorAttributes, RequestAttributes requestAttributes) {
        Integer status = (Integer)this.getAttribute(requestAttributes, "javax.servlet.error.status_code");
        if (status == null) {
            errorAttributes.put("status", 999);
            errorAttributes.put("error", "None");
        } else {
            errorAttributes.put("status", status);

            try {
                errorAttributes.put("error", HttpStatus.valueOf(status).getReasonPhrase());
            } catch (Exception var5) {
                errorAttributes.put("error", "Http Status " + status);
            }

        }
    }

    private void addErrorDetails(Map<String, Object> errorAttributes, WebRequest webRequest, boolean includeStackTrace) {
        Throwable error = this.getError(webRequest);
        if (error != null) {
            while(true) {
                if (!(error instanceof ServletException) || error.getCause() == null) {
                    errorAttributes.put("exception", error.getClass().getName());
                    if (includeStackTrace) {
                        this.addStackTrace(errorAttributes, error);
                    }
                    break;
                }

                error = error.getCause();
            }
        }

        this.addErrorMessage(errorAttributes, webRequest, error);
    }

    private void addErrorMessage(Map<String, Object> errorAttributes, WebRequest webRequest, Throwable error) {
        BindingResult result = this.extractBindingResult(error);
        if (result == null) {
            this.addExceptionErrorMessage(errorAttributes, webRequest, error);
        } else {
            this.addBindingResultErrorMessage(errorAttributes, result);
        }

    }

    private void addExceptionErrorMessage(Map<String, Object> errorAttributes, WebRequest webRequest, Throwable error) {
        errorAttributes.put("message", this.getMessage(webRequest, error));
    }

    protected String getMessage(WebRequest webRequest, Throwable error) {
        Object message = this.getAttribute(webRequest, "javax.servlet.error.message");
        if (!ObjectUtils.isEmpty(message)) {
            return message.toString();
        } else {
            return error != null && StringUtils.hasLength(error.getMessage()) ? error.getMessage() : "No message available";
        }
    }

    private void addBindingResultErrorMessage(Map<String, Object> errorAttributes, BindingResult result) {
        errorAttributes.put("message", "Validation failed for object='" + result.getObjectName() + "'. Error count: " + result.getErrorCount());
        errorAttributes.put("errors", result.getAllErrors());
    }

    private BindingResult extractBindingResult(Throwable error) {
        return error instanceof BindingResult ? (BindingResult)error : null;
    }

    private void addStackTrace(Map<String, Object> errorAttributes, Throwable error) {
        StringWriter stackTrace = new StringWriter();
        error.printStackTrace(new PrintWriter(stackTrace));
        stackTrace.flush();
        errorAttributes.put("trace", stackTrace.toString());
    }

    private void addPath(Map<String, Object> errorAttributes, RequestAttributes requestAttributes) {
        String path = (String)this.getAttribute(requestAttributes, "javax.servlet.error.request_uri");
        if (path != null) {
            errorAttributes.put("path", path);
        }

    }

    public Throwable getError(WebRequest webRequest) {
        Throwable exception = (Throwable)this.getAttribute(webRequest, ERROR_INTERNAL_ATTRIBUTE);
        if (exception == null) {
            exception = (Throwable)this.getAttribute(webRequest, "javax.servlet.error.exception");
        }

        webRequest.setAttribute(ErrorAttributes.ERROR_ATTRIBUTE, exception, 0);
        return exception;
    }

    private <T> T getAttribute(RequestAttributes requestAttributes, String name) {
        return requestAttributes.getAttribute(name, 0);
    }
}

自定义扩展返回

如果要想自定义扩展返回的信息，我们可以自定义一个类来继承这个类，代码如下：

import org.springframework.boot.web.error.ErrorAttributeOptions;
import org.springframework.boot.web.servlet.error.DefaultErrorAttributes;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.WebRequest;

import java.util.HashMap;
import java.util.Map;

@Component
public class CustomDefaultErrorAttribute extends DefaultErrorAttributes {

    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
        Map<String, Object> map = new HashMap<>();
        map.put("compay", "深证腾讯计算公司");
        //调用父类来添加之前Spring的错误信息
        map.putAll(super.getErrorAttributes(webRequest, options));
        return map;
    }

}

页面获取代码如下

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
  <meta charset="UTF-8">
  <title>动态404错误</title>
</head>
<body>
<h1>this is 404 page :(</h1>
<h2>timestamp:[[${timestamp}]]</h2>
<h2>status:[[${status}]]</h2>
<h2>path:[[${path}]]</h2>
<h2>error:[[${error}]]</h2>
<h2>message:[[${message}]]</h2>
<h2>exception:[[${exception}]]</h2>
<h2>trace:[[${trace}]]</h2>
<h2>compay:[[${compay}]]</h2>
</body>
</html>

tomcat 自定义错误页面（扩展）

官方文档：

https://tomcat.apache.org/tomcat-9.0-doc/config/valve.html#Error_Report_Valve

tomcat-404错误，使用自定义页面屏蔽敏感信息

  1. 在项目中新增404页面，例如：/resource/templates/errorpage/400.html
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Error</title>
</head>
<body>
<h1>400 Bad Request</h1>
</body>
</html>

  1. 在server.xml配置文件里进行配置 配置节点下新增 部分

    https://tomcat.apache.org/tomcat-9.0-doc/config/host.html

    https://tomcat.apache.org/tomcat-9.0-doc/config/context.html

<Host appBase="/app/webapps">
    <Context path="/abc/def"></Context>
	<Valve className="org.apache.catalina.valves.ErrorReportValve" errorCode.404="/app/webapps/abc/def/WEB-INF/classes/templates/errorpage/400.html" showReport="false" showServerInfo="false" />
</Host>

访问不成功时可尝试 abc/ 替换成 abc#

/app/webapps/abc#def/WEB-INF/classes/templates/errorpage/400.html

配置说明

showReport：如果设置为false，则不会在HTML响应中返回错误报告。默认值：true

showServerInfo：如果设置为false，则不会在HTML响应中返回服务器版本。默认值：true

errorCode.xxx: 要为xxx表示的HTTP错误代码返回的UTF-8编码的HTML文件的位置。例如，errorCode.404指定HTTP 404错误返回的文件。位置可以是相对的或绝对的。如果是相对的，则必须是相对于 $CATALINA_BASE的。

className要使用的实现的Java类名。必须将其设置为 org.apache.catalina.valves.ErrorReportValve 以使用默认的错误报告值。

appBase: 此虚拟主机的应用程序基目录。这是一个目录的路径名，该目录可能包含要在此虚拟主机上部署的Web应用程序。如果未指定，则将使用默认的 webapps。

path: 此Web应用程序的上下文路径，它与每个请求URI的开头相匹配，以选择要处理的适当Web应用程序。特定主机内的所有上下文路径都必须是唯一的。

java入门014～springboot自定义错误页面 并重定向到首页
2401_84424453的博客
04-20 763
上一节给大家讲解了springboot的全局异常处理，开发者可以根据实际情况返回不同的页面，但是这种全局异常处理的方式一般用来处理应用级别的异常，有一些容器级别的错误就处理不了，比如Filter中抛出的异常，使用controllerAdvice定义的全局异常处理机制就没有办法处理了。这样我们自定义的错误页面就定义好了，下面给大家讲解我们如何在进入错误页面后，重定向到我们的首页。可以看出，我们在发生错误时，跳转到了自定义的404错误页面，然后隔5秒后，会重新跳转到我们的首页。2，错误页面重定向到首页。
springboot自定义错误页面404、500
噗呲可呲的博客
08-08 448
使用的模板引擎为Freemarker，页面存放位置如图 application文件中配置映射文件位置 spring.freemarker.template-loader-path=classpath:/templates/ 编写一个类实现ErrorController来处理异常页面 import org.springframework.boot.web.servlet.error.ErrorC...
Spring Boot自定义错误页面
12-06
该资源是我的博文《Spring Boot自定义错误页面》的关联资源，博文链接：http://blog.youkuaiyun.com/github_32521685/article/details/50198467
springboot自定义错误页面
热门推荐
我要上天
05-19 1万+
自定义一个controller实现ErrorController，重写getErrorPath方法，ErrorController是springboot自带的错误控制器@Controller @RequestMapping(value = "/error")//这个映射是必须的 public class BaseErrorController implements ErrorController {
Spring Boot启动报错终极排查指南：11个高频问题+解决方案，程序员必藏
最新发布
一本大学生java学习技术分享与交流
03-21 3045
「Spring Boot启动报错」是开发者高频痛点：依赖冲突抛出NoSuchMethodError、静态资源加载失败触发Whitelabel Error Page、循环依赖导致BeanCurrentlyInCreationException......本文深度解析20个经典报错场景，覆盖配置、Bean管理、安全拦截、日志冲突等核心模块。每个问题均提供： 1️⃣ 根因定位：结合日志片段快速锁定问题； 2️⃣ 一键修复：命令行工具+代码示例直击解决方案； 3️⃣ 长效避坑：从版本兼容到线程池优化，预防二次踩雷
Spring Boot 自定义错误页
探索er的博客
04-01 3176
自定义错误页
SpringBoot自定义错误页面
白不懂黑的静的专栏
10-23 591
使用Web应用时,在请求处理过程中发生错误是非常常见的情况.SpringBoot为我们提供一个默认的映射:/error,当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面来展示异常内容.比如现在启动my-spring-boot项目,项目启动完成之后,在浏览器中随便输入一个访问地址,由于地址不存在,SpringBoot会跳转到错误页面,如图所示. 虽然Spring Boot为我们提供了默认的错误页面映射,但是在实际应用中,上图所示的错误页面对用户来说并不友好,我们需要自己来实现异常
SpringBoot-自定义错误页
m0_58815972的博客
08-15 1215
SpringBoot自定义错误页
SpringBoot自定义错误页面，SpringBoot 404、500错误提示页面
04-27
本文将详细介绍如何在Spring Boot中自定义错误页面，以及处理404和500这两种常见错误。 首先，让我们了解Spring Boot默认的错误处理机制。Spring Boot通过`ErrorController`接口和`ErrorAttributes`类来处理错误...
SpringBoot自定义错误页面与数据结构算法分析
"该资源包含了关于SpringBoot的参考手册，特别是如何自定义WhiteLabel错误页面，以及《数据结构与算法分析》英文原版第四版，该书深入探讨了C++中的数据结构和算法。" 在SpringBoot应用中，当发生未处理的异常时，...
SpringBoot专题学习Part17：SpringBoot自定义定制错误响应页面及JSON数据
"✧treasure mountain✧"
03-19 8303
有时候页面出现了一些错误 然后就会出现错误页面 但是SpringBoot默认的错误页面有点丑 可以自定义修改一下 用浏览器访问的时候 显示的是错误页面 用其它途径访问的时候 返回的是JSON数据 因而 分成这两部分来记录 该如何定制修改 首先 是原理 原理： SpringBoot处理异常在ErrorMvcAutoConfiguration类中 其给容器添加了4个比较重要的类： 1、Defa...
Spring Boot定制错误页面
NewBeen1的博客
11-06 434
本文将通过实例代码和原理解析，详细介绍如何在Spring Boot应用中定制错误页面，提升用户体验和故障排除效率。
Spring Boot 自定义错误页面
SeanTandol的博客
04-02 471
使用Spring Boot构建的WEB应用可以很方便的打成jar包发布，也可以打成war包发布到应用服务器中。自定义错误页面在这两种发布方式下是不一样的。 jar包中自定义错误页面 创建Spring Boot项目，默认打包方式是jar，内部使用内嵌tomcat等servlet容器 最简单的方式是直接在resources/templates目录下创建error.html页面，此时如果访问不存在...
Springboot配置异常错误页
HiterCoder
11-15 1308
1、在Web项目开发过程中，错误信息提示页是一个重要的组成部分。为了不让用户直接看见异常信息的页面，此时，就需要有一个错误信息提示页。错误页面一般都属于静态页面，这里在src/main/resources/static目录下创建error-404.html。 首先，在pom.xml里面新增几个配置，在src/main/resources目录下面要加下，不然无法进行加载，修改完毕之后，ma...
SpringBoot自定义错误页
qq_25775675的博客
11-08 2260
Spring Boot 中的错误默认是由= null)?}其中, errorHtml方法用来返回错误HTML页面, error用来返回错误JSON,具体返回的是HTML还是JSON，则要看请求头的Accept参数。返回JSON的逻辑很简单，不必过多介绍，返回HTML的逻辑稍微有些复杂，在 errorHtml方法中，通过调用resolveErrorView方法来获取一个错误视图的ModelAndView。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值