0
点赞
收藏
分享

微信扫一扫

springboot之错误处理原理&定制错误页面

黄昏孤酒 2022-11-30 阅读 65
htmlspring模板引擎


1、springboot默认的错误处理机制

默认效果：（1）浏览器，返回一个默认的错误页面

springboot之错误处理原理&定制错误页面_模板引擎

浏览器发送请求的请求头

springboot之错误处理原理&定制错误页面_模板引擎_02

                    （2）如果是其他客户端，默认响应一个json数据

springboot之错误处理原理&定制错误页面_html_03

springboot之错误处理原理&定制错误页面_spring_04

原理：可以参照package org.springframework.boot.autoconfigure.web.servlet.error下的ErrorMvcAutoConfiguration（错误处理的自动配置）

            给容器中添加了以下组件：

           

DefaultErrorAttributes：帮我们在页面共享信息

public 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;
}

BasicErrorController：处理默认/error请求

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

@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)//产生html类型的数据，浏览器发送的请求来到这个方法处理
public ModelAndView errorHtml(HttpServletRequest request, HttpServletResponse response) {
   HttpStatus status = getStatus(request);
   Map<String, Object> model = Collections
         .unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
   response.setStatus(status.value());

   //去哪个页面作为错误页面，包含页面地址和页面内容
   ModelAndView modelAndView = resolveErrorView(request, response, status, model);
   return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
}

@RequestMapping//产生json数据，其他客户端来到这个方法处理
public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
   Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
   HttpStatus status = getStatus(request);
   return new ResponseEntity<>(body, status);
}

ErrorPageCustomizer

/**
 * Path of the error controller.
 */
@Value("${error.path:/error}")
private String path = "/error";

系统出现错误以后来到error请求进行处理（类似web.xml注册的错误页面规则）

DefaultErrorViewResolver

@Override
public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {
   ModelAndView modelAndView = resolve(String.valueOf(status.value()), model);
   if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
      modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
   }
   return modelAndView;
}

private ModelAndView resolve(String viewName, Map<String, Object> model) {
   
   //默认springboot可以去找到一个页面？   error/404 
   String errorViewName = "error/" + viewName;

  //模板引擎可以解析这个页面地址就用模板引擎解析
   TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName,
         this.applicationContext);
   if (provider != null) {  
      
      //模板引擎可用的情况下返回到errorViewName指定的视图地址
      return new ModelAndView(errorViewName, model);
   }

   //模板引擎不可用，就在静态资源文件夹下找errorViewName对应的页面   error/404.html
   return resolveResource(errorViewName, model);
}

                    步骤：一旦系统出现4xx或者5xx之类的错误，ErrorPageCustomizer就会生效（定制错误的响应规则），就会来到/error请求，就会被BasicErrorController处理

如果是响应页面的：去哪个页面是由DefaultErrorViewResolver解析得到的

protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status,
      Map<String, Object> model) {

   //所有的ErrorViewResolver 得到ModelAndView 
   for (ErrorViewResolver resolver : this.errorViewResolvers) {
      ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
      if (modelAndView != null) {
         return modelAndView;
      }
   }
   return null;
}

2、如何定制错误响应

（1）如何定制错误的页面

在有模板引擎的情况下，error/状态码，将错误页面命名为 错误状态码.html  ，放在模板引擎文件夹templates下的error文件夹下，发生此状态码的错误就会来到对应的页面。我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先（优先寻找精确地状态码.html）

页面能获取的信息：

     timestamp：时间戳

    status：状态码

    error：错误提示

    exception：异常对象

    message：异常消息

    errors：JSR303数据校验的错误都在这里

比如：

springboot之错误处理原理&定制错误页面_spring_05

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>4xx</title>
</head>
<body >
<p>status: [[${status}]]</p>
<p>timestamp: [[${timestamp}]]</p>
<p>error: [[${error}]]</p>
<p>message: [[${message}]]</p>
<p>exception: [[${exception}]]</p>
</body>
</html>

没有模板引擎（模板引擎找不到这个错误页面），就在静态资源文件夹static，resources，public下找

以上都没有错误页面，就默认来到springboot默认的错误提示页面

（2）如何定制错误的json数据

第一种方式：

新建exception包UserNotExitsException类

