Java SpringCloudOpenFeignFeignClient

一、@EnableFeignClinets作用源码剖析

要使用feign,必须要使用@EnableFeignClinets来激活,这个注解其实就是整个feign的入口,接下来着重分析一下这个注解干了什么事。

  1. @Retention(RetentionPolicy.RUNTIME)
  2. @Target(ElementType.TYPE)
  3. @Documented
  4. @Import(FeignClientsRegistrar.class)
  5. public @interface EnableFeignClients {
  6. }

这个注解通过@Import注解导入一个配置类FeignClientsRegistrar.classFeignClientsRegistrar实现了ImportBeanDefinitionRegistrar接口,所以Spring Boot在启动的时候,会去调用FeignClientsRegistrar类中的registerBeanDefinitions来动态往spring容器中注入bean。
接下来看一下registerBeanDefinitions的实现

  1. @Override
  2. public void registerBeanDefinitions(AnnotationMetadata metadata,
  3. BeanDefinitionRegistry registry)
  4. //这个方式是注入一些配置,就是对EnableFeignClients注解属性的解析
  5. registerDefaultConfiguration(metadata, registry);
  6. //这个方法是扫秒加了@FeignClient注解
  7. registerFeignClients(metadata, registry);
  8. }

这里着重分析registerFeignClients,看一看是如何扫描@FeignClient注解的,然后扫描到之后又做了什么。

  1. public void registerFeignClients(AnnotationMetadata metadata,
  2. BeanDefinitionRegistry registry) {
  3. ClassPathScanningCandidateComponentProvider scanner = getScanner();
  4. scanner.setResourceLoader(this.resourceLoader);
  5. Set<String> basePackages;
  6. Map<String, Object> attrs = metadata
  7. .getAnnotationAttributes(EnableFeignClients.class.getName());
  8. AnnotationTypeFilter annotationTypeFilter = new AnnotationTypeFilter(
  9. FeignClient.class);
  10. final Class<?>[] clients = attrs == null ? null
  11. : (Class<?>[]) attrs.get("clients");
  12. if (clients == null || clients.length == 0) {
  13. scanner.addIncludeFilter(annotationTypeFilter);
  14. basePackages = getBasePackages(metadata);
  15. }
  16. else {
  17. final Set<String> clientClasses = new HashSet<>();
  18. basePackages = new HashSet<>();
  19. for (Class<?> clazz : clients) {
  20. basePackages.add(ClassUtils.getPackageName(clazz));
  21. clientClasses.add(clazz.getCanonicalName());
  22. }
  23. AbstractClassTestingTypeFilter filter = new AbstractClassTestingTypeFilter() {
  24. @Override
  25. protected boolean match(ClassMetadata metadata) {
  26. String cleaned = metadata.getClassName().replaceAll("\\$", ".");
  27. return clientClasses.contains(cleaned);
  28. }
  29. };
  30. scanner.addIncludeFilter(
  31. new AllTypeFilter(Arrays.asList(filter, annotationTypeFilter)));
  32. }
  33. for (String basePackage : basePackages) {
  34. Set<BeanDefinition> candidateComponents = scanner
  35. .findCandidateComponents(basePackage);
  36. for (BeanDefinition candidateComponent : candidateComponents) {
  37. if (candidateComponent instanceof AnnotatedBeanDefinition) {
  38. // verify annotated class is an interface
  39. AnnotatedBeanDefinition beanDefinition = (AnnotatedBeanDefinition) candidateComponent;
  40. AnnotationMetadata annotationMetadata = beanDefinition.getMetadata();
  41. Assert.isTrue(annotationMetadata.isInterface(),
  42. "@FeignClient can only be specified on an interface");
  43. Map<String, Object> attributes = annotationMetadata
  44. .getAnnotationAttributes(
  45. FeignClient.class.getCanonicalName());
  46. String name = getClientName(attributes);
  47. registerClientConfiguration(registry, name,
  48. attributes.get("configuration"));
  49. registerFeignClient(registry, annotationMetadata, attributes);
  50. }
  51. }
  52. }
  53. }

