SpringBoot 統一異常處理(附核心工具類-ErrorInfoBuilder)

時間  2019-11-07
標籤 springboot 統一 異常 處理 核心 工具 errorinfobuilder 欄目 Spring 简体版
原文   原文鏈接

序言：此前，咱們主要經過在控制層（Controller）中手動捕捉異常（TryCatch）和處理錯誤，在SpringBoot 統一異常處理的作法主要有兩種：一是基於註解ExceptionHandler，二是基於接口php

ErrorController，二者均可以讓控制器層代碼快速「瘦身」，讓業務邏輯看起來更加清晰明朗！ html

一. 默認錯誤處理

SpringBoot 默認爲咱們提供了BasicErrorController 來處理全局錯誤/異常，並在Servlet容器中註冊error爲全局錯誤頁。因此在瀏覽器端訪問，發生錯誤時，咱們能及時看到錯誤/異常信息和HTTP狀態等反饋。工做原理以下：java

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
    // 統一異常處理（View）
    @RequestMapping(produces = "text/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);
    }

複製代碼

例以下面這兩個錯誤，對於平常開發而言，再熟悉不過了。web

404 Not Found
500 服務器錯誤

二. 統一異常處理（具體步驟）

默認的英文空白頁，顯然不可以知足咱們複雜多變的需求，所以咱們能夠經過專門的類來收集和管理這些異常信息，這樣作不只能夠減小控制層的代碼量，還有利於線上故障排查和緊急短信通知等。spring

具體步驟apache

爲了讓小夥伴少走一些彎路，樓主根據官方源碼和具體實踐，提煉這些核心工具類：瀏覽器

  • ErrorInfo 錯誤信息
  • ErrorInfoBuilder 錯誤信息的構建工具

注：在CSDN和大牛博客中，不乏關於Web應用的統一異常處理的教程，但更多的是基礎學習使用，並不能投入實際項目使用，爲了讓你們少走一些彎路和快速投入生產，樓主根據官方源碼和項目實踐，提煉出了核心工具類（ErrorInfoBuilder ），將構建異常信息的邏輯從異常處理器/控制器中抽離出來，讓你們經過短短几行代碼就能獲取豐富的異常信息，更專一於業務開發！！springboot

1. 統一異常處理器(GlobalErrorHandler)

  • @ControllerAdvice 限定範圍 例如掃描某個控制層的包服務器

  • @ExceptionHandler 指定異常 例如指定處理運行異常。mvc

    具體以下：

package com.hehe.error;

@ControllerAdvice
public class GlobalErrorHandler {

    private final static String DEFAULT_ERROR_VIEW = "error";//錯誤信息頁

    @Autowired
    private ErrorInfoBuilder errorInfoBuilder;//錯誤信息的構建工具

    /** * 根據業務規則,統一處理異常。 */
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Object exceptionHandler(HttpServletRequest request, Throwable error) {

        //1.若爲AJAX請求,則返回異常信息(JSON)
        if (isAjaxRequest(request)) {
           return errorInfoBuilder.getErrorInfo(request,error);
        }
        //2.其他請求,則返回指定的異常信息頁(View).
        return new ModelAndView(DEFAULT_ERROR_VIEW, "errorInfo", errorInfoBuilder.getErrorInfo(request, error));
    }

    private boolean isAjaxRequest(HttpServletRequest request) {

        return "XMLHttpRequest".equals(request.getHeader("X-Requested-With"));
    }

}複製代碼

2. 統一異常信息（ErrorInfo）

雖然官方提供了ErrorAttributes來存儲錯誤信息，但其返回的是存儲結構是Map<String,Object>，爲了更好的服務統一異常，這裏咱們統一採用標準的ErrroInfo來記載錯誤信息。

package com.hehe.error;

public class ErrorInfo {

    private String time;//發生時間
    private String url;//訪問Url
    private String error;//錯誤類型
    String stackTrace;//錯誤的堆棧軌跡
    private int statusCode;//狀態碼
    private String reasonPhrase;//狀態碼

    //Getters And Setters
       ...
  
}複製代碼

3. 統一異常信息的構建工具（ErrorInfoBuilder）

ErrorInfoBuilder 做爲核心工具類，其意義不言而喻，重點API：

  • 獲取錯誤/異常

  • 通訊狀態

  • 堆棧軌跡

注：正確使用ErrorInfoBuilder，可讓處理器減小80%的代碼。總而言之，ErrorInfoBuilder是個好東西，值得你們細細琢磨。