package com.cnstrong.springboot04webrestfulcrud.exception;

public class UserNotExitsException extends RuntimeException {
    public UserNotExitsException() {
        super("用户不存在");
    }
}
修改HelloController

@ResponseBody
@RequestMapping("/hello")
public String hello(@RequestParam("user") String user){
    if(user.equals("aaa")){
        throw new UserNotExitsException();
    }
    return "Hello world";
}

controller包下新建MyExceptionHandler类

package com.cnstrong.springboot04webrestfulcrud.controller;

import com.cnstrong.springboot04webrestfulcrud.exception.UserNotExitsException;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

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

@ControllerAdvice
public class MyExceptionHandler {

//没有自适应效果，浏览器和客户端返回的都是json数据
    @ResponseBody
    @ExceptionHandler(UserNotExitsException.class)
    public Map<String,Object> handleException(Exception e){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;
    }
}

​​第二种方法，注释掉第一种的方法​​

转发到/error进行自适应响应效果处理

@ExceptionHandler(UserNotExitsException.class)
public String handleException(Exception e, HttpServletRequest request){
    Map<String,Object> map = new HashMap<>();
    //传入自己的错误代码，4xx，5xx，默认200,否则就不会进入定制错误界面的解析流程
    /**
     * protected HttpStatus getStatus(HttpServletRequest request) {
     *        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
     */
    request.setAttribute("javax.servlet.error.status_code",500);
    map.put("code","user.notexist");
    map.put("message",e.getMessage());
    return "forward:/error";
}

​​将我们的定制数据携带出去​​​​出现错误以后会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）规定的方法）​​​​可以完全来编写一个ErrorController的实现类（或者是编写AbstractErrorController的子类）放在容器中​​​​也可以。页面上能用的数据后者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到。容器中DefaultErrorAttributes.getErrorAttributes()默认进行数据处理的。​​

 

修改MyExceptionHandler类
@ExceptionHandler(UserNotExitsException.class)
public String handleException(Exception e, HttpServletRequest request){
    Map<String,Object> map = new HashMap<>();
    //传入自己的错误代码，4xx，5xx，默认200,否则就不会进入定制错误界面的解析流程
    /**
     * protected HttpStatus getStatus(HttpServletRequest request) {
     *        Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
     */
    request.setAttribute("javax.servlet.error.status_code",500);
    map.put("code","user.notexist");
    map.put("message","用户出错了");
    
    request.setAttribute("ext",map);
    return "forward:/error";
}


在component包下新建MyErrorAttributes类

 


package com.cnstrong.springboot04webrestfulcrud.component;

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

import java.util.Map;

//给容器中加入我们自己定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    //ctrl+o
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String,Object> map =  super.getErrorAttributes(webRequest, includeStackTrace);
        map.put("company","atguigu");

        //我们的异常处理器携带的数据
        Map<String,Object> ext = (Map<String, Object>) webRequest.getAttribute("ext",0);
        map.put("ext",ext);
        return map;
    }
}
templates包下的error包下的5xx.html
 
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>5xx</title>
</head>
<body>
<p>status: [[${status}]]</p>
<p>timestamp: [[${timestamp}]]</p>
<p>error: [[${error}]]</p>
<p>message: [[${message}]]</p>
<p>exception: [[${exception}]]</p>
<p>company: [[${company}]]</p>
<p>ext-code: [[${ext.code}]]</p>
<p>ext-message: [[${ext.message}]]</p>
</body>
</html>


最终的效果，响应是自适应的。可以通过定制ErrorAttributes改变需要返回的内容。


springboot之错误处理原理&定制错误页面_html_06

举报

相关推荐

SpringBoot自学好几天 中途开始写笔记 SpringBoot Web开发 错误处理原理 定制错误页面 20190128

html模板引擎ide

Rust之错误处理

小程序

SpringBoot 错误处理机制

SpringBoot技术分享

错误处理(9)

sassscssless

Go 错误处理

stm32c语言单片机

Gorm 错误处理

iosGo错误处理字段HarmonyOS后端开发

Error错误处理

错误类型错误处理云平台云计算

错误处理、调试

ide错误处理子类虚拟化云计算

PHP 错误处理

php开发语言后端

Python 错误处理

python错误信息错误类型编程语言
0 条评论