这段代码分析一下,先获取到了一个ClassPathScanningCandidateComponentProvider这个对象,这个对象是按照一定的规则来扫描指定目录下的类的,符合这个规则的每个类,会生成一个BeanDefinition
获取到ClassPathScanningCandidateComponentProvider对象,配置这个对象,指定这个对象需要扫描出来标有@FeignClient注解的类;随后解析EnableFeignClients注解,获取内部的属性,获取到指定的需要扫描包路径下,如果没有指定的,那么就默认是当前注解所在类的所在目录及子目录。
然后就遍历每个目录,找到每个标有@FeignClient注解的类,对每个类就生成一个BeanDefinition,可以把BeanDefinition看成对每个标有@FeignClient注解的类信息的封装。
拿到一堆BeanDefinition之后,会遍历BeanDefinition,然后调用registerClientConfigurationregisterFeignClient方法。
接下来分别剖析一下这两个方法的作用
**registerClientConfiguration**

  1. private void registerClientConfiguration(BeanDefinitionRegistry registry, Object name,
  2. Object configuration) {
  3. BeanDefinitionBuilder builder = BeanDefinitionBuilder
  4. .genericBeanDefinition(FeignClientSpecification.class);
  5. builder.addConstructorArgValue(name);
  6. builder.addConstructorArgValue(configuration);
  7. registry.registerBeanDefinition(
  8. name + "." + FeignClientSpecification.class.getSimpleName(),
  9. builder.getBeanDefinition());
  10. }

这里的作用就是拿出在@FeignClient指定的配置类,也就是configuration属性,然后构建一个bean class为FeignClientSpecification,传入配置。这个类的最主要作用就是将每个Feign的客户端的配置类封装成一个FeignClientSpecificationBeanDefinition,注册到spring容器中。记住这个FeignClientSpecification,后面会有用。
registerFeignClient:

  1. private void registerFeignClient(BeanDefinitionRegistry registry,
  2. AnnotationMetadata annotationMetadata, Map<String, Object> attributes) {
  3. String className = annotationMetadata.getClassName();
  4. BeanDefinitionBuilder definition = BeanDefinitionBuilder
  5. .genericBeanDefinition(FeignClientFactoryBean.class);
  6. validate(attributes);
  7. definition.addPropertyValue("url", getUrl(attributes));
  8. definition.addPropertyValue("path", getPath(attributes));
  9. String name = getName(attributes);
  10. definition.addPropertyValue("name", name);
  11. String contextId = getContextId(attributes);
  12. definition.addPropertyValue("contextId", contextId);
  13. definition.addPropertyValue("type", className);
  14. definition.addPropertyValue("decode404", attributes.get("decode404"));
  15. definition.addPropertyValue("fallback", attributes.get("fallback"));
  16. definition.addPropertyValue("fallbackFactory", attributes.get("fallbackFactory"));
  17. definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
  18. String alias = contextId + "FeignClient";
  19. AbstractBeanDefinition beanDefinition = definition.getBeanDefinition();
  20. boolean primary = (Boolean) attributes.get("primary"); // has a default, won't be
  21. // null
  22. beanDefinition.setPrimary(primary);
  23. String qualifier = getQualifier(attributes);
  24. if (StringUtils.hasText(qualifier)) {
  25. alias = qualifier;
  26. }
  27. BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition, className,
  28. new String[] { alias });
  29. BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);
  30. }

