Spring Cloud Gateway中異常處理

来源:https://www.cnblogs.com/viaiu/archive/2019/02/19/10403557.html
-Advertisement-
Play Games

最近我們的項目在考慮使用Gateway,考慮使用Spring Cloud Gateway,發現網關的異常處理和spring boot 單體應用異常處理還是有很大區別的。讓我們來回顧一下異常。 ...


 最近我們的項目在考慮使用Gateway,考慮使用Spring Cloud Gateway,發現網關的異常處理和spring boot 單體應用異常處理還是有很大區別的。讓我們來回顧一下異常。

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

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

異常處理(又稱為錯誤處理)功能提供了處理程式運行時出現的任何意外或異常情況的方法。異常處理使用 try、catch 和 finally 關鍵字來嘗試可能未成功的操作,處理失敗,以及在事後清理資源。異常根據意義成三種:業務、系統、代碼異常,不同的異常採用不同的處理方式。具體的什麼樣的異常怎麼處理就不說了。

紅線和綠線代表兩條異常路徑

1,紅線代表:請求到Gateway發生異常,可能由於後端app在啟動或者是沒啟動

2,綠線代表:請求到Gateway轉發到後端app,後端app發生異常,然後Gateway轉發後端異常到前端

紅線肯定是走Gateway自定義異常:

兩個類的代碼如下(參考:http://cxytiandi.com/blog/detail/20548):

 1 @Configuration
 2 @EnableConfigurationProperties({ServerProperties.class, ResourceProperties.class})
 3 public class ExceptionHandlerConfiguration {
 4 
 5     private final ServerProperties serverProperties;
 6 
 7     private final ApplicationContext applicationContext;
 8 
 9     private final ResourceProperties resourceProperties;
10 
11     private final List<ViewResolver> viewResolvers;
12 
13     private final ServerCodecConfigurer serverCodecConfigurer;
14 
15     public ExceptionHandlerConfiguration(ServerProperties serverProperties,
16                                          ResourceProperties resourceProperties,
17                                          ObjectProvider<List<ViewResolver>> viewResolversProvider,
18                                          ServerCodecConfigurer serverCodecConfigurer,
19                                          ApplicationContext applicationContext) {
20         this.serverProperties = serverProperties;
21         this.applicationContext = applicationContext;
22         this.resourceProperties = resourceProperties;
23         this.viewResolvers = viewResolversProvider.getIfAvailable(Collections::emptyList);
24         this.serverCodecConfigurer = serverCodecConfigurer;
25     }
26 
27     @Bean
28     @Order(Ordered.HIGHEST_PRECEDENCE)
29     public ErrorWebExceptionHandler errorWebExceptionHandler(ErrorAttributes errorAttributes) {
30         JsonExceptionHandler exceptionHandler = new JsonExceptionHandler(
31                 errorAttributes,
32                 this.resourceProperties,
33                 this.serverProperties.getError(),
34                 this.applicationContext);
35         exceptionHandler.setViewResolvers(this.viewResolvers);
36         exceptionHandler.setMessageWriters(this.serverCodecConfigurer.getWriters());
37         exceptionHandler.setMessageReaders(this.serverCodecConfigurer.getReaders());
38         return exceptionHandler;
39     }
 1 public class JsonExceptionHandler extends DefaultErrorWebExceptionHandler {
 2 
 3     private static Logger logger = LoggerFactory.getLogger(JsonExceptionHandler.class);
 4 
 5     public JsonExceptionHandler(ErrorAttributes errorAttributes, ResourceProperties resourceProperties,
 6                                 ErrorProperties errorProperties, ApplicationContext applicationContext) {
 7         super(errorAttributes, resourceProperties, errorProperties, applicationContext);
 8     }
 9 
10         /**
11          * 獲取異常屬性
12          */
13         @Override
14         protected Map<String, Object> getErrorAttributes(ServerRequest request, boolean includeStackTrace) {
15             int code = HttpStatus.INTERNAL_SERVER_ERROR.value();
16             Throwable error = super.getError(request);
17             if (error instanceof org.springframework.cloud.gateway.support.NotFoundException) {
18                 code = HttpStatus.NOT_FOUND.value();
19             }
20             return response(code, this.buildMessage(request, error));
21         }
22 
23         /**
24          * 指定響應處理方法為JSON處理的方法
25          * @param errorAttributes
26          */
27         @Override
28         protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {
29             return RouterFunctions.route(RequestPredicates.all(), this::renderErrorResponse);
30         }
31 
32 
33         /**
34          * 根據code獲取對應的HttpStatus
35          * @param errorAttributes
36          */
37         @Override
38         protected HttpStatus getHttpStatus(Map<String, Object> errorAttributes) {
39             int statusCode = (int) errorAttributes.get("code");
40             return HttpStatus.valueOf(statusCode);
41         }
42 
43         /**
44          * 構建異常信息
45          * @param request
46          * @param ex
47          * @return
48          */
49         private String buildMessage(ServerRequest request, Throwable ex) {
50             StringBuilder message = new StringBuilder("Failed to handle request [");
51             message.append(request.methodName());
52             message.append(" ");
53             message.append(request.uri());
54             message.append("]");
55             if (ex != null) {
56                 message.append(": ");
57                 message.append(ex.getMessage());
58             }
59             return message.toString();
60         }
61 
62         /**
63          * 構建返回的JSON數據格式
64          * @param status        狀態碼
65          * @param errorMessage  異常信息
66          * @return
67          */
68         public static Map<String, Object> response(int status, String errorMessage) {
69             Map<String, Object> map = new HashMap<>();
70             map.put("code", status);
71             map.put("message", errorMessage);
72             map.put("data", null);
73             logger.error(map.toString());
74             return map;
75         }
76     }

綠線代表Gateway轉發異常

轉發的異常,肯定是springboot單體中處理的,至於spring單體中的異常是怎麼處理的呢?肯定是用@ControllerAdvice去做。

1     @ExceptionHandler(value = Exception.class)
2     @ResponseBody
3     public AppResponse exceptionHandler(HttpServletRequest request, Exception e) {
4         String ip = RequestUtil.getIpAddress(request);
5         logger.info("調用者IP:" + ip);
6         String errorMessage = String.format("Url:[%s]%n{%s}", request.getRequestURL().toString(), e.getMessage());
7         logger.error(errorMessage, e);
8         return AppResponse.error(HttpStatus.INTERNAL_SERVER_ERROR.value(), e.getMessage());
9     }

到這裡基本上可以了,大家不要試著去用Gateway去捕獲後端異常,回到最初的起點,API 網關(API Gateway)主要負責服務請求路由、組合及協議轉換,異常同樣也是一樣,Gateway只負責轉發單體應用的異常,不要試圖Gateway捕獲後端服務異常,然後再輸出給前端。感謝猿天地的一句驚醒夢中人!


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

-Advertisement-
Play Games
更多相關文章
  • 今天棧長給大家推薦一款介面 API 設計神器,傳說中的,牛逼哄洪的 Swagger,它到底是什麼?今天為大家揭開謎底! Swagger是什麼? 官網:https://swagger.io/ Swagger 如官網所示,它是最好的 API 構建工具。 它是一個圍繞 OpenAPI 規範構建的開源工具, ...
  • num = num + num 與 num += num 的區別(其他語言中這倆種方式可以劃等號,但是python中不可以): num = num + num: 結果: 結果: 總結: num = num + num : =左邊的num相當於新命名了一個局部變數變數num,只是剛好與全局變數num名 ...
  • [toc] 在 R 中估計 GARCH 參數存在的問題(基於 rugarch 包) 本文翻譯自《Problems in Estimating GARCH Parameters in R (Part 2; rugarch)》 原文鏈接:https://ntguardian.wordpress.com/ ...
  • 驗證框架 SpringBoot支持JSR-303,Bean等驗證框架 JSR-303 JSR-303是Java的標準驗證框架,已有實現Hibernate validator. JSR-303驗證類型 在MVC中使用JSR-303校驗 可以使用@Validated註解來觸發一次校驗 例子: index ...
  • ##### 1. 類型 ClassNotFoundException繼承自Exception,屬於java異常類。NoClassDefFoundError繼承自Error,在java中Error一般屬於不可恢復的系統錯誤,有JVM拋出,並且不能被開發者處理。 ##### 2. 產生的原因 Class ...
  • [TOC] 今天正月十五,可憐的我還在這裡碼字,首先祝大家“猿宵節”快樂!距離我發佈的 "spring cloud初級教程" 已經有段時間了,這段時間經歷了一個春節,加上年後我又有了點事情要做,所以我在初級教程中預告的spring cloud手腳架項目估計要食言了。不過今天冒個泡,就是讓大家知道,事 ...
  • 情景引入 很早之前,Java就火起來了,是因為它善於開發和處理網路方面的應用。 Java有一個愛好,就是喜歡制定規範標準,但自己又不善於去實現。 反倒是一些服務提供商使用它的規範標準來製造應用伺服器而賺的盆滿缽滿。 企業用戶因要使用這些應用伺服器而向提供商支付高額費用,而且也不是特別好用。 一個青年 ...
  • 1.在windows下打包 微服務應用通過maven進行打包,在項目的pom.xml執行mvn clean package,或者直接通過idea或者eclipse進行maven打包 之上操作將在項目的 target目錄生成文件microservice-discovery-eureka-0.0.1-S ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...