springboot(11)——异常处理和自定义错误页面

时间 2019-11-26

标签 springboot 异常处理自定义错误页面栏目 Spring 繁體版

原文原文链接

1.异常来源

要处理程序发生的异常，首先须要知道异常来自哪里？html

1.前端错误的的请求路径，会使得程序发生4xx错误，最多见的就是404，Springboot默认当发生这种错误的请求路径，pc端响应的页面以下前端

若是是移动端（手机端）将会响应json格式的数据，以下java

2.Springboot异常处理原理

为何咱们请求错误的路径，boot会给咱们返回一个上面错误页面或者json格式数据呢？原理是怎样的呢？
react

Springboot项目启动以后，执行有@SpringBootApplication注解的启动类的main方法，经过@EnableAutoConfiguration加载web

springbootAutoConfiguration.jar包下的META-INF/spring.factories中的全部配置类（这些配置类加载以后，会将每一个配置类里面的组件注入容器而后使用）其中一个自动配置spring

ErrorMvcAutoConfiguration，经过代码能够看到用到了如下四个组件json

DefaultErrorAttributes、BasicErrorController、errorPageCustomizer、DefaultErrorViewResolver后端

其余三个基本相似，当出现4xx或者5xx等错误时，errorPageCustomizer就会生效，this.properties.getError().getPath())并来到/error请求，核心代码springboot

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

而这个/error请求再由BasicErrorController处理，BasicErrorController是一个Controller，其中里面有两种处理方法，一种是HTML形式，服务器

一种是JSON格式。其中访问者的信息能够从getErrorAttributes从获取。DefaultErrorAttributes是ErrorAttributes的实现类。

关键代码

@RequestMapping(produces = "text/html") //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 ? new ModelAndView("error", model) : modelAndView);
    }

    @RequestMapping
    @ResponseBody //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);
    }

当为HTML模式时，就会构建一个resolveErrorView类，而resolverErrorView继续调用ErrorViewResolver。关键代码

protected ModelAndView resolveErrorView(HttpServletRequest request,
            HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
        for (ErrorViewResolver resolver : this.errorViewResolvers) {
            ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
            if (modelAndView != null) {
                return modelAndView;
            }
        }
        return null;
    }

在咱们没有作自定义配置时，ErrorViewResolver就会指向DefaultErrorViewResolver。

static {
        //能够用4xx,5xx文件名来统一匹配错误,可是会以精确优先的原则
        Map<Series, String> views = new EnumMap<>(Series.class);
        views.put(Series.CLIENT_ERROR, "4xx");
        views.put(Series.SERVER_ERROR, "5xx");
        SERIES_VIEWS = Collections.unmodifiableMap(views);
    }

 @Override
    public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,
                                         Map<String, Object> model) {
        ModelAndView modelAndView = resolve(String.valueOf(status), 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) {
        //将错误代码拼接到error后
        String errorViewName = "error/" + viewName;
        TemplateAvailabilityProvider provider = this.templateAvailabilityProviders
                .getProvider(errorViewName, this.applicationContext);
        //若是模版引擎可用就让模版引擎进行解析如：Template/error/404
        if (provider != null) {
            return new ModelAndView(errorViewName, model);
        }
        //若是模版引擎不可用，就在静态资源文件夹下找资源文件,error/404
        return resolveResource(errorViewName, model);
    }

3.如何定制错误、异常响应

明白了boot处理异常机制，咱们如何自定义异常响应规则呢？

第一种：pc端返回静态错误页面，手机端返回boot默认的json数据

若是项目中有模板引擎（jsp,thmeleaf,freemarker）的状况下，能够将错误页面命名为状态码.html放在模板引擎文件夹下的error文件夹下，

发生异常，无论是前端请求仍是后端程序错误会来到对应的错误页面。能够将错误页面命名为4xx和5xx匹配全部的错误，

可是优先返回精确状态码.html页面；而且在模板引擎页面能够获取以下相关信息

这里模版引擎使用thmeleaf

4xx代码

<!DOCTYPE html>
<html lang="en">
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title th:text="'状态码:'+${status}"></title>
</head>
<body>
< img src="../images/404.jpg" style="width: 40%;">
<h1 th:text="'时间:'+${timestamp}"></h1>
<h1 th:text="'错误提示:'+${error}"></h1>
<h1 th:text="'异常对象:'+${exception}"></h1>
<h1 th:text="'异常信息:'+${message}"></h1>
</body>
</html>

5xx代码

<!DOCTYPE html>
<html lang="en">
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title th:text="'状态码:'+${status}"></title>
</head>
<body>
<h2>500</h2>
<h1 th:text="'时间:'+${timestamp}"></h1>
<h1 th:text="'错误提示:'+${error}"></h1>
<h1 th:text="'异常对象:'+${exception}"></h1>
<h1 th:text="'异常信息:'+${message}"></h1>
</body>
</html>

咱们请求一个错误的地址路径

咱们在程序代码中人为制造一个异常，请求响应

上面是有模版引擎的状况下处理错误以及异常的方式，

若是项目中没有模板引擎，（模板引擎找不到这个错误页面），静态资源文件夹static下找对应的4xx或者5xx或者更精确的错误页面。可是若是不用模板引擎，页面不能获取上面说的页面信息；

上面两种方式使用手机访问返回都是boot默认的json数据

第二种：pc端返回动态的页面，手机端返回动态json数据

上面第一种能够轻松的的处理异常，只需在指定的路径下放静态页面（无模版引擎的状况）或者携带相关信息的页面（有模版引擎），

缺点就是不能在页面携带咱们想要展现的数据，好比当咱们程序某处放生异常，咱们要返回咱们本身提示的错误信息。这种异常若是处理呢？

默认状况下，在 Spring Boot 中，全部的异常数据其实就是第一种所展现出来的 5几条数据，这些数据定义在 org.springframework.boot.web.reactive.error.DefaultErrorAttributes 类中，具体定义在 getErrorAttributes 方法中：核心代码以下

@Override
public Map<String, Object> getErrorAttributes(ServerRequest request,
                boolean includeStackTrace) {
        Map<String, Object> errorAttributes = new LinkedHashMap<>();
        errorAttributes.put("timestamp", new Date());
        errorAttributes.put("path", request.path());
        Throwable error = getError(request);
        HttpStatus errorStatus = determineHttpStatus(error);
        errorAttributes.put("status", errorStatus.value());
        errorAttributes.put("error", errorStatus.getReasonPhrase());
        errorAttributes.put("message", determineMessage(error));
        handleException(errorAttributes, determineException(error), includeStackTrace);
        return errorAttributes;
}

DefaultErrorAttributes 类自己则是在 org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration 异常自动配置类中定义的，

若是开发者没有本身提供一个 ErrorAttributes 的实例的话，那么 Spring Boot 将自动提供一个 ErrorAttributes 的实例，也就是 DefaultErrorAttributes 。

基于此，开发者自定义 ErrorAttributes 有两种方式实现自定义数据：

1.直接实现 ErrorAttributes 接口
2.继承 DefaultErrorAttributes（推荐），由于 DefaultErrorAttributes 中对异常数据的处理已经完成，开发者能够直接使用。

package com.javayihao.top.config;

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

import java.util.Map;

@Component
public class MyErrorAttributes  extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        if ((Integer)map.get("status") == 500) {
            //这里根据本身需求设置
            map.put("message", "服务器内部错误!");
        }
        if ((Integer)map.get("status") == 404) {
            map.put("message", "路径不存在!");
        }
        return map;
    }
}