registerFeignClient这个方法很重要,来说一下大概做了哪些事。重新构造了一个BeanDefinition,这个BeanDefinition的指定的class类型是FeignClientFactoryBean,这个类实现了FactoryBean接口,对spring有一定了解的小伙伴应该知道,spring在生成bean的时候,判断BeanDefinition中bean的class如果是FactoryBean的实现的话,会调用这个实现类的getObject来获取对象。
到这一步,@EnableFeignClinets的作用就说完了。这个类的主要作用是扫描指定(不指定就默认路径下的)所有加了@FeignClient注解的类,然后每个类都会生成一个BeanDefinition,随后遍历每个BeanDefinition,然后取出每个@FeignClient注解的属性,构造新的BeanDefinition,传入FeignClientFactoryBean的class,随后注入到spring容器中;同时有配置类的也会将配置类构件出一个bean class为FeignClientSpecificationBeanDefinition注入到spring容器中。
为了便于理解,这里画个图来总结一下这个注解干了什么事。
SpringCloud原理:OpenFeign之FeignClient动态代理生成原理 - 图1

二、Feign客户端接口动态代理的生成源码剖析

(1)FeignAutoConfiguration源码剖析

FeignAutoConfiguration是feign在整个springcloud的配置类,拎出这里面比较核心的代码。

  1. @Autowired(required = false)
  2. private List<FeignClientSpecification> configurations = new ArrayList<>();
  3. @Bean
  4. public FeignContext feignContext() {
  5. FeignContext context = new FeignContext();
  6. context.setConfigurations(this.configurations);
  7. return context;
  8. }

注入了一堆FeignClientSpecificationFeignClientSpecification这玩意就是上文提到的调用registerClientConfiguration的时候注入到spring容器中的,一个Feign客户端的配置一个FeignClientSpecification,所以是个集合,然后封装到FeignContext中,最后将FeignContext注入到spring容器中。
FeignContext也是很重要的一个东西,来分析一下它的源码

  1. public class FeignContext extends NamedContextFactory<FeignClientSpecification> {
  2. public FeignContext() {
  3. super(FeignClientsConfiguration.class, "feign", "feign.client.name");
  4. }
  5. }

FeignContext继承了NamedContextFactory,构造的时候,传入了FeignClientsConfiguration,这个也很重要,来分析它们的作用。

(2)NamedContextFactory源码剖析

先来说结论,NamedContextFactory的作用是用来进行配置隔离的,ribbon和feign的配置隔离都依赖这个抽象类。
何为配置隔离,因为每个Feign客户端都有可能有自己的配置,从@FeignClient注解的属性configuration可以看出,所以写了这个类,用来隔离每个客户端的配置,这就是为什么在构造FeignContext传入一堆FeignClientSpecification的原因,这里封装了每个客户端的配置类。
那是怎么实现的呢,拎出来一部分核心的源码,不重要的就忽略了。

  1. public abstract class NamedContextFactory<C extends NamedContextFactory.Specification>
  2. implements DisposableBean, ApplicationContextAware {
  3. private final String propertySourceName;
  4. private final String propertyName;
  5. private Map<String, AnnotationConfigApplicationContext> contexts = new ConcurrentHashMap<>();
  6. private Map<String, C> configurations = new ConcurrentHashMap<>();
  7. //父类 ApplicationContext ,也就是springboot所使用的ApplicationContext
  8. private ApplicationContext parent;
  9. // 这个是默认的额配置类
  10. private Class<?> defaultConfigType;
  11. public NamedContextFactory(Class<?> defaultConfigType, String propertySourceName,
  12. String propertyName) {
  13. this.defaultConfigType = defaultConfigType;
  14. this.propertySourceName = propertySourceName;
  15. this.propertyName = propertyName;
  16. }
  17. @Override
  18. public void setApplicationContext(ApplicationContext parent) throws BeansException {
  19. this.parent = parent;
  20. }
  21. public void setConfigurations(List<C> configurations) {
  22. for (C client : configurations) {
  23. this.configurations.put(client.getName(), client);
  24. }
  25. }
  26. public Set<String> getContextNames() {
  27. return new HashSet<>(this.contexts.keySet());
  28. }
  29. protected AnnotationConfigApplicationContext getContext(String name) {
  30. if (!this.contexts.containsKey(name)) {
  31. synchronized (this.contexts) {
  32. if (!this.contexts.containsKey(name)) {
  33. this.contexts.put(name, createContext(name));
  34. }
  35. }
  36. }
  37. return this.contexts.get(name);
  38. }
  39. protected AnnotationConfigApplicationContext createContext(String name) {
  40. AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
  41. if (this.configurations.containsKey(name)) {
  42. for (Class<?> configuration : this.configurations.get(name)
  43. .getConfiguration()) {
  44. context.register(configuration);
  45. }
  46. }
  47. for (Map.Entry<String, C> entry : this.configurations.entrySet()) {
  48. if (entry.getKey().startsWith("default.")) {
  49. for (Class<?> configuration : entry.getValue().getConfiguration()) {
  50. context.register(configuration);
  51. }
  52. }
  53. }
  54. context.register(PropertyPlaceholderAutoConfiguration.class,
  55. this.defaultConfigType);
  56. context.getEnvironment().getPropertySources().addFirst(new MapPropertySource(
  57. this.propertySourceName,
  58. Collections.<String, Object>singletonMap(this.propertyName, name)));
  59. if (this.parent != null) {
  60. // Uses Environment from parent as well as beans
  61. context.setParent(this.parent);
  62. // jdk11 issue
  63. // https://github.com/spring-cloud/spring-cloud-netflix/issues/3101
  64. context.setClassLoader(this.parent.getClassLoader());
  65. }
  66. context.setDisplayName(generateDisplayName(name));
  67. context.refresh();
  68. return context;
  69. }
  70. /**
  71. * Specification with name and configuration.
  72. */
  73. public interface Specification {
  74. String getName();
  75. Class<?>[] getConfiguration();
  76. }
  77. }

