Spring Cloud Gateway:retry 与 fallback

Retry

实例

spring:
  cloud:
    gateway:
      routes:
      - id: organization-service
        uri: lb://organization-service
        predicates:
        - Path=/org/**
        filters:
        - name: Retry
          args:
            retries: 3
            series:
            - SERVER_ERROR
            statuses:
            - INTERNAL_SERVER_ERROR
            - BAD_GATEWAY
            methods:
            - GET
            exceptions:
            - java.io.IOException
            - java.util.concurrent.TimeoutException

上面的重试过滤器,有5个配置:

  • retries:默认为3,用来标识重试次数
  • series:用来指定哪些段的状态码需要重试,默认SERVER_ERROR,即5xx。
  • statuses:用于指定哪些状态需要重试,默认为空,它跟series至少得指定一个。一般不怎么配置这个。
  • methods:于指定那些方法的请求需要重试,默认为GET
  • exceptions:用于指定哪些异常需要重试,默认为java.io.IOExceptionjava.util.concurrent.TimeoutException

除了retriesexceptions,其他3项的对应的枚举类为:

  • series:org.springframework.http.HttpStatus.Series
  • statuses:org.springframework.http.HttpStatus
  • methods:org.springframework.http.HttpMethod

重试过滤器源码位置: org.springframework.cloud.gateway.filter.factory.RetryGatewayFilterFactoryorg.springframework.cloud.gateway.filter.factory.RetryGatewayFilterFactory.RetryConfig

Fallback

首先必须确保加入如下依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-netflix-hystrix</artifactId>
</dependency>

实例:

spring:
  cloud:
    gateway:
      routes:
      - id: organization-service
        uri: lb://organization-service
        predicates:
        - Path=/org/**
        filters:
        - name: Hystrix
          args:
            name: fallback
            fallbackUri: 'forward:/fallback'

上面配置包含了一个 Hystrix 过滤器,该过滤器会应用Hystrix熔断与降级,会将请求包装成名为fallback的路由指令RouteHystrixCommandRouteHystrixCommand继承于HystrixObservableCommand,其内包含了Hystrix的断路、资源隔离、降级等诸多断路器核心功能,当网关转发的请求出现问题时,网关能对其进行快速失败,执行特定的失败逻辑,保护网关安全。

配置中有一个可选参数fallbackUri,当前只支持forward模式的URI。如果服务被降级,请求会被转发到该URI对应的控制器。控制器可以是自定义的fallback接口;也可以使自定义的Handler,需要实现接口org.springframework.web.reactive.function.server.HandlerFunction<T extends ServerResponse>

定义 fallback 接口

Spring Cloud Gateway支持自定义fallback接口。在gateway模块定义fallback接口,示例如下:

@ResponseBody
@RequestMapping("/fallback")
public Object fallback() {
    // return something
}

定义 fallback 处理器

@Slf4j
@Component
public class HystrixFallbackHandler implements HandlerFunction<ServerResponse> {

    private ErrorResponse ERROR_RESPONSE = new ErrorResponse();

    @PostConstruct
    private void init() {
        ERROR_RESPONSE.setCode(9999);
        ERROR_RESPONSE.setMessage("服务异常");
    }

    @Override
    public Mono<ServerResponse> handle(ServerRequest serverRequest) {
        serverRequest.attribute(ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR)
            .ifPresent(originalUrls -> log.error("网关执行请求:{}失败,hystrix服务降级处理", originalUrls));

        return ServerResponse
            .status(HttpStatus.OK)
            .contentType(MediaType.APPLICATION_JSON_UTF8)
            .body(BodyInserters.fromObject(ERROR_RESPONSE));
    }
}

说明:

  1. ErrorResponse:封装了codemessage的统一错误返回对象。
  2. ServerWebExchangeUtils.GATEWAY_ORIGINAL_REQUEST_URL_ATTR:网关在转发请求之前,会把一些关键属性放到请求体的attribute中,通过GATEWAY_ORIGINAL_REQUEST_URL_ATTR可以获取原请求 URL。如果通过RequestContextHolder的方式获取,那么获取到的其实是服务降级后 forward 请求,这里为/fallback

配置 fallback 处理器

@Configuration
public class RouterFunctionConfiguration {
        @Autowired
    private HystrixFallbackHandler hystrixFallbackHandler;

    @Bean
    public RouterFunction routerFunction() {
        return RouterFunctions.route(
            RequestPredicates.GET("/fallback")
                .and(RequestPredicates.accept(MediaType.TEXT_PLAIN)), hystrixFallbackHandler);
    }

}

注意

当同时配置了重试过滤器和降级过滤器,降级过滤器需要配在重试过滤器之前:

spring:
  cloud:
    gateway:
      routes:
      - id: organization-service
        uri: lb://organization-service
        predicates:
        - Path=/org/**
        filters:
        - name: Hystrix
          args:
            name: fallback
            fallbackUri: 'forward:/fallback'
        - name: Retry
          args:
            retries: 3
            series:
            - SERVER_ERROR
            methods:
            - GET

可以看下Spring Cloud的开发成员怎么说的:Put hystrix before retry

推荐阅读

Spring Cloud 进阶玩法

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 225,226评论 6 524
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 96,509评论 3 405
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 172,523评论 0 370
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 61,181评论 1 302
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 70,189评论 6 401
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 53,642评论 1 316
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 41,993评论 3 431
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 40,977评论 0 280
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 47,527评论 1 326
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 39,547评论 3 347
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 41,661评论 1 355
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 37,250评论 5 351
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 42,991评论 3 340
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 33,422评论 0 25
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 34,571评论 1 277
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 50,241评论 3 382
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 46,737评论 2 366

推荐阅读更多精彩内容