Spring Cloud中異常處理的套路

来源:https://www.cnblogs.com/java-jiawa/archive/2018/08/03/9416626.html
-Advertisement-
Play Games

異常在Java中有兩種分類:Error(OutOfMemoryError之類的我們自己程式無法處理的非常嚴重的錯誤,Java推薦不catch,讓程式隨之崩潰)、Excepiton(NullPointerException之類的並不致命的錯誤,Java覺得indicates conditions th ...


異常在Java中有兩種分類:Error(OutOfMemoryError之類的我們自己程式無法處理的非常嚴重的錯誤,Java推薦不catch,讓程式隨之崩潰)、Excepiton(NullPointerException之類的並不致命的錯誤,Java覺得indicates conditions that a reasonable application might want to catch,推薦catch),本文以下內容涉及到的都是Exception。

本文會結合REST API與Spring的一些具體實踐來探討一下異常處理的套路。

異常與異常處理機制的意義

關於異常是拿來乾什麼的,很多人老程式員認為就是拿來我們Debug的時候排錯的,當然這一點確實是異常機制非常大的一個好處,但異常機制包含著更多的意義。

  • 關註業務實現。異常機制使得業務代碼與異常處理代碼可以分開,你可以將一些你調用資料庫操作的代碼寫在一個方法里而只需要在方法上加上throw DB相關的異常。至於如何處理它,你可以在調用該方法的時候處理或者甚至選擇不處理,而不是直接在該方法內部添加上if判斷如果資料庫操作錯誤該如何辦,這樣業務代碼會非常混亂。
  • 統一異常處理。與上一點有所聯繫。我當前所在項目的實踐是,自定義業務類異常,在Controller或Service中拋出,讓後使用Spring提供的異常介面統一處理我們自己在內部拋出的異常。這樣一個異常處理架構就非常明瞭。
  • 程式的健壯性。如果沒有異常機制,那麼來了個對空對象的某方法調用怎麼辦呢?直接讓程式掛掉?這令人無法接受,當然,我們自己平時寫的一些小的東西確實是這樣,沒有處理它,讓後程式掛了。但在web框架中,可以利用異常處理機制捕獲該異常並將錯誤信息傳遞給我們然後繼續處理下個請求。所以異常對於健壯性是非常有幫助的。

異常處理(又稱為錯誤處理)功能提供了處理程式運行時出現的任何意外或異常情況的方法。異常處理使用 try、catch 和 finally 關鍵字來嘗試可能未成功的操作,處理失敗,以及在事後清理資源。

先分類(dian cai)吧

我把異常根據意義成三種:業務、系統、代碼異常,不同的異常採用不同的處理方式。

業務異常

1
2
3
4
5
6
7
8
9
@GetMapping("/{id}")
public ReservationDetail getDetail(@PathVariable String id) {
    ReservationDetail result = applicationService.getReservationDetail(id);
    if (result == null) {
        throw new InfoNotFoundExcepiton("reservation with id=" + id + " is not exist");
    }

    return result;
}

以上代碼當沒有查到數據的時候拋出一個InfoNotFoundExcepiton異常,查詢一個信息但不存在,沒有任何系統級別的錯誤發生,而是數據確實不存在,此時屬於業務異常。這個例子比較局限,其他的場景可能有一個用戶想訪問某個API,但是沒有許可權,此時可以返回無許可權的業務異常。

將所有業務異常拋出,並通過Spring提供的介面進行統一處理,要註意的是,返回碼也是需要分別標示的,對於意義不同的業務異常,對應的錯誤返回碼也是需要被指定的:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
@RestControllerAdvice
public class ControllerAdvice {

    private static final Logger logger = LoggerFactory.getLogger(ControllerAdvice.class);

    @ExceptionHandler(Throwable.class)
    @ResponseStatus(HttpStatus.INTERNAL_SERVER_ERROR)
    public ErrorResult handleOtherException(Throwable e) {
        RestControllerAdvice
        return new ErrorResult(ErrorCode.UNKNOWN, e.getMessage());
    }

    @ExceptionHandler(ResourceAccessException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ErrorResult handleResourceNotFoundException(ResourceAccessException e) {
        logger.error(e.getMessage(), e);
        return new ErrorResult(ErrorCode.RESOURCE_NOT_FOUND, e.getMessage());
    }

}

這種異常處理方式個人認為在我們代碼中越多越好,如果能在代碼中涵蓋業務中的很多邊界值,對於整體應用的健壯性提升有著非常大的幫助,並且對於前端來說,前端可以根據此異常信息給予用戶更加明確友好的錯誤提示

1
2
3
4
5
攜帶錯誤碼為500的錯誤請求{
    "message": "cannot find pre inspection base info by order id: 1",
    "error_code": "SERVICE_REQUEST_ERROR"
}

系統異常

這種異常在調試時非常常見,要麼是某個服務掛掉了,或者超時這樣的情況,跟業務沒有關係,也不是代碼中的BUG導致的,這個時候我們必須設計好一個預案去cover這種風險。

在微服務架構中,這種情況時有發生,如在我翻譯過的這篇文章中提到的,使用Netflix Hystrix解決,在Spring Cloud中已經攜帶該模塊。具體如下:

  • 網路超時 - 不會無限期等待並使用超時策略。這可以確定資源不會被無限期被捆綁在一起
  • 限制未完成的請求的數量 - 對於客戶端可以使用特定服務的未完成請求數量強加一個上限。如果到達限制,提出額外的請求可能沒有意義,這些嘗試需要立即失敗。
  • 使用斷路器模式 - 跟蹤成功和失敗的數量。如果錯誤率超過預定的閾值,斷路器跳閘,以便以後的嘗試失敗。如果很多請求失敗,建議服務設為不可用,發請求也是沒有意義的。但超時之後,客戶端應該再次嘗試,如果成功,關閉斷路器。
  • 提供備用邏輯 - 當請求失敗後執行備用邏輯。比如返回緩存數據或者預設值比如空的推薦。

那麼問題來了,這些異常可以與其他異常分類統一格式返回給前端嗎?

1
@ExceptionHandler(Throwable.class)

這行代碼捕捉了所有的異常,包括Error級別的,這是根據特定項目需求來確定的,所以即使是Error也需要記錄下來,出錯之後方便錯誤的排查。

代碼異常

我把代碼中存在的BUG叫做代碼異常,與系統異常不同的是,這種異常只能儘量避免與預防。比如程式員沒有考慮到的情況導致空指針異常、SQL語句編寫錯誤導致SQLException。線上上環境是非常嚴重的錯誤,需要立馬開hotfix分支去修的,因為沒有編寫對應的業務處理方式,最嚴重的後果可能導致某個用戶扣了錢但是沒有顯示支付成功。

和系統異常一樣,這些異常由於是Throwable異常類下的異常,所以會被返回給前端。

異常處理流程與規範

異常處理流程在微服務架構中可能會比直接向前端發送異常信息這個過程麻煩一些,如Service向BFF層級傳遞異常一級。

異常在服務之間的傳遞

API Gateway (with Zuul) => BFF => 某服務

由於BFF與服務之間是通過Feign連接,所以我們需要自己統一一下錯誤格式成為業務相關的格式返回給前端而不是直接將細化某個Java異常類的全部異常信息交給前端。

在這張圖中,在BFF中檢測參數是否匹配,在Service中檢測是否資源存在,如果在BFF中拋出異常,則將INVALID_PARAMETER異常返回給前端,如果在Service中拋出異常,則將SERVICE_REQUEST_ERROR返回給前端。也就是將異常做出簡單的分類:業務異常、非業務異常,非業務異常中可以像上面分類一樣繼續分類。

約定返回格式

前後端統一錯誤格式,需要規定如下:

  • 返回格式:JSON
  • 返回請求狀態碼:根據不同請求對應的狀態碼意義返回
  • 返回具體格式如下
1
2
3
4
{
   "message": "reservation details doesn't exist with id: xxx",
   "errorCode": "SERVICE_REQUEST_ERROR",
}

您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 工廠方法 定義一個用於創建對象的介面,讓子類決定實例化哪一個類。FactoryMethod使一個類的實例化延遲到其子類。 定義一個用於創建對象的介面,讓子類決定實例化哪一個類。FactoryMethod使一個類的實例化延遲到其子類。 適用性 1.當一個類不知道它所必須創建的對象的類的時候。 2.當一 ...
  • 判斷一個整數是否是迴文數。迴文數是指正序(從左向右)和倒序(從右向左)讀都是一樣的整數。 示例 1: 示例 2: 示例 3: 進階: 你能不將整數轉為字元串來解決這個問題嗎? ...
  • 經過大半年的工作的經歷,我覺得作為一個IT工作者,學習一門編程語言是非常有必要的,所以還是撿起最初的夢想,開始吧Today!!! 本人小白,給個機會,多多關照。不喜勿噴,謝謝! 第一個程式:Hello word ! 附代碼: 執行方式: 1. MDdos中執行:python c:/pycc/Hell ...
  • 生成器 我們調用一個普通的Python函數時,一般是從函數的第一行代碼開始執行,結束於return語句、異常或者函數結束(可以看作隱式的返回None)。一旦函數將控制權交還給調用者,就意味著全部結束。函數中做的所有工作以及保存在局部變數中的數據都將丟失。再次調用這個函數時,一切都將從頭創建。 對於在 ...
  • [TOC] 程式安裝 首先,我們需要在本機下載安裝 "Visual Studio Installer" ,然後通過它來進行相應 Python 組件安裝,如下圖所示 這裡需要註意一點是,由於一些圖像化的 Package 是通過 來進行實現的,所以建議讀者安裝 Python本機開發工具 ,要不然到時候有 ...
  • 自從學習Java開始一直使用的是jdk1.8,聽同事說版本不符要報錯出什麼52的錯誤 周末測試一下。java.lang.UnsupportedClassVersionError Unsupported major.minor version 52.0 出現這個錯誤是編譯時使用的版本高於運行時的版本。 ...
  • 6.1.爬取第一頁的職位信息 第一頁職位信息 6.2.爬取所有頁的職位信息 ...
  • DDOS攻擊的一些基礎知識點在這裡就不再贅述,由於Server端要控制client,所以這裡需要使用argparse,在這裡我們先規定好命令格式:#-H XXX.XXX.XXX.XXX -p xxxx -c<start|stop> -H後面接的是被攻擊主機的IP地址。 -p指定被攻擊的埠號。 -c ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...