spring cloud gateway 二次开发之 Ribbon重试配置

gateway使用ribbon作为服务调用的负载均衡中间件,最终使用的都是ribbon的几个组件实现:

  • ServerList:拉取服务列表接口
  • ServerListFilter:对ServerList服务器列表进行过滤
  • ServerListUpdater: 更新服务列表的接口
  • IPing: 健康检查
  • IRule :负载均衡规则,如轮询、随机等
  • ILoadBalancer:负载均衡器,组合以上组件最终实现负载

对于以上接口的实现先暂时不写,这次写的是gateway使用以上组件进行负载均衡的2种实现方式:

一 使用gateway自己的过滤器 LoadBalancerClientFilter 组合以上接口 实现

二 通过对 RestTemplate 增加 LoadBalancerInterceptor拦截器实现

那么项目在启动的时候是如何在这两种方式当中选择的呢?

我们先看第一种方式,LoadBalancerClientFilter的加载条件

@Configuration
@ConditionalOnClass({ LoadBalancerClient.class, RibbonAutoConfiguration.class,
        DispatcherHandler.class })
@AutoConfigureAfter(RibbonAutoConfiguration.class)
@EnableConfigurationProperties(LoadBalancerProperties.class)
public class GatewayLoadBalancerClientAutoConfiguration {

    // GlobalFilter beans

    @Bean
    @ConditionalOnBean(LoadBalancerClient.class)
    @ConditionalOnMissingBean(LoadBalancerClientFilter.class)
    public LoadBalancerClientFilter loadBalancerClientFilter(LoadBalancerClient client,
            LoadBalancerProperties properties) {
        return new LoadBalancerClientFilter(client, properties);
    }

}

是通过 GatewayLoadBalancerClientAutoConfiguration 配置类来加载的,而GatewayLoadBalancerClientAutoConfiguration的加载条件是,当存在
LoadBalancerClient.classRibbonAutoConfiguration.classDispatcherHandler.class的时候会加载,

1 LoadBalancerClient.class 只有一个默认实现 RibbonLoadBalancerClient,是肯定会加载的
我们看剩下2个类

2 RibbonAutoConfiguration 配置类 是当我们在项目中引入 spring-cloud-starter-netflix-ribbon 依赖的时候进行加载

3 剩下最后一个DispatcherHandler 这个是关键,我在排查问题的时候,一直忽略这个类,看这名字感觉一定会加载,没想到这个才是重点所在

DispatcherHandler 是在 WebFluxConfigurationSupport 中定义的

public class WebFluxConfigurationSupport implements ApplicationContextAware {

     ...中间代码省略

    @Bean
    public DispatcherHandler webHandler() {
        return new DispatcherHandler();
    }
 ...以下代码省略
}

WebFluxConfigurationSupportDelegatingWebFluxConfiguration 继承

@Configuration
public class DelegatingWebFluxConfiguration extends WebFluxConfigurationSupport {

可以看到,DelegatingWebFluxConfiguration 又被 EnableWebFluxConfiguration 继承
EnableWebFluxConfiguration 被定义在 WebFluxAutoConfiguration 这个配置类中

@Configuration
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
@ConditionalOnClass(WebFluxConfigurer.class)
@ConditionalOnMissingBean({ WebFluxConfigurationSupport.class })
@AutoConfigureAfter({ ReactiveWebServerFactoryAutoConfiguration.class, CodecsAutoConfiguration.class,
        ValidationAutoConfiguration.class })
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
public class WebFluxAutoConfiguration {

...中间代码省略

/**
     * Configuration equivalent to {@code @EnableWebFlux}.
     */
    @Configuration
    public static class EnableWebFluxConfiguration extends DelegatingWebFluxConfiguration {

        ...中间代码省略

    }

...代码省略

}

终于到了关键的地方了
WebFluxAutoConfiguration 的第二行
@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
表明了它的加载条件,只有当 springboot 的启动环境 WebApplicationTypeREACTIVE才会进行加载

而这个类型怎么确定呢?
当我们依赖 spring-boot-starter-web 的时候,WebApplicationTypeSERVLET
依赖 spring-boot-starter-webflux 并且 没有依赖 spring-boot-starter-web 的时候,WebApplicationTypeREACTIVE
如果没有依赖,springboot2.0以上默认为 REACTIVE

既然这两种方式都能实现负载均衡,那有什么区别的,关键在于想要进行错误重试的时候

如果使用 LoadBalancerClientFilter方式实现负载均衡,重试的时候要在配置文件中这么配置

spring:
  cloud:
    gateway:
      default-filters:
        - name: Retry
          args:
            retries: 3

这样是对所有路由生效,或者指定单个路由

spring:
  gateway:
    routes:
      - id: test
        uri: lb://test
        predicates:
          - Path=/test/*
        filters:
          - name: Retry
            args:
              retries: 3

而使用 LoadBalancerInterceptor拦截器方式实现负载均衡,配置文件中这么配置

ribbon:
  MaxAutoRetries: 0
  MaxAutoRetriesNextServer: 2
  ReadTimeout: 2000
  ConnectTimeout: 1500
  OkToRetryOnAllOperations: true

你可能感兴趣的:(spring cloud gateway 二次开发之 Ribbon重试配置)