溫馨提示×

溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊×
其他方式登錄
點擊 登錄注冊 即表示同意《億速云用戶服務(wù)條款》

如何實現(xiàn)Spring Cloud Gateway全局通用異常處理

發(fā)布時間：2020-07-21 13:53:15 來源：億速云 閱讀：431 作者：小豬 欄目：編程語言

小編這次要給大家分享的是如何實現(xiàn)Spring Cloud Gateway全局通用異常處理，文章內(nèi)容豐富，感興趣的小伙伴可以來了解一下，希望大家閱讀完這篇文章之后能夠有所收獲。

為什么需要全局異常處理

在傳統(tǒng) Spring Boot 應(yīng)用中， 我們 @ControllerAdvice 來處理全局的異常，進(jìn)行統(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());
  }
}

例如： ③ 處應(yīng)用調(diào)用數(shù)據(jù)庫異常，通過 @ControllerAdvice 包裝異常請求響應(yīng)給客戶端

如何實現(xiàn)Spring Cloud Gateway全局通用異常處理

但在微服務(wù)架構(gòu)下， 例如 ② 處 網(wǎng)關(guān)調(diào)用業(yè)務(wù)微服務(wù)失敗（轉(zhuǎn)發(fā)失敗、調(diào)用異常、轉(zhuǎn)發(fā)失?。?，在應(yīng)用設(shè)置的 @ControllerAdvice 將失效，因為流量根本沒有轉(zhuǎn)發(fā)到應(yīng)用上處理。

如何實現(xiàn)Spring Cloud Gateway全局通用異常處理

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

如何實現(xiàn)Spring Cloud Gateway全局通用異常處理

解決方法

默認(rèn)處理流程

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

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;
  }
}

默認(rèn)實現(xiàn) DefaultErrorWebExceptionHandler

如何實現(xiàn)Spring Cloud Gateway全局通用異常處理

public class DefaultErrorWebExceptionHandler {

  @Override
  protected RouterFunction<ServerResponse> getRoutingFunction(ErrorAttributes errorAttributes) {
   // 根據(jù)客戶端 `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"}&#9166;

重寫 ErrorWebExceptionHandler

/**
 * @author lengleng
 * @date 2020/5/23
 * <p>
 * 網(wǎng)關(guān)異常通用處理器，只作用在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]);
          }
        }));
  }
}

看完這篇關(guān)于如何實現(xiàn)Spring Cloud Gateway全局通用異常處理的文章，如果覺得文章內(nèi)容寫得不錯的話，可以把它分享出去給更多人看到。

向AI問一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點不代表本網(wǎng)站立場，如果涉及侵權(quán)請聯(lián)系站長郵箱：is@yisu.com進(jìn)行舉報，并提供相關(guān)證據(jù)，一經(jīng)查實，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手