分析一下每个成员变量的作用:

  • **contexts** 一个客户端一个对应的AnnotationConfigApplicationContext
  • **configurations**: 一个客户端一个配置类的封装,对应到Feign的就是FeignClientSpecification
  • **parent** springboot真正启动的就是这个ApplicationContext
  • **defaultConfigType** 默认的配置类,对应Feign就是构造FeignContext是传入的FeignClientsConfiguration

分析一下核心的方法:
**getContext**:这个方法很简单,就是根据客户端名称从contexts获取对应的AnnotationConfigApplicationContext,获取不到就去创建一个,然后放入contexts
**createContext**:就是直接new了一个AnnotationConfigApplicationContext对象,然后按照按照配置的优先级顺序,一步步放入配置类,最后放入parent容器,也就是说每个客户端对应的容器,都有一个共同的父容器,同时如果每个客户端对应的容器获取不到的配置,都会再次从父容器中获取。这个结论还是很重要的。
其实所谓的配置隔离就是为每个客户端构建一个AnnotationConfigApplicationContext,然后基于这个ApplicationContext来解析配置类,这样就实现了配置隔离。
不知道大家有么有遇到过这个坑,就是在spring cloud环境中,监听类似ContextRefreshedEvent这种事件的时候,这个事件会无缘无故地触发很多次,其实就是这个原因就在这,因为spring的事件是有传播机制的,每个客户端对应的容器都要进行refresh,refresh完就会发这个事件,然后这个事件就会传给parent容器,也就是springboot启动的容器,就会再次触发,所以如果客户端很多,那么就会触发很多次。解决办法就是进行唯一性校验,只能启动一次就行了。

(3)FeignClientsConfiguration源码剖析

说完NamedContextFactory,接下来说一下FeignClientsConfiguration的作用。
这是一个默认的配置类,里面配置了很多bean,这些bean都是生成Feign客户端动态代理的需要的,说几个重要的。

  1. @Bean
  2. @ConditionalOnMissingBean
  3. public Contract feignContract(ConversionService feignConversionService) {
  4. return new SpringMvcContract(this.parameterProcessors, feignConversionService);
  5. }

这个的主要作用是用来解析@FeignClient接口中每个方法使用的springmvc的注解的,这也就是为什么FeignClient可以识别springmvc注解的原因。

  1. @Bean
  2. @Scope("prototype")
  3. @ConditionalOnMissingBean
  4. public Feign.Builder feignBuilder(Retryer retryer) {
  5. return Feign.builder().retryer(retryer);
  6. }

用来构建动态代理的类,通过这个类的target方法,就能生成Feign动态代理

  1. @Configuration(proxyBeanMethods = false)
  2. @ConditionalOnClass({ HystrixCommand.class, HystrixFeign.class })
  3. protected static class HystrixFeignConfiguration {
  4. @Bean
  5. @Scope("prototype")
  6. @ConditionalOnMissingBean
  7. @ConditionalOnProperty(name = "feign.hystrix.enabled")
  8. public Feign.Builder feignHystrixBuilder() {
  9. return HystrixFeign.builder();
  10. }
  11. }

这个是FeignClientsConfiguration的内部类,是用来整合hystrix的,@ConditionalOnProperty(name = "feign.hystrix.enabled"),当在配置文件配置了feign.hystrix.enabled=true的时候,就开启了hystrix整合了Feign,然后调用Feign的接口就有了限流、降级的功能。
其实hystrix整合Feign很简单,就是在构造动态代理的时候加了点东西而已。其实不光是hystrix,spring cloud alibaba中的sentinel在整合Feign的适合也是按照这个套路来的。

(4)构建动态代理的过程源码剖析

说完了前置的内容,接下来就来看一看动态代理是如何生成的。从上面已经知道了,@EnableFeignClinets会扫描出每个加了@FeignClient注解的接口,然后生成对应的BeanDefinition,最后重新生成一个bean class为FeignClientFactoryBeanBeanDefinition,注册到spring容器。
接下来就会根据BeanDefinition来生成feign客户端的代理对象了。上面提到,是通过FeignClientFactoryBeangetObject方法来获取到代理对象,接下来,就来着重分析一下getObject方法的实现。

  1. @Override
  2. public Object getObject() throws Exception {
  3. return getTarget();
  4. }

getObject是调用getTarget()来获取代理对象的。
getTarget方法

  1. <T> T getTarget() {
  2. FeignContext context = this.applicationContext.getBean(FeignContext.class);
  3. Feign.Builder builder = feign(context);
  4. if (!StringUtils.hasText(this.url)) {
  5. if (!this.name.startsWith("http")) {
  6. this.url = "http://" + this.name;
  7. }
  8. else {
  9. this.url = this.name;
  10. }
  11. this.url += cleanPath();
  12. return (T) loadBalance(builder, context,
  13. new HardCodedTarget<>(this.type, this.name, this.url));
  14. }
  15. if (StringUtils.hasText(this.url) && !this.url.startsWith("http")) {
  16. this.url = "http://" + this.url;
  17. }
  18. String url = this.url + cleanPath();
  19. Client client = getOptional(context, Client.class);
  20. if (client != null) {
  21. if (client instanceof LoadBalancerFeignClient) {
  22. // not load balancing because we have a url,
  23. // but ribbon is on the classpath, so unwrap
  24. client = ((LoadBalancerFeignClient) client).getDelegate();
  25. }
  26. if (client instanceof FeignBlockingLoadBalancerClient) {
  27. // not load balancing because we have a url,
  28. // but Spring Cloud LoadBalancer is on the classpath, so unwrap
  29. client = ((FeignBlockingLoadBalancerClient) client).getDelegate();
  30. }
  31. builder.client(client);
  32. }
  33. Targeter targeter = get(context, Targeter.class);
  34. return (T) targeter.target(this, builder, context,
  35. new HardCodedTarget<>(this.type, this.name, url));
  36. }

先从ioc容器中获取到FeignContext,FeignContext里面封装了每个Feign的配置,起到配置隔离的作用。
然后获取到一个Feign.Builder,默认是在FeignClientsConfiguration中配置的。然后调用feign方法。

  1. protected Feign.Builder feign(FeignContext context) {
  2. FeignLoggerFactory loggerFactory = get(context, FeignLoggerFactory.class);
  3. Logger logger = loggerFactory.create(this.type);
  4. // @formatter:off
  5. Feign.Builder builder = get(context, Feign.Builder.class)
  6. // required values
  7. .logger(logger)
  8. .encoder(get(context, Encoder.class))
  9. .decoder(get(context, Decoder.class))
  10. .contract(get(context, Contract.class));
  11. // @formatter:on
  12. //这个是从配置文件中读取feign的配置
  13. configureFeign(context, builder);
  14. return builder;
  15. }

这个方法很简单,就是从每个FeignClient对应的ioc容器中获取到对应的组件,填充到 Feign.Builder中,默认都是FeignClientsConfiguration配置的。configureFeign这个方法不用去care它,它是默认从配置文件读取feign的配置,然后对Feign.Builder进行配置,有可能会覆盖从每个FeignClient对应的ioc容器中获取到对应的组件,所以配置文件的优先级是最高的,但是一般没人这么玩,所以就不用担心。
上面获取到的各种组件都是默认的,如果有需要替换什么组件,都可以实现,然后通过@FeignClientconfiguration配置,就可以替换这些组件。
接下来就是走这段代码

  1. if (!StringUtils.hasText(this.url)) {
  2. if (!this.name.startsWith("http")) {
  3. this.url = "http://" + this.name;
  4. }
  5. else {
  6. this.url = this.name;
  7. }
  8. this.url += cleanPath();
  9. return (T) loadBalance(builder, context,
  10. new HardCodedTarget<>(this.type, this.name, this.url));
  11. }

这段代码就是判断有没有指定url,url在哪指定的呢,就是在@FeignClient注解中指定的url属性,这个属性是主要是进行feign直连,什么叫直连,就是不通过注册中心,直接访问服务提供者,这个url就是配置服务提供者的ip和端口。在springcloud环境下,一般这个是不配置的,因为得从注册中心发现服务所在的ip和端口列表。所以从这y也可以看出,没有注册中心,feign也是能够跑的,只要指定服务提供者的ip和端口就行。
所以,一般这个url是空的,也就是会进入这段代码。其实很简单,就是配置一个url,name是服务名,也是在@FeignClient配置的。那这段代码什么意思呢,举个例子来说,假如服务名是ServiceA,那么拼出来就是 http://ServiceA ,就是这么简单。得到url之后就会走loadBalance方法,传入一个HardCodedTarget参数,这个参数是封装了Feign客户端接口的类型、服务的名称、还有刚构建的url,接下来进入loadBalance。

  1. protected <T> T loadBalance(Feign.Builder builder, FeignContext context,
  2. HardCodedTarget<T> target) {
  3. Client client = getOptional(context, Client.class);
  4. if (client != null) {
  5. builder.client(client);
  6. Targeter targeter = get(context, Targeter.class);
  7. return targeter.target(this, builder, context, target);
  8. }
  9. throw new IllegalStateException(
  10. "No Feign Client for loadBalancing defined. Did you forget to include spring-cloud-starter-netflix-ribbon?");
  11. }

这个方法一上来就从feign客户端对应的ioc容器中获取一个Client,但是FeignClientsConfiguration里面没有配置Client这个bean,那是从哪来呢?
其实loadBalance这个方法名就可以想到是负载均衡,所以Client需要整合负载均衡的功能,说到负载均衡,当前优先想到ribbon,所以就引入了FeignRibbonClientAutoConfiguration这个配置类,这个类是Feign整合ribbon的配置类,当然目前来说,负载均衡组件不止ribbon,还有springcloud自己实现的spring-cloud-starter-loadbalancer这个组件,其实原理都是一样的。
这里就默认获取到了Client,那么接下来就放入Feign.Builder中,接下来获取到Targeter,Targeter是通过FeignAutoConfiguration来配置的,默认是DefaultTargeter,如果整合hystrix就需是HystrixTargeter,当然这里就是默认的DefaultTargeter
接下来就会调用DefaultTargeter的target方法

  1. @Override
  2. public <T> T target(FeignClientFactoryBean factory, Feign.Builder feign,
  3. FeignContext context, Target.HardCodedTarget<T> target) {
  4. return feign.target(target);
  5. }