package com.hehe.error;

@Order(Ordered.HIGHEST_PRECEDENCE)
@Component
public class ErrorInfoBuilder implements HandlerExceptionResolver, Ordered {

    /** * 錯誤KEY */
    private final static String ERROR_NAME = "hehe.error";

    /** * 錯誤配置(ErrorConfiguration) */
    private ErrorProperties errorProperties;

    public ErrorProperties getErrorProperties() {
        return errorProperties;
    }

    public void setErrorProperties(ErrorProperties errorProperties) {
        this.errorProperties = errorProperties;
    }

    /** * 錯誤構造器 (Constructor) 傳遞配置屬性：server.xx -> server.error.xx */
    public ErrorInfoBuilder(ServerProperties serverProperties) {
        this.errorProperties = serverProperties.getError();
    }

    /** * 構建錯誤信息.(ErrorInfo) */
    public ErrorInfo getErrorInfo(HttpServletRequest request) {

        return getErrorInfo(request, getError(request));
    }

    /** * 構建錯誤信息.(ErrorInfo) */
    public ErrorInfo getErrorInfo(HttpServletRequest request, Throwable error) {
        ErrorInfo errorInfo = new ErrorInfo();
        errorInfo.setTime(LocalDateTime.now().toString());
        errorInfo.setUrl(request.getRequestURL().toString());
        errorInfo.setError(error.toString());
        errorInfo.setStatusCode(getHttpStatus(request).value());
        errorInfo.setReasonPhrase(getHttpStatus(request).getReasonPhrase());
        errorInfo.setStackTrace(getStackTraceInfo(error, isIncludeStackTrace(request)));
        return errorInfo;
    }

    /** * 獲取錯誤.(Error/Exception) * * @see DefaultErrorAttributes #addErrorDetails */
    public Throwable getError(HttpServletRequest request) {
        //根據HandlerExceptionResolver接口方法來獲取錯誤.
        Throwable error = (Throwable) request.getAttribute(ERROR_NAME);
        //根據Request對象獲取錯誤.
        if (error == null) {
            error = (Throwable) request.getAttribute(WebUtils.ERROR_EXCEPTION_ATTRIBUTE);
        }
        //當獲取錯誤非空,取出RootCause.
        if (error != null) {
            while (error instanceof ServletException && error.getCause() != null) {
                error = error.getCause();
            }
        }//當獲取錯誤爲null,此時咱們設置錯誤信息便可.
        else {
            String message = (String) request.getAttribute(WebUtils.ERROR_MESSAGE_ATTRIBUTE);
            if (StringUtils.isEmpty(message)) {
                HttpStatus status = getHttpStatus(request);
                message = "Unknown Exception But " + status.value() + " " + status.getReasonPhrase();
            }
            error = new Exception(message);
        }
        return error;
    }

    /** * 獲取通訊狀態(HttpStatus) * * @see AbstractErrorController #getStatus */
    public HttpStatus getHttpStatus(HttpServletRequest request) {
        Integer statusCode = (Integer) request.getAttribute(WebUtils.ERROR_STATUS_CODE_ATTRIBUTE);
        try {
            return statusCode != null ? HttpStatus.valueOf(statusCode) : HttpStatus.INTERNAL_SERVER_ERROR;
        } catch (Exception ex) {
            return HttpStatus.INTERNAL_SERVER_ERROR;
        }
    }

    /** * 獲取堆棧軌跡(StackTrace) * * @see DefaultErrorAttributes #addStackTrace */
    public String getStackTraceInfo(Throwable error, boolean flag) {
        if (!flag) {
            return "omitted";
        }
        StringWriter stackTrace = new StringWriter();
        error.printStackTrace(new PrintWriter(stackTrace));
        stackTrace.flush();
        return stackTrace.toString();
    }

    /** * 判斷是否包含堆棧軌跡.(isIncludeStackTrace) * * @see BasicErrorController #isIncludeStackTrace */
    public boolean isIncludeStackTrace(HttpServletRequest request) {

        //讀取錯誤配置(server.error.include-stacktrace=NEVER)
        IncludeStacktrace includeStacktrace = errorProperties.getIncludeStacktrace();

        //狀況1：若IncludeStacktrace爲ALWAYS
        if (includeStacktrace == IncludeStacktrace.ALWAYS) {
            return true;
        }
        //狀況2：若請求參數含有trace
        if (includeStacktrace == IncludeStacktrace.ON_TRACE_PARAM) {
            String parameter = request.getParameter("trace");
            return parameter != null && !"false".equals(parameter.toLowerCase());
        }
        //狀況3：其它狀況
        return false;
    }