咱们服务器访问错误路径

客户端响应

访问有异常的的控制器

客户端响应

固然上面我能够在程序任意位置抛出异常，使用全局异常处理器处理

自定义异常

全局异常处理器

@ControllerAdvice
public class MyExceptionHandler {
    @ExceptionHandler(MyException.class)
    public String jsonErrorHandler(HttpServletRequest request, Exception e) {
        Map<String, Object> map = new HashMap<>();
        request.setAttribute("java.servlet.error.status_code", 500);
        map.put("code", -1);
        map.put("msg", e.getMessage());
        request.setAttribute("ext", map);
        //转发到error
        return "forward:/error";
    }
}

自定义ErrorAttributes

@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    //返回的map就是页面或者json能获取的全部字段
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        //能够额外添加内容
        map.put("company", "javayihao");
        //取出异常处理器中的携带的数据
        Map<String, Object> ext = (Map<String, Object>) webRequest.getAttribute("ext", 0);//传入0表明从request中获取
        map.put("ext", ext);
        return map;
    }
}

第三种：pc端返回动态json数据，手机端也返回动态json数据

这种方式主要是针对先后端分离的项目，咱们自定义一个异常，在程序中用于抛出

定义一个返回结果对象（也能够不用定义，直接使用map）存储异常信息

定义一个全局异常处理器

/*ControllerAdvice用来配置须要进行异常处理的包和注解类型，
 好比@ControllerAdvice(annotations = RestController.class)
 只有类标有rescontrolle才会被拦截
 */
@ControllerAdvice
public class MyExceptionHandler {
    //本身建立的异常按照本身编写的信息返回便可
    @ExceptionHandler(value = MyException.class)
    @ResponseBody
    public ErrorInfo<String> errorInfo(HttpServletRequest req, MyException e) {
        ErrorInfo<String> r = new ErrorInfo<>();
        r.setCode(ErrorInfo.ERROR);
        r.setMessage(e.getMessage());
        r.setData("测试数据");
        r.setUrl(req.getRequestURL().toString());
        return r;
    }
    //系统异常时返回的异常编号为 -1 ，返回的异常信息为 “系统正在维护”；不能将原始的异常信息返回
    @ExceptionHandler(value = Exception.class)
    @ResponseBody
    public ErrorInfo<String> errorInfo(HttpServletRequest req, Exception e) {
        ErrorInfo<String> r = new ErrorInfo<>();
        r.setCode(ErrorInfo.ERROR);
        r.setMessage("系统维护中");
        return r;
    }
}