Spring Cloud Gateway全局通用異常處理的實現

更新時間：2020年05月28日 10:25:35 作者：冷冷

這篇文章主要介紹了Spring Cloud Gateway全局通用異常處理的實現，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

為什么需要全局異常處理

在傳統(tǒng) Spring Boot 應用中，我們 @ControllerAdvice 來處理全局的異常，進行統(tǒng)一包裝返回

// 摘至 spring cloud alibaba console 模塊處理
@ControllerAdvice
public class ConsoleExceptionHandler {

  @ExceptionHandler(AccessException.class)
  private ResponseEntity<String> handleAccessException(AccessException e) {
    return ResponseEntity.status(HttpStatus.FORBIDDEN).body(e.getErrMsg());
  }
}

例如： ③ 處應用調用數據庫異常，通過 @ControllerAdvice 包裝異常請求響應給客戶端

但在微服務架構下，例如 ② 處網關調用業(yè)務微服務失敗（轉發(fā)失敗、調用異常、轉發(fā)失?。?，在應用設置的 @ControllerAdvice 將失效，因為流量根本沒有轉發(fā)到應用上處理。

如上圖：模擬所有路由斷言都不匹配 404 , 和 spring boot 默認保持一致的錯誤輸出頁面。顯然我們在網關同樣配置 @ControllerAdvice 是不能解決問題,因為 spring cloud gateway 是基于 webflux 反應式編程。

解決方法

默認處理流程

ExceptionHandlingWebHandler 作為 spring cloud gateway 最核心 WebHandler 的一部分會進行異常處理的過濾

public class ExceptionHandlingWebHandler extends WebHandlerDecorator {
  @Override
  public Mono<Void> handle(ServerWebExchange exchange) {
    Mono<Void> completion;
    try {
      completion = super.handle(exchange);
    }
    catch (Throwable ex) {
      completion = Mono.error(ex);
    }

   // 獲取全局的 WebExceptionHandler 執(zhí)行
    for (WebExceptionHandler handler : this.exceptionHandlers) {
      completion = completion.onErrorResume(ex -> handler.handle(exchange, ex));
    }
    return completion;
  }
}

默認實現 DefaultErrorWebExceptionHandler

public class DefaultErrorWebExceptionHandler {

  @Override
  protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {
   // 根據客戶端 `accpet` 請求頭決定返回什么資源，如上瀏覽器返回的是 頁面
    return route(acceptsTextHtml(), this::renderErrorView).andRoute(all(), this::renderErrorResponse);
  }
}

// 模擬指定 `accpet` 情況
curl --location --request GET 'http://localhost:9999/adminx/xx' \ 18:09:23
   --header 'Accept: application/json'
{"timestamp":"2020-05-24 18:09:24","path":"/adminx/xx","status":404,"error":"Not Found","message":null,"requestId":"083c48e3-2"}⏎

重寫 ErrorWebExceptionHandler

/**
 * @author lengleng
 * @date 2020/5/23
 * <p>
 * 網關異常通用處理器，只作用在webflux 環(huán)境下 , 優(yōu)先級低于 {@link ResponseStatusExceptionHandler} 執(zhí)行
 */
@Slf4j
@Order(-1)
@RequiredArgsConstructor
public class GlobalExceptionConfiguration implements ErrorWebExceptionHandler {
  private final ObjectMapper objectMapper;

  @Override
  public Mono<Void> handle(ServerWebExchange exchange, Throwable ex) {
    ServerHttpResponse response = exchange.getResponse();

    if (response.isCommitted()) {
      return Mono.error(ex);
    }

    // header set
    response.getHeaders().setContentType(MediaType.APPLICATION_JSON);
    if (ex instanceof ResponseStatusException) {
      response.setStatusCode(((ResponseStatusException) ex).getStatus());
    }

    return response
        .writeWith(Mono.fromSupplier(() -> {
          DataBufferFactory bufferFactory = response.bufferFactory();
          try {
            return bufferFactory.wrap(objectMapper.writeValueAsBytes(R.failed(ex.getMessage())));
          } catch (JsonProcessingException e) {
            log.warn("Error writing response", ex);
            return bufferFactory.wrap(new byte[0]);
          }
        }));
  }
}

總結

重寫的 DefaultErrorWebExceptionHandler 優(yōu)先級一定要小于內置 ResponseStatusExceptionHandler 經過它處理的獲取對應錯誤類的響應碼
其他擴展可以參考 SentinelBlockExceptionHandler sentinel 整合網關的處理，不過整體和默認的異常處理沒有什么區(qū)別
基礎環(huán)境說明：Spring Cloud Hoxton.SR4 & Spring Boot 2.3.0
具體實現代碼參考：https://gitee.com/log4j/pig

到此這篇關于Spring Cloud Gateway全局通用異常處理的實現的文章就介紹到這了,更多相關Spring Cloud Gateway全局異常內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: