Spring Cloud Feign实现同一服务多client自定义配置

欢迎关注我的github，以后所有文章源码都会陆续更新上去

前提知识

我们知道在使用Feign的时候，有三种方式可以实现自定义配置

properties
直接在properties/yaml文件中配置属性，此配置优先级最高

# xxx表示service name
feign.client.config.xxx.connectTimeout= 1000
feign.client.config.xxx.readTimeout = 3000

不过这里有一个很容易忽略的坑，connectTimeout和readTimeout 必须同时配置才能生效，查看源码可以发现原理

image.png

@FeignClient configuration
在具体的@FeignClient上配置，此配置优先级次之，相同配置会被上一个覆盖

image.png

Configuration配置类，此次注意，此类不能有@Configuration注解，否则会被全局扫描到，变成了全局配置，此外方法上必须标注@Bean才能生效

image.png

global configuration
直接在当前项目包下新建一个@Configuration，此配置优先级最低，相同配置会被前两个覆盖

image.png

理论上只要做好上面的配置，就可以达到每个FeignClient任意自定义配置。然而我们有小伙伴反馈线上后台有一个很复杂的聚合查询接口总是超过3.5S就报Read timed out，而根据上面截图我们已经做了自定义配置readTimeout=12000 ms，明显没有生效，这是为什么呢？

现场还原

为了保留现场，我们直接使用阿里的Arthas线上诊断/调试工具

首先使用jad命令反编译线上代码是否正确

image.png

image.png

image.png
确认线上代码没有任何问题后，在使用watch命令监测实际方法执行入参。由于我们使用的是ApacheHttpClient（其他实现方式如OkHttp类似）,监测如下方法即可

image.png

watch命令（由于线上已修复，故与前面截图数值不完全一致，当时readTimeout=3500）

image.png
经过上面两步调试后，确定代码没有任何问题，但配置却没有生效，所以问题应该出现在Feign源码执行上，开始撸源码

源码剖析

@EnableFeignClients，发现此注解上@Import了FeignClientsRegistrar

image.png
FeignClientsRegistrar，注意此处执行registerFeignClients方法

image.png

此方法内扫描到每一个被@FeignClient注解的接口时会执行三个很重要的动作
1.getClientName 获取client名称，一定要记住这个方法，后面会与另外一个getName方法放在一起对比，这也是实现这边文章标题的关键
2.registerClientConfiguration 注册每一个client的上下文，这也是feign能够实现每一个client单独配置的关键，具体实现不往下深挖，有兴趣的可以自己去看源码
3.registerFeignClient 注册每一个FeignClient代理实现类

image.png
getClientName client这个map是由@FeignClient注解解析出来的，首先获取value值，如果为空则取name，如果name也为空，最后取serviceId（官方已建议Deprecated），再看我们的项目中只申明了@FeignClient(name=xxx)，所以此方法必定返回xxx

image.png
registerClientConfiguration 这里可以看到注册的每一个configuraiton上下文的beanName其实就是等同于name.FeignClientSpecification，configuration为@FeignClient(configuraiton=xxx)属性，默认为null，再继续深挖registerBeanDefinition方法

image.png
DefaultListableBeanFactory.registerBeanDefinition 这已经是spring很底层的方法了，看到这儿就发现了自定义配置不生效的苗头了。

image.png

原因由于在我们的项目中提供出来的API jar包中一个服务提供了很多接口，因此我们进行了模块划分，造成了同一个service name提供了多个@FeignClient（这样的场景应该很普遍，一个@FeignClient上提供几十上百个接口，体验简直太糟糕了）。
再结合前面的getClientName方法可以得知每次执行此方法返回的都是相同的beanName，那么这里配置类只会不断的覆盖，configuration不为null的@FeignClient(name=xxx, configuration=yyy.class)被configuration为null的@FeignClient(name=xxx)所覆盖，造成前面所提到的ApacheHttpClient无法获取到自定义的configuration Options，降级为获取parant context即全局的configuration Options.readTimeout=3500
registerFeignClient 上面解答了我们自定义配置为什么没有生效的疑问，但是还没有实现我们想要达到的同一服务名称不同client的不同配置的目的。继续往下看，这里又出现了一个getName方法

image.png
getName 还记得前面提到的getClientName方法吗？此处我们把两个方法的代码贴在一起对比看看有什么区别，为什么要单独写一个方法？

image.png

image.png

有没有发现两个方法取值顺序刚好相反（service_id官方已经不推荐了，可以忽略，我们只考虑name和value属性），这里就给了我们实现文章标题目的的机会：多个@FeignClient上使用相同的name，不同的value，达到既可以同一个name发现服务，不同的value注册不同的configuration，代码如下

/**
* 品牌模块，无自定义配置，使用默认全局配置
**/
@FeignClient(value = "brand", name = "goods")
public interface GoodsBrandFeign {}
/**
* 文章模块
**/
@FeignClient(value = "article", name = "goods", configuration = ArticleFeignConfiguration.class)
public interface GoodsArticleFeign {}
/**
* 文章feign配置
**/
public class ArticleFeignConfiguration {
  @Bean
  public Options options() {
    return new Request.Options(1000, 20000);
  }
}

原以为只需要配置不同value即可实现，现实狠狠的打了我的脸，运行抛出了异常，原来spring底层在解析注解的属性输出为Map时，内部约束标注了@AliasFor注解的属性必须相同，否则不允许通过

Caused by: org.springframework.core.annotation.AnnotationConfigurationException: In AnnotationAttributes for annotation [org.springframework.cloud.openfeign.FeignClient] declared on class 'com.epet.microservices.purchase.openapi.feign.TagBrandFeign', attribute 'name' and its alias 'value' are declared with values of [tag] and [brand], but only one is permitted.
    at org.springframework.core.annotation.AnnotationUtils.lambda$postProcessAnnotationAttributes$0(AnnotationUtils.java:1342)
    at java.util.LinkedHashMap.forEach(LinkedHashMap.java:684)
    at org.springframework.core.annotation.AnnotationUtils.postProcessAnnotationAttributes(AnnotationUtils.java:1323)
    at org.springframework.core.annotation.AnnotationUtils.postProcessAnnotationAttributes(AnnotationUtils.java:1284)
    at org.springframework.core.type.classreading.AnnotationReadingVisitorUtils.convertClassValues(AnnotationReadingVisitorUtils.java:50)
    at org.springframework.core.type.classreading.AnnotationMetadataReadingVisitor.getAnnotationAttributes(AnnotationMetadataReadingVisitor.java:142)
    at org.springframework.core.type.classreading.AnnotationMetadataReadingVisitor.getAnnotationAttributes(AnnotationMetadataReadingVisitor.java:131)
    at org.springframework.core.type.classreading.AnnotationMetadataReadingVisitor.getAnnotationAttributes(AnnotationMetadataReadingVisitor.java:51)
    at org.springframework.cloud.openfeign.FeignClientsRegistrar.registerFeignClients(FeignClientsRegistrar.java:151)
    at org.springframework.cloud.openfeign.FeignClientsRegistrar.registerBeanDefinitions(FeignClientsRegistrar.java:83)
    at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.lambda$loadBeanDefinitionsFromRegistrars$1(ConfigurationClassBeanDefinitionReader.java:358)
    at java.util.LinkedHashMap.forEach(LinkedHashMap.java:684)
    at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsFromRegistrars(ConfigurationClassBeanDefinitionReader.java:357)
    at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitionsForConfigurationClass(ConfigurationClassBeanDefinitionReader.java:146)
    at org.springframework.context.annotation.ConfigurationClassBeanDefinitionReader.loadBeanDefinitions(ConfigurationClassBeanDefinitionReader.java:118)
    at org.springframework.context.annotation.ConfigurationClassPostProcessor.processConfigBeanDefinitions(ConfigurationClassPostProcessor.java:328)
    at org.springframework.context.annotation.ConfigurationClassPostProcessor.postProcessBeanDefinitionRegistry(ConfigurationClassPostProcessor.java:233)
    at org.springframework.context.support.PostProcessorRegistrationDelegate.invokeBeanDefinitionRegistryPostProcessors(PostProcessorRegistrationDelegate.java:271)
    at org.springframework.context.support.PostProcessorRegistrationDelegate.invokeBeanFactoryPostProcessors(PostProcessorRegistrationDelegate.java:91)
    at org.springframework.context.support.AbstractApplicationContext.invokeBeanFactoryPostProcessors(AbstractApplicationContext.java:692)
    at org.springframework.context.support.AbstractApplicationContext.refresh(AbstractApplicationContext.java:530)
    at org.springframework.boot.web.servlet.context.ServletWebServerApplicationContext.refresh(ServletWebServerApplicationContext.java:140)
    at org.springframework.boot.SpringApplication.refresh(SpringApplication.java:754)
    at org.springframework.boot.SpringApplication.refreshContext(SpringApplication.java:386)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:307)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1242)
    at org.springframework.boot.SpringApplication.run(SpringApplication.java:1230)
    at com.epet.microservices.purchase.openapi.App.main(App.java:20)