    /** * 保存錯誤/異常. * * @see DispatcherServlet #processHandlerException 進行選舉HandlerExceptionResolver */
    @Override
    public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, @Nullable Object handler, Exception ex) {
        request.setAttribute(ERROR_NAME, ex);
        return null;
    }

    /** * 提供優先級 或用於排序 */
    @Override
    public int getOrder() {
        return Ordered.HIGHEST_PRECEDENCE;
    }
}
複製代碼

注：ErrorBuilder之因此使用@Order註解和實現HandlerExceptionResolver接口是爲了獲取錯誤/異常，一般狀況下@ExceptionHandler並不須要這麼作，由於在映射方法注入Throwable就能夠得到錯誤/異常，這是主要是爲了ErrorController根據Request對象快速獲取錯誤/異常。

4. 控制層代碼（Controller）

上述，錯誤/異常處理器、錯誤信息、錯誤信息構建工具所有完成，咱們編寫控制層代碼來測試相關效果。

package com.hehe;

@SpringBootApplication
@RestController
public class ErrorHandlerApplication {
    /** * 隨機拋出異常 */
    private void randomException() throws Exception {
        Exception[] exceptions = { //異常集合
                new NullPointerException(),
                new ArrayIndexOutOfBoundsException(),
                new NumberFormatException(),
                new SQLException()};
        //發生機率
        double probability = 0.75;
        if (Math.random() < probability) {
            //狀況1：要麼拋出異常
            throw exceptions[(int) (Math.random() * exceptions.length)];
        } else {
            //狀況2：要麼繼續運行
        }

    }

    /** * 模擬用戶數據訪問 */
    @GetMapping("/")
    public List index() throws Exception {
        randomException();
        return Arrays.asList("正經常使用戶數據1!", "正經常使用戶數據2! 請按F5刷新!!");
    }

    public static void main(String[] args) {
        SpringApplication.run(ErrorHandlerApplication.class, args);
    }
}複製代碼

5. 頁面代碼（Thymeleaf）

代碼完成以後，咱們須要編寫一個異常信息頁面。爲了方便演示，咱們在resources目錄下建立templates目錄，並新建文件exception.html。頁面代碼以下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
    <title>GlobalError</title>
</head>
<div th:object="${errorInfo}">
    <h3 th:text="*{'訪問地址：'+url}"></h3>
    <h3 th:text="*{'問題類型：'+error}"></h3>
    <h3 th:text="*{'通訊狀態：'+statusCode+','+reasonPhrase}"></h3>
    <h3 th:text="*{'堆棧信息：'+stackTrace}"></h3>
</div>
</body>
</html>
複製代碼

注：SpringBoot默認支持不少種模板引擎（如Thymeleaf、FreeMarker），並提供了相應的自動配置，作到開箱即用。默認的頁面加載路徑是 src/main/resources/templates ，若是放到其它目錄需在配置文件指定。（舉例：spring.thymeleaf.prefix=classpath:/views/ ）

6. 引入依賴（POM文件）

之前操做以前，不要忘了在pom.xml 引入相關依賴：

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!--基本信息 -->
    <groupId>com.hehe</groupId>
    <artifactId>springboot-error-handler</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>
    <name>spring-boot-error-handler</name>
    <description>SpringBoot 統一異常處理</description>

    <!--繼承信息 -->
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.0.M4</version>
        <relativePath/>
    </parent>

    <!--依賴管理 -->
    <dependencies>
        <dependency> <!--添加Web依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency> <!--添加Thymeleaf依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>
        <dependency><!--添加Test依賴 -->
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <!--指定遠程倉庫（含插件）-->
    <repositories>
        <repository>
            <id>spring-snapshots</id>
            <url>http://repo.spring.io/snapshot</url>
            <snapshots>
                <enabled>true</enabled>
            </snapshots>
        </repository>
        <repository>
            <id>spring-milestones</id>
            <url>http://repo.spring.io/milestone</url>
        </repository>
    </repositories>
    <pluginRepositories>
        <pluginRepository>
            <id>spring-snapshots</id>
            <url>http://repo.spring.io/snapshot</url>
        </pluginRepository>
        <pluginRepository>
            <id>spring-milestones</id>
            <url>http://repo.spring.io/milestone</url>
        </pluginRepository>
    </pluginRepositories>

    <!--構建插件 -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>複製代碼

