設計一個全局異常處理器

前言

最近稍微閒了一點因而把這個半年都沒更新的開源項目 cicada 從新撿了起來。

一些新關注的朋友應該還不知道這項目是幹啥的？先來看看官方介紹吧（其實就我本身寫的😀）

cicada: 基於 Netty4 實現的快速、輕量級 WEB 框架；沒有過多的依賴，核心 jar 包僅 30KB。

針對這個輪子之前也寫過相關的介紹，感興趣的能夠再翻回去看看：

• 「造個輪子」——cicada(輕量級 WEB 框架)
• 「造個輪子」——cicada 源碼分析
• 「造個輪子」——cicada 設計一個配置模塊
• 「造個輪子」——cicada 設計全局上下文
• 利用責任鏈模式設計一個攔截器
• 設計一個可拔插的 IOC 容器

這些都看完了相信對這個小玩意應該會有更多的想法。

效果

廣告打完了，回到正題；你們平時最經常使用的 MVC 框架當屬 SpringMVC 了，而在搭建腳手架的時候相信全局異常處理是必不可少的。

Spring 用法

一般咱們的作法以下：

傳統 Spring 版本：

• 實現一個 Spring 自帶的接口，重寫其中的方法，最後的異常處理便在此處。
• 將這個類配置在 Spring 的 xml ，當作一個 bean 註冊到 Spring 容器中。

public class CustomExceptionResolver implements HandlerExceptionResolver {

    @Override
    public ModelAndView resolveException(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception ex) {
    //自定義處理
}

<bean class="ssm.exception.CustomExceptionResolver"></bean>

---

固然如今流行的 SpringBoot 也有對應的簡化版本：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(value = Exception.class)
    public Object defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        //自定義處理
    }
}

所有都換爲註解形式，但本質上仍是同樣的。

都是要在容器中建立一個特殊的 bean，這個 bean 專門用於處理異常，當系統運行時出現異常，就從容器中找到該 bean，並執行其中的方法便可。

至於這個特殊的 bean 如何標識出來，無非就是實現某個特定接口或者用註解聲明，也就對應了傳統 Spring 和 SpringBoot 的用法。

cicada 用法

cicada 在設計本身的全局異常處理器時也參考了 Spring 的相關設計，因此最終用法以下：

@CicadaBean
public class ExceptionHandle implements GlobalHandelException {
    private final static Logger LOGGER = LoggerBuilder.getLogger(ExceptionHandle.class);

    @Override
    public void resolveException(CicadaContext context, Exception e) {
        LOGGER.error("Exception", e);
        WorkRes workRes = new WorkRes();
        workRes.setCode("500");
        workRes.setMessage(e.getClass().getName() + "系統運行出現異常");
        context.json(workRes);
    }
}

自定義一個實現了 GlobalHandelException 接口的類，當請求出現異常時，頁面和後臺將會以下輸出：

設計

看得出用法和 Spring 很是相似，也是須要實現一個接口 GlobalHandelException，同時使用 @CicadaBean 註解該類將他加載到 cicada 內置的 IOC 容器內。

當出現異常時則在這個 IOC 容器中找到該對象調用它的 resolveException 便可。

其中還能夠經過 CicadaContext 全局上下文響應不一樣的輸出（json/text/html）。

核心原理

簡單畫了下流程圖，步驟以下：

• 初始化時會找到實現了 GlobalHandelException 接口的類，將它實例化並註冊到 IOC 容器中。
• 當發生異常時從容器中獲取到異常處理器的對象，執行其中的處理函數便可。

說了半天原理來看看源碼是如何實現的。

在初始化 bean 時，若是是一個異常處理器則會將他單獨存放（也就至關於前文說的打標識）。

其中的 GlobalHandelException 自己的定義也很是簡單：

---

接下來是運行時：

而當出現異常時則會經過以前的保存的異常處理 bean 進行異常處理，在調用的同時將全局上下文及異常信息傳遞過去就齊活了。

這樣就能夠在這個實現類中實現咱們本身的異常處理邏輯了。

總結

萬一從此面試官問大家 SpringMVC 的異常處理是如何實現的？你該知道怎麼回答了吧😏。

同時也能夠發散一下，是否能夠配置一個針對於某一個 controller 的異常處理，這樣每一個 controller 產生的異常能夠單獨處理，若是沒有配置則進入全局異常；原理也差很少，感興趣的朋友能夠提個 PR 完成該 feature。

項目源碼：

https://github.com/TogetherOS/cicada

你的點贊與分享是對我最大的支持