Spring Cloud Gateway全局通用異常處理的實(shí)現(xiàn)
為什么需要全局異常處理
在傳統(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)給客戶端
但在微服務(wù)架構(gòu)下, 例如 ② 處 網(wǎng)關(guān)調(diào)用業(yè)務(wù)微服務(wù)失?。ㄞD(zhuǎn)發(fā)失敗、調(diào)用異常、轉(zhuǎn)發(fā)失敗),在應(yīng)用設(shè)置的 @ControllerAdvice 將失效,因?yàn)榱髁扛緵]有轉(zhuǎn)發(fā)到應(yīng)用上處理。
如上圖: 模擬所有路由斷言都不匹配 404 , 和 spring boot 默認(rèn)保持一致的錯(cuò)誤輸出頁面。 顯然我們在網(wǎng)關(guān)同樣配置 @ControllerAdvice 是不能解決問題,因?yàn)?spring cloud gateway 是基于 webflux 反應(yīng)式編程。
解決方法
默認(rèn)處理流程
ExceptionHandlingWebHandler 作為 spring cloud gateway 最核心 WebHandler 的一部分會(huì)進(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)實(shí)現(xiàn) DefaultErrorWebExceptionHandler
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"}⏎
重寫 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]); } })); } }
總結(jié)
- 重寫的 DefaultErrorWebExceptionHandler 優(yōu)先級一定要小于內(nèi)置 ResponseStatusExceptionHandler 經(jīng)過它處理的獲取對應(yīng)錯(cuò)誤類的 響應(yīng)碼
- 其他擴(kuò)展 可以參考 SentinelBlockExceptionHandler sentinel 整合網(wǎng)關(guān)的處理,不過整體和默認(rèn)的異常處理沒有什么區(qū)別
- 基礎(chǔ)環(huán)境說明:Spring Cloud Hoxton.SR4 & Spring Boot 2.3.0
- 具體實(shí)現(xiàn)代碼參考:https://gitee.com/log4j/pig
到此這篇關(guān)于Spring Cloud Gateway全局通用異常處理的實(shí)現(xiàn)的文章就介紹到這了,更多相關(guān)Spring Cloud Gateway全局異常內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
SpringBoot中fastjson自定義序列化和反序列化的實(shí)戰(zhàn)分享
在fastjson庫中,為了提供靈活的序列化和反序列化機(jī)制,設(shè)計(jì)了一系列的擴(kuò)展點(diǎn),以下是在SpringBoot和SpringClould環(huán)境中對這些擴(kuò)展點(diǎn)的詳細(xì)介紹及其實(shí)戰(zhàn)使用,通過代碼示例講解的非常詳細(xì),需要的朋友可以參考下2024-07-07使用XSD校驗(yàn)Mybatis的SqlMapper配置文件的方法(1)
這篇文章以前面對SqlSessionFactoryBean的重構(gòu)為基礎(chǔ),簡單的介紹了相關(guān)操作知識,然后在給大家分享使用XSD校驗(yàn)Mybatis的SqlMapper配置文件的方法,感興趣的朋友參考下吧2016-11-11使用IntelliJ IDEA 進(jìn)行代碼對比的方法(兩種方法)
這篇文章給大家?guī)砹藘煞NIntelliJ IDEA 進(jìn)行代碼對比的方法,非常不錯(cuò),具有參考借鑒價(jià)值,需要的朋友可以參考下2018-01-01MybatisPlus,無XML分分鐘實(shí)現(xiàn)CRUD操作
這篇文章主要介紹了MybatisPlus,無XML分分鐘實(shí)現(xiàn)CRUD操作,具有很好的參考價(jià)值,希望對大家有所幫助。一起跟隨小編過來看看吧2020-08-08java自定義日志輸出文件(log4j日志文件輸出多個(gè)自定義日志文件)
打印日志的在程序中是必不可少的,如果需要將不同的日志打印到不同的地方,則需要定義不同的Appender,然后定義每一個(gè)Appender的日志級別、打印形式和日志的輸出路徑,下面看一個(gè)示例吧2014-01-01常用的ResponseEntity.BodyBuilder和自定義ResponseEntity的實(shí)例
這篇文章主要介紹了常用的ResponseEntity.BodyBuilder和自定義ResponseEntity的實(shí)例,具有很好的參考價(jià)值,希望對大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-07-07