springboot自定义Error数据

原创

虾米大王 2023-08-12 01:31:14 ©著作权

文章标签 spring boot java spring 自定义 html 文章分类 JavaScript 前端开发

©著作权归作者所有：来自51CTO博客作者虾米大王的原创作品，请联系作者获取转载授权，否则将追究法律责任

复杂配置

html这种配置还是不够灵活，只能定义HTML页面，无法处理JSON的定制。

Spring Boot中支持对Error信息的深度定制，接下来将从三个方面介绍深度定制：

自定义Error数据、自定义Error视图以及完全自定义。

自定义Error数据

自定义Error数据就是对返回的数据进行自定义。前面的介绍，读者已经了解到Spring Boot返回的Error信息一共有5条，分别是timestamp、status、error、message以及path。

在BasicErrorController的errorHtml方法和error方法中，都是通过getErrorAttributes方法获取Error信息的。该方法最终会调用到DefaultErrorAttributes类的getErrorAttributes方法，而DefaultErrorAttributes类是在ErrorMvcAutoConfiguration中默认提供的。

当系统没有提供ErrorAttributes时才会采用DefaultErrorAttributes。因此自定义错误提示时，只需要自己提供一个ErrorAttributes即可，而DefaultErrorAttributes是ErrorAttributes的子类，因此只需要继承DefaultErrorAttributes即可，代码如下：

springboot自定义Error数据_html

pom.xml

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

MyErrorAttribute.java

package com.shrimpking.error;


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.Map;


/**
 * Created by IntelliJ IDEA.
 *
 * @Author : Shrimpking
 * @create 2023/6/4 18:50
 */
@Component
public class MyErrorAttribute extends DefaultErrorAttributes
{
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options)
    {
        Map<String, Object> errorAttributes = super.getErrorAttributes(webRequest, options);
        errorAttributes.put("customMsg","出错啦");
        errorAttributes.remove("error");
        return errorAttributes;
    }
}

4xx.html

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.w3.org/1999/xhtml">
<head>
    <meta charset="UTF-8">
    <title>4xx</title>
</head>
<body>
<table border="1">
    <tr>
        <td>timestamp</td>
        <td th:text="${timestamp}"></td>
    </tr>
    <tr>
        <td>status</td>
        <td th:text="${status}"></td>
    </tr>
    <tr>
        <td>error</td>
        <td th:text="${error}"></td>
    </tr>
    <tr>
        <td>message</td>
        <td th:text="${message}"></td>
    </tr>
    <tr>
        <td>path</td>
        <td th:text="#{path}"></td>
    </tr>
    <tr>
        <td>customMsg</td>
        <td th:text="${customMsg}"></td>
    </tr>
</table>
</body>
</html>

springboot自定义Error数据_spring_02