image.png

此路走不通的话，就又去github上看了下commit历史记录，果真发现一条

image.png

送上commit传送门https://github.com/spring-cloud/spring-cloud-openfeign/commit/e227808b9d47c8c35d2a60414cb1c83564e72e5c
2.1.0.RELEASE版本之后@FeignClient新增了一个contextId属性，专门用于解决这个场景，此次我们直接升级到spring cloud推荐版本

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.6.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR4</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
</dependencyManagement>
<dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-openfeign</artifactId>
        </dependency>
        <dependency>
            <groupId>io.github.openfeign</groupId>
            <artifactId>feign-httpclient</artifactId>
        </dependency>
</dependencies>

查看最新代码不难发现，前面分析的源码逻辑全都变更为根据contextId判断了

image.png

image.png

FeignClientFactoryBean也增加了contextId属性，上下文获取逻辑也调整为根据contextId（contextId默认不填等同于name）

image.png

image.png

结论

至此我们终于找到了最终完美解决@FeignClient相同name不同client不同配置的问题，总结如下：

如果你使用的spring-cloud-starter-openfeign是2.1.0之前的版本，是无法实现class(client)级别的细粒度自定义配置的，此种情况只能是多个class(client)共享同一个name，同一份properties配置，这是一直很粗粒度的配置，只要是同一个服务名，所有的class(client)配置都一样

feign.client.config.goods.connectTimeout = 3000
feign.client.config.goods.readTimeou = 3000
/**
* 商品服务品牌模块
**/
@FeignClient(name = "goods", path = "brand")
public interface GoodsBrandFeign{}
/**
* 商品服务文章模块
**/
@FeignClient(name = "goods", path = "article")
public interface GoodsArticle {}

需要格外提防在同一个服务名称，多个class级别配置的configuration会因为名称相同不为null的configuration被其他为null的configuration覆盖而不生效，如下面的例子Options配置根本不会生效

public class GoodsBrandFeignConfiguration {
  @Bean
  public Options options() {
    return new Request.Options(4000, 4000);  
  }
}
/**
* 商品服务品牌模块
**/
@FeignClient(name = "goods", path = "brand", configuration = GoodsBrandFeignConfiguration.class)
public interface GoodsBrandFeign{}
/**
* 商品服务文章模块，因为此client configuration为空，而name与GoodsBrandFeign都为goods，造成覆盖了GoodsBrandFeignConfiguration配置，所以4000根本不会生效
**/
@FeignClient(name = "goods", path = "article")
public interface GoodsArticle {}

个人推荐方式，升级版本>=2.1.0，最好参考spring cloud官网的release train

/**
* 商品品牌feign独立配置
**/
public class GoodsBrandFeignConfiguration {
  @Bean
  public Options options() {
    return new Request.Options(4000, 4000);  
  }
}
/
/**
* 商品服务品牌模块
**/
@FeignClient(name = "goods", contextId = "brand", path = "brand", configuration = GoodsBrandFeignConfiguration.class)
public interface GoodsBrandFeign{}

/**
* 商品文章feign独立配置
**/
public class GoodsArticleFeignConfiguration {
  @Bean
  public Options options() {
    return new Request.Options(5000, 5000);  
  }
}
/
/**
* 商品服务文章模块
**/
@FeignClient(name = "goods", contextId = "article", path = "article", configuration = GoodsArticleFeignConfiguration.class)
public interface GoodsArticleFeign {}

甚至还可以在properties中再次单独覆盖配置

feign:
  client:
    config:
      brand:
        connectTimeout: 7000
        readTimeout: 7000
      article:
        connectTimeout: 8000
        readTimeout: 8000

通过以上配置我们就可以做到了基于class(client)级别的细粒度任意独立配置了，loggerLevel,retryer,errorDecoder,requestInterceptors,decode404,decoder,encoder,contract,exceptionPropagationPolicy这么多的配置都可以完全自定义了。