7. 開始測試

上述步驟完成以後，打開啓動類GlobalExceptionApplication，啓動項目而後進行測試。本案例-項目結構圖以下：

測試效果：在瀏覽器輸入 http://localhost:8080 屢次按F5刷新，而後查看頁面效果。截圖以下：


三. 使用@ExceptionHandler的不足之處

關於實現Web應用統一異常處理的兩種方法比較：

特性 @ExceptionHandler ErrorController
獲取異常 經過方法參數注入 經過ErrorInfoBuilder獲取
返回類型 若請求的類型爲Ajax則返回JSON，不然返回頁面. 若請求的媒介類型爲HTML 則返回頁面 ，不然返回JSON.
缺點 沒法處理404類異常 很強大，可處理所有錯誤/異常

1. 使用@ExceptionHandler 爲何沒法處理404錯誤/異常？

  • 答：由於SpringMVC優先處理（Try Catch）掉了資源映射不存在的404類錯誤/異常，雖然在響應信息注入了404的HttpStatus通訊信息，但木有了異常，確定不會進入@ExceptionHandler 的處理邏輯。

2. 使用@ExceptionHandler + 拋出異常 是否可取？

  • 答：由上圖可知@ExceptionHanlder的最大不足之處是沒法直接捕獲404背後的異常，網上流傳經過取消資源目錄映射來解決無404問題是不可取的，屬於越俎代庖的作法。
spring.mvc.throw-exception-if-no-handler-found=true
spring.resources.add-mappings=false
複製代碼

3. 爲何推薦ErrorController 替代 @ExceptionHandler ?

  • 使用ErrorController能夠處理 所有錯誤/異常 。
  • 使用ErrorController+ErrorInfoBuilder 在單個方法裏面能夠針對不一樣的Exception來添加詳細的錯誤信息，具體作法：拓展ErrorInfoBuilder的getErrorInfo方法來添加錯誤信息（例如：ex instanceof NullPointerException Set xxx）。

注意：實際上，目前SpringBoot官方就是經過ErrorController來作的統一錯誤/異常處理，但遺憾的是，關於這方面的官方文檔並無給出詳細示例，僅僅是一筆帶過，大概官方認爲@ExceptionHandler 夠用？？而網上也甚少人具體說起ErrorController和ErrorAttribute 背後一整套的實現邏輯，也正是如此，促使樓主決心寫下這篇文章，但願給你們帶來幫助，少走一些彎路！！

四. 使用ErrorController替代@ExceptionHandler

如何快速使用 ErrorController ？

回答：通過樓主的精心設計，ErrorInfoBuilder 能夠無縫對接ErrorController （即上述兩種錯誤/異常處理均共用此工具類），你只須要作的是：將本案例的ErrorInfo和ErrorInfoBuilder 拷貝進項目，簡單編寫ErrorController 跳轉頁面和返回JSON便可。具體以下：

  • @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
    說明：produces屬性做爲匹配規則：表示Request請求的Accept頭部需含有text/html。
    用途：text/html 主要用於響應普通的頁面請求，與AJAX請求做爲區分。
package com.hehe.error;

@Controller
@RequestMapping("${server.error.path:/error}")
public class GlobalErrorController implements ErrorController {
    
@Autowired
    private ErrorInfoBuilder errorInfoBuilder;//錯誤信息的構建工具.

    private final static String DEFAULT_ERROR_VIEW = "error";//錯誤信息頁

    /** * 狀況1：若預期返回類型爲text/html,則返回錯誤信息頁(View). */
    @RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
    public ModelAndView errorHtml(HttpServletRequest request) {
        return new ModelAndView(DEFAULT_ERROR_VIEW, "errorInfo", errorInfoBuilder.getErrorInfo(request));
    }

    /** * 狀況2：其它預期類型 則返回詳細的錯誤信息(JSON). */
    @RequestMapping
    @ResponseBody
    public ErrorInfo error(HttpServletRequest request) {
        return errorInfoBuilder.getErrorInfo(request);
    }

    @Override
    public String getErrorPath() {//獲取映射路徑
        return errorInfoBuilder.getErrorProperties().getPath();
    }
}
複製代碼

注：是否是很是簡單，相信這個工具類能夠改變你對ErrorController複雜難用的見解。若是後續想拓展不一樣種類的錯誤/異常信息，只需修改ErrorInfoBuilder#getError方法便可，無需修改ErrorController的代碼，十分方便。

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程