SpringBoot专题学习Part17：SpringBoot自定义定制错误响应页面及JSON数据

红太狼 2023-07-17 04:37 184阅读 0赞

有时候页面出现了一些错误 然后就会出现错误页面  
但是SpringBoot默认的错误页面有点丑 可以自定义修改一下

用浏览器访问的时候 显示的是**错误页面**  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70]  
用其它途径访问的时候 返回的是**JSON数据**  
![在这里插入图片描述][20200319144048243.png]  
因而 分成这两部分来记录 该如何定制修改  
首先 是原理

## 原理： ##

SpringBoot处理异常在ErrorMvcAutoConfiguration类中  
其给容器添加了4个比较重要的类：

*  **1**、**DefaultErrorAttributes**  
    可在页面通过对应的key获取信息：  
    **timestamp：时间戳  
    status：状态码  
    error：错误提示  
    exception：异常对象  
    message：异常消息  
    errors：数据校验错误信息(JSR303)**
 *  **2**、**BasicErrorController**  
    底层：

@Controller
    @RequestMapping("${server.error.path:${error.path:/error}}")
    public class BasicErrorController extends AbstractErrorController {
        
        ...(省略)
    }

处理默认的/**error**请求

*  **3**、**ErrorPageCustomizer**  
    底层：

@Value("${error.path:/error}")
    private String path = "/error";

当系统出现错误之后 会来到/**error**请求进行处理

*  **4**、**DefaultErrorViewResolver**  
    指定Springboot默认错误页面路径  
    若模板引擎可解析该页面地址 则用模板引擎来解析 并返回到指定的视图地址  
    若无法解析 则在静态资源文件夹下找对应的页面

**内部执行流程**是这样的：  
首先 系统出现4xx或5xx之类的错误 然后**ErrorPageCustomizer**就会生效 根据内部定制的错误响应规则  
然后来到/error请求 被**BasicErrorController**进行处理 它里面有两种方法 虽然都是处理的是/error请求  
但是会**根据页面是html页面还是其它页面 然后执行两种不同的方法 生成两种不同的数据**  
*(区分方法就是浏览器的请求头中的Accept值会带有text/html 而其它客户端不会有)*  
然后调用**DefaultErrorViewResolver**解析器 拿到ModelAndView 里面包含了错误信息

默认Springboot可找到一个 error/\[状态码\] 页面(例：error/404.html)  
若模板引擎**可解析**该页面地址 则**用模板引擎来解析 返回ModelAndView 返回到指定的视图地址**  
若**无法解析** 则在**静态资源文件夹**下找对应的 error/\[状态码\] 页面

# 一、定制错误页面 #

## 1、若有模板引擎 ##

将错误页面命名为：**状态码.html**  
放置于**模板引擎包下的error包下**(默认没有 须自己创建)  
例：`error/404.html`  
![在这里插入图片描述][20200319144008160.png]  
当发生此状态码的错误 即跳转到该页面  
错误页面还可命名为**4xx**或**5xx** 即代表**以该数字开头的错误都会跳转到该页面**  
同时存在时 若有精确匹配的页面 则先用精确匹配的页面

然后 在前台的页面上直接获取即可  
例：

<h1>status:[[${status}]]</h1>
    <h2>timestamp:[[${timestamp}]]</h2>

其余可用参数都在DefaultErrorAttributes中 以此类推  
![在这里插入图片描述][20200319144736445.png]

## 2、若无模板引擎 ##

当模板引擎找不到该错误页面文件html  
则会去**resources包下的static静态资源包下**寻找

注：**即使是放在静态资源包下 也需要带有error包**  
即 /resources/static/error/状态码.html  
否则的话 还是会出现原先默认的错误页面 配置了跟没配置一个样

#### 若以上这两种路径都没有配置 则会来到SpringBoot默认的错误提示页面 ####

--------------------

# 二、定制错误信息JSON数据 #

默认返回的异常是这样的：  
![在这里插入图片描述][20200319151940470.png]  
显示的是默认的信息  
可展示为自定义的指定消息  
只需写一个异常处理器：

@ControllerAdvice
    public class MyExceptionHandler {
        
    
        // 只要出现异常 SpringMVC即调用该方法
        // ExceptionHandler指定要处理的异常
        @ResponseBody
        @ExceptionHandler(UserNotExistException.class)
        public Map handleException(Exception e)
        {
        
            Map<String,Object> map=new HashMap<>();
            map.put("code","user not exist");
            map.put("message",e.getMessage());
            return map;
        }
    }

这样 返回的就是指定信息了  
![在这里插入图片描述][20200319152039939.png]  
网页上的也是这样  
![在这里插入图片描述][20200319152044585.png]  
**该方式网页和其它客户端返回的都是JSON数据  
没有自适应效果**

还可以实现**自适应效果**  
即 网页访问 显示的是网页 而并不是JSON数据

# Pt2 自适应效果： #

浏览器和客户端返回的数据不同

后台需要将map键值对转发给/error：

@ExceptionHandler(UserNotExistException.class)
    public String handleException(Exception e, HttpServletRequest request)
    {
        
        Map<String,Object> map=new HashMap<>();
        // 传入错误状态码 否则默认200
        // 注：key必须为javax.servlet.error.status_code
        request.setAttribute("javax.servlet.error.status_code",500);
    
        map.put("code","user not exist");
        map.put("message",e.getMessage());
    
        // 转发到/error 然后让底层的BasicErrorController进行自适应处理
        return "forward:/error";
    }

前台Thymeleaf模板取值：

<h1>status:[[${status}]]</h1>
    <h2>timestamp:[[${timestamp}]]</h2>
    <h2>error:[[${error}]]</h2>
    <h2>message:[[${message}]]</h2>
    <h2>extra:[[${extra}]]</h2>

显示效果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70 1]  
![在这里插入图片描述][20200319152552721.png]  
那么 这些数据的键值对都是默认的  
该如何携带定制的数据呢

# Pt3 定制数据： #

*  方法一、编写一个ErrorController的实现类或AbstractErrorController的子类放入容器中
 *  方法二、页面的展示数据或JSON返回数据都是由errorAttributes.getErrorAttributes得到的  
    容器中的DefaultErrorAttributes.getErrorAttributes()默认进行数据处理  
    因此 **重写`getErrorAttributes()`方法**即可

继承DefaultErrorAttributes的类：

// 添加到容器中
    @Component
    public class MyErrorAttributes extends DefaultErrorAttributes {
        
    
        @Override
        public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        
            Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
            // 添加上错误信息中要增加的字段
            map.put("company","zjitc");
    
            // 异常处理器携带的数据
            // 0代表从Request域中获取
            Object extra = webRequest.getAttribute("extra", 0);
            map.put("extra",extra);
            // 该返回值 即为 页面和json可获取的所有错误信息字段
            return map;
        }
    }

异常捕捉器：

@ControllerAdvice
    public class MyExceptionHandler {
        
        @ExceptionHandler(UserNotExistException.class)
        public String handleException(Exception e, HttpServletRequest request)
        {
        
            Map<String,Object> map=new HashMap<>();
            // 传入错误状态码 否则默认200
            // 注：key必须为javax.servlet.error.status_code
            request.setAttribute("javax.servlet.error.status_code",500);
    
            map.put("code","user not exist");
            map.put("message",e.getMessage());
    
            // 存放自定义的显示信息 然后存到Request域里 这样 底层的错误信息处理器就能接受到了
            request.setAttribute("extra",map);
    
            // 转发到/error 然后让底层的BasicErrorController进行自适应处理
            return "forward:/error";
        }
    }

前台Thymeleaf模板取值：

<h1>status:[[${status}]]</h1>
    <h2>timestamp:[[${timestamp}]]</h2>
    <h2>error:[[${error}]]</h2>
    <h2>message:[[${message}]]</h2>
    <h2>extra:[[${extra}]]</h2>

效果：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70 2]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70 3]  
最终实现了自适应效果  
定制了需要返回的内容

--------------------

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70]: /images/20230528/8b7df1bf29d946558f9f14f562d4e5fd.png
[20200319144048243.png]: /images/20230528/070eaa5292b044bcaaf0eac1465a3224.png
[20200319144008160.png]: /images/20230528/80828b13d5b645fe8de32dfc21c95954.png
[20200319144736445.png]: /images/20230528/75994a4935a340ba8d561c66b112e2e3.png
[20200319151940470.png]: /images/20230528/ef129a211f1f4d38b81fbce955b59906.png
[20200319152039939.png]: /images/20230528/c2d9d76fc837481e9ef2eebb0150fee6.png
[20200319152044585.png]: /images/20230528/1f366ab6cb6941e496ea06ddef84a64f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70 1]: /images/20230528/3cf619bbe60045cd8a0cc101670041df.png
[20200319152552721.png]: /images/20230528/1bfed4a6a8a540878f0d1cb1322cc460.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70 2]: /images/20230528/c1a8a057898a492abf7231c6ce280409.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L1BpY29uam8_size_16_color_FFFFFF_t_70 3]: /images/20230528/83974c567e064f32b205f500f8593120.png