Spring Cloud Gateway重試機(jī)制原理解析
重試,我相信大家并不陌生。在我們調(diào)用Http接口的時(shí)候,總會(huì)因?yàn)槟撤N原因調(diào)用失敗,這個(gè)時(shí)候我們可以通過(guò)重試的方式,來(lái)重新請(qǐng)求接口。
生活中這樣的事例很多,比如打電話(huà),對(duì)方正在通話(huà)中啊,信號(hào)不好啊等等原因,你總會(huì)打不通,當(dāng)你第一次沒(méi)打通之后,你會(huì)打第二次,第三次…第四次就通了。
重試也要注意應(yīng)用場(chǎng)景,讀數(shù)據(jù)的接口比較適合重試的場(chǎng)景,寫(xiě)數(shù)據(jù)的接口就需要注意接口的冪等性了。還有就是重試次數(shù)如果太多的話(huà)會(huì)導(dǎo)致請(qǐng)求量加倍,給后端造成更大的壓力,設(shè)置合理的重試機(jī)制才是最關(guān)鍵的。
今天我們來(lái)簡(jiǎn)單的了解下Spring Cloud Gateway中的重試機(jī)制和使用。
使用講解
RetryGatewayFilter是Spring Cloud Gateway對(duì)請(qǐng)求重試提供的一個(gè)GatewayFilter Factory。
配置方式:
spring: cloud: gateway: routes: - id: fsh-house uri: lb://fsh-house predicates: - Path=/house/** filters: - name: Retry args: retries: 3 series: - SERVER_ERROR statuses: - OK methods: - GET - POST exceptions: - java.io.IOException
配置講解
配置類(lèi)源碼:org.springframework.cloud.gateway.filter.factory.RetryGatewayFilterFactory.RetryConfig:
public static class RetryConfig { private int retries = 3; private List<Series> series = toList(Series.SERVER_ERROR); private List<HttpStatus> statuses = new ArrayList<>(); private List<HttpMethod> methods = toList(HttpMethod.GET); private List<Class<? extends Throwable>> exceptions = toList(IOException.class); // ..... }
retries:重試次數(shù),默認(rèn)值是3次
series:狀態(tài)碼配置(分段),符合的某段狀態(tài)碼才會(huì)進(jìn)行重試邏輯,默認(rèn)值是SERVER_ERROR,值是5,也就是5XX(5開(kāi)頭的狀態(tài)碼),共有5個(gè)值:
public enum Series { INFORMATIONAL(1), SUCCESSFUL(2), REDIRECTION(3), CLIENT_ERROR(4), SERVER_ERROR(5); }
statuses:狀態(tài)碼配置,和series不同的是這邊是具體狀態(tài)碼的配置,取值請(qǐng)參考:org.springframework.http.HttpStatus
methods:指定哪些方法的請(qǐng)求需要進(jìn)行重試邏輯,默認(rèn)值是GET方法,取值如下:
public enum HttpMethod { GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE; }
exceptions:指定哪些異常需要進(jìn)行重試邏輯,默認(rèn)值是java.io.IOException
代碼測(cè)試
就寫(xiě)個(gè)接口,在接口中記錄請(qǐng)求次數(shù),然后拋出一個(gè)異常模擬500,通過(guò)網(wǎng)關(guān)訪(fǎng)問(wèn)這個(gè)接口,如果你配置了重試次數(shù)是3,那么接口中會(huì)輸出4次結(jié)果才是對(duì)的,證明重試生效了。
AtomicInteger ac = new AtomicInteger(); @GetMapping("/data") public HouseInfo getData(@RequestParam("name") String name) { if (StringUtils.isBlank(name)) { throw new RuntimeException("error"); } System.err.println(ac.addAndGet(1)); return new HouseInfo(1L, "上海", "虹口", "XX小區(qū)"); }
源碼欣賞
@Override public GatewayFilter apply(RetryConfig retryConfig) { // 驗(yàn)證重試配置格式是否正確 retryConfig.validate(); Repeat<ServerWebExchange> statusCodeRepeat = null; if (!retryConfig.getStatuses().isEmpty() || !retryConfig.getSeries().isEmpty()) { Predicate<RepeatContext<ServerWebExchange>> repeatPredicate = context -> { ServerWebExchange exchange = context.applicationContext(); // 判斷重試次數(shù)是否已經(jīng)達(dá)到了配置的最大值 if (exceedsMaxIterations(exchange, retryConfig)) { return false; } // 獲取響應(yīng)的狀態(tài)碼 HttpStatus statusCode = exchange.getResponse().getStatusCode(); // 獲取請(qǐng)求方法類(lèi)型 HttpMethod httpMethod = exchange.getRequest().getMethod(); // 判斷響應(yīng)狀態(tài)碼是否在配置中存在 boolean retryableStatusCode = retryConfig.getStatuses().contains(statusCode); if (!retryableStatusCode && statusCode != null) { // null status code might mean a network exception? // try the series retryableStatusCode = retryConfig.getSeries().stream() .anyMatch(series -> statusCode.series().equals(series)); } // 判斷方法是否包含在配置中 boolean retryableMethod = retryConfig.getMethods().contains(httpMethod); // 決定是否要進(jìn)行重試 return retryableMethod && retryableStatusCode; }; statusCodeRepeat = Repeat.onlyIf(repeatPredicate) .doOnRepeat(context -> reset(context.applicationContext())); } //TODO: support timeout, backoff, jitter, etc... in Builder Retry<ServerWebExchange> exceptionRetry = null; if (!retryConfig.getExceptions().isEmpty()) { Predicate<RetryContext<ServerWebExchange>> retryContextPredicate = context -> { if (exceedsMaxIterations(context.applicationContext(), retryConfig)) { return false; } // 異常判斷 for (Class<? extends Throwable> clazz : retryConfig.getExceptions()) { if (clazz.isInstance(context.exception())) { return true; } } return false; }; // 使用reactor extra的retry組件 exceptionRetry = Retry.onlyIf(retryContextPredicate) .doOnRetry(context -> reset(context.applicationContext())) .retryMax(retryConfig.getRetries()); } return apply(statusCodeRepeat, exceptionRetry); } public boolean exceedsMaxIterations(ServerWebExchange exchange, RetryConfig retryConfig) { Integer iteration = exchange.getAttribute(RETRY_ITERATION_KEY); //TODO: deal with null iteration return iteration != null && iteration >= retryConfig.getRetries(); } public void reset(ServerWebExchange exchange) { //TODO: what else to do to reset SWE? exchange.getAttributes().remove(ServerWebExchangeUtils.GATEWAY_ALREADY_ROUTED_ATTR); } public GatewayFilter apply(Repeat<ServerWebExchange> repeat, Retry<ServerWebExchange> retry) { return (exchange, chain) -> { if (log.isTraceEnabled()) { log.trace("Entering retry-filter"); } // chain.filter returns a Mono<Void> Publisher<Void> publisher = chain.filter(exchange) //.log("retry-filter", Level.INFO) .doOnSuccessOrError((aVoid, throwable) -> { // 獲取已經(jīng)重試的次數(shù),默認(rèn)值為-1 int iteration = exchange.getAttributeOrDefault(RETRY_ITERATION_KEY, -1); // 增加重試次數(shù) exchange.getAttributes().put(RETRY_ITERATION_KEY, iteration + 1); }); if (retry != null) { // retryWhen returns a Mono<Void> // retry needs to go before repeat publisher = ((Mono<Void>)publisher).retryWhen(retry.withApplicationContext(exchange)); } if (repeat != null) { // repeatWhen returns a Flux<Void> // so this needs to be last and the variable a Publisher<Void> publisher = ((Mono<Void>)publisher).repeatWhen(repeat.withApplicationContext(exchange)); } return Mono.fromDirect(publisher); }; }
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
- Spring Cloud Gateway + Nacos 實(shí)現(xiàn)動(dòng)態(tài)路由
- Spring Cloud Gateway不同頻率限流的解決方案(每分鐘,每小時(shí),每天)
- 詳解SpringCloudGateway內(nèi)存泄漏問(wèn)題
- 基于Nacos實(shí)現(xiàn)Spring Cloud Gateway實(shí)現(xiàn)動(dòng)態(tài)路由的方法
- Spring Cloud Gateway全局通用異常處理的實(shí)現(xiàn)
- spring cloud gateway整合sentinel實(shí)現(xiàn)網(wǎng)關(guān)限流
- spring cloud gateway請(qǐng)求跨域問(wèn)題解決方案
- Springcloud GateWay網(wǎng)關(guān)配置過(guò)程圖解
相關(guān)文章
Spring Boot與Spark、Cassandra系統(tǒng)集成開(kāi)發(fā)示例
本文演示以Spark作為分析引擎,Cassandra作為數(shù)據(jù)存儲(chǔ),而使用Spring Boot來(lái)開(kāi)發(fā)驅(qū)動(dòng)程序的示例。對(duì)spring boot 與spark cassandra集成開(kāi)發(fā)示例代碼感興趣的朋友跟著腳本之家小編一起學(xué)習(xí)吧2018-02-02Spring bean對(duì)象實(shí)例化實(shí)現(xiàn)過(guò)程圖解
這篇文章主要介紹了Spring bean對(duì)象實(shí)例化實(shí)現(xiàn)過(guò)程圖解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-07-07詳解Java中字典樹(shù)(Trie樹(shù))的圖解與實(shí)現(xiàn)
Trie又稱(chēng)為前綴樹(shù)或字典樹(shù),是一種有序樹(shù),它是一種專(zhuān)門(mén)用來(lái)處理串匹配的數(shù)據(jù)結(jié)構(gòu)。本文將利用圖解詳細(xì)講解Trie樹(shù)的實(shí)現(xiàn),需要的可以參考一下2022-05-05Springboot+Poi導(dǎo)入Excel表格實(shí)現(xiàn)過(guò)程詳解
這篇文章主要介紹了Springboot+Poi導(dǎo)入Excel表格實(shí)現(xiàn)過(guò)程詳解,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09SpringBoot框架集成ElasticSearch實(shí)現(xiàn)過(guò)程示例詳解
這篇文章主要為大家介紹了SpringBoot如何集成ElasticSearch的實(shí)現(xiàn)過(guò)程示例詳解,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步2021-11-11java8日期工具類(lèi)封裝的實(shí)戰(zhàn)記錄
java time包中的是類(lèi)是不可變且線(xiàn)程安全的,新的時(shí)間及日期API位于java.time中,下面這篇文章主要給大家介紹了關(guān)于java8日期工具類(lèi)封裝的相關(guān)資料,需要的朋友可以參考下2021-09-09