就是直接调用Feign.Builder的tartget方法,那么就进入这个方法

  1. public <T> T target(Target<T> target) {
  2. return build().newInstance(target);
  3. }
  4. public Feign build() {
  5. SynchronousMethodHandler.Factory synchronousMethodHandlerFactory =
  6. new SynchronousMethodHandler.Factory(client, retryer, requestInterceptors, logger,
  7. logLevel, decode404, closeAfterDecode, propagationPolicy);
  8. ParseHandlersByName handlersByName =
  9. new ParseHandlersByName(contract, options, encoder, decoder, queryMapEncoder,
  10. errorDecoder, synchronousMethodHandlerFactory);
  11. return new ReflectiveFeign(handlersByName, invocationHandlerFactory, queryMapEncoder);
  12. }

先调用build方法,这个方法就是将最开始填充到Feign.Builder给封装起来,构建了一个ReflectiveFeign,然后调用ReflectiveFeignnewInstance方法,传入Target<T> target,也就是前面传入的HardCodedTarget

  1. @SuppressWarnings("unchecked")
  2. @Override
  3. public <T> T newInstance(Target<T> target) {
  4. Map<String, MethodHandler> nameToHandler = targetToHandlersByName.apply(target);
  5. Map<Method, MethodHandler> methodToHandler = new LinkedHashMap<Method, MethodHandler>();
  6. List<DefaultMethodHandler> defaultMethodHandlers = new LinkedList<DefaultMethodHandler>();
  7. for (Method method : target.type().getMethods()) {
  8. if (method.getDeclaringClass() == Object.class) {
  9. continue;
  10. } else if (Util.isDefault(method)) {
  11. DefaultMethodHandler handler = new DefaultMethodHandler(method);
  12. defaultMethodHandlers.add(handler);
  13. methodToHandler.put(method, handler);
  14. } else {
  15. methodToHandler.put(method, nameToHandler.get(Feign.configKey(target.type(), method)));
  16. }
  17. }
  18. InvocationHandler handler = factory.create(target, methodToHandler);
  19. T proxy = (T) Proxy.newProxyInstance(target.type().getClassLoader(),
  20. new Class<?>[] {target.type()}, handler);
  21. for (DefaultMethodHandler defaultMethodHandler : defaultMethodHandlers) {
  22. defaultMethodHandler.bindTo(proxy);
  23. }
  24. return proxy;
  25. }

这个方法来解释一下是来干什么的,其实很简单,通过Target拿到接口的类型,然后获取到所有的方法,遍历每个方法,处理之后放入methodToHandler中,然后通过InvocationHandlerFactory的create方法,传入methodToHandlerTarget,获取到一个InvocationHandler,之后通过jdk的动态代理,生成一个代理对象,然后返回回去。InvocationHandler默认是ReflectiveFeign.FeignInvocationHandler,这里就不再继续翻下去了。
走到这里,终于看到了Feign客户端动态代理的生成,整个构造过程还是很复杂的。这里总结一下代理对象生成的过程,每个Feign客户端都有对应的一个spring容器,用来解析配置类,根据配置从容器获取到一个Feign.Builder,然后再从容器中获取每个组件,填充到Feign.Builder中,最后通过Feign.Builder的build方法来构造动态代理,构造的过程其实是属于feign包底下的。

三、总结

本文主要是讲述了,在SpringCloud环境下,OpenFeign对于Feign客户端动态代理的的构造过程。最开始讲解了@EnableFeignClinets注解的作用开始,随后剖析了FeignAutoConfigurationFeignClientsConfiguration配置类,同时提到了Feign对每个客户端都进行了配置的隔离,最后通过剖析FeignClientFactoryBeangetObject方法,来一步一步屡清楚动态代理的构建过程。
最后画一张图,来总结一下本文。
SpringCloud原理:OpenFeign之FeignClient动态代理生成原理 - 图2