Feign核心源码解析

Hydra大约 7 分钟Spring CloudFeign

Feign作为一个声明式的Http服务客户端，通过接口加注解的方式，就能够完成对服务提供方接口的调用，极大的简化了我们在调用服务时的工作。

那么在只有接口的条件下，Feign是如何基于接口实现服务调用的呢？在之前的代理模式及mybatis实现原理的文章中，我们知道了可以通过动态代理的方式生成代理对象。Feign是否这样实现的呢，我们从源码角度进行分析。

1、初始化阶段

首先看一下Feign的开启注解@EnableFeignClients：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Import(FeignClientsRegistrar.class)
public @interface EnableFeignClients {
  String[] value() default {};
  String[] basePackages() default {};
  Class<?>[] basePackageClasses() default {};
  Class<?>[] defaultConfiguration() default {};
  Class<?>[] clients() default {};
}

@Import导入了FeignClientsRegistrar，该类实现了ImportBeanDefinitionRegistrar接口，在该接口的registerBeanDefinitions方法中，spring向外暴露了BeanDefinitionRegistry注册器。

用户如果需要手动创建或修改BeanDefinition，可以通过把BeanDefinition注册到BeanDefinitionRegistry的方式，之后spring会帮我们实例化bean并放在容器中。

里面两个方法中，registerDefaultConfiguration方法主要用于读取配置信息，我们主要看一下registerFeignClients方法的实现：

这里首先定义了一个扫描器，并读取@EnableFeignClients注解的属性，配置FeignClient的注解类型过滤器，用以在后面进行进行包扫描操作。

通过扫描，得到所有在basepackage定义的路径下的被@FeignClient注解标记的类的BeanDefinition。

读取@FeignClient注解的内容，并存放在一个Map中，由于我在注解中只指定了name，因此只存在name和value的值（value通过@AliasFor指定为name的别名）

之后，调用registerFeignClient方法：

注意这里通过BeanDefinitionBuilder创建的是一个FeignClientFactoryBean类型的工厂bean，注意通过它的getObject返回的才是我们的FeignClient。之后通过BeanDefinitionBuilder填充FeignClient对象的属性，并获得BeanDefinition。

这里的BeanDefinitionHolder可以理解为BeanDefinition的包装类，提供了根据beanName获取BeanDefinition的方法，可以理解为额外加了一层封装。

完成属性填充后，通过Spring提供的registerBeanDefinition方法向BeanDefinitionRegistry注册了刚实例化的这个BeanDefinitionHolder。这里完成的是将FeignClient注解的类的信息交给工厂bean代理类，并将代理类的定义注册到Spring的容器中。

至此，已经把要创建的接口代理对象的信息放入registry里面，之后spring在启动调用refresh方法的时候会负责bean的实例化。在实例化过程中，调用FeignClientFactoryBean的getObject方法：

其中调用了loadBalance方法：

这里创建的Client实例是一个LoadBalancerFeignClient的对象。Client是一个非常重要的组件，看一下配置类中注入的实例：

@Configuration
class DefaultFeignLoadBalancedConfiguration {
 @Bean
 @ConditionalOnMissingBean
 public Client feignClient(CachingSpringLoadBalancerFactory cachingFactory,
               SpringClientFactory clientFactory) {
   return new LoadBalancerFeignClient(new Client.Default(null, null),
       cachingFactory, clientFactory);
 }
}

在没有配置Client的情况下，会注入一个LoadBalancerFeignClient，其中delegate属性中注入了一个Client$Default对象，我们可以暂时理解为代理，后面就会讲到，Feign发送Request请求以及接收Response响应，都是借助Client$Default对象完成的。

可以回想一下之前Ribbon中讲过的RibbonLoadBalancerClient，Ribbon是使用拦截器后调用了它的execute方法。那么我们可以猜测一下，这里是不是使用什么方式最终了调用LoadBalancerFeignClient的execute方法呢？这个问题我们放在后面去证实。

2、创建代理对象

接着看上面loadBalance方法中，首先调用了HystrixTargeter的target方法：

之后调用了Feign的target方法：

最终调用了ReflectiveFeign类中的newInstance方法。其中名为nameToHandler的Map中存储了FeignClient接口中定义的方法：

看到下面的InvocationHandler和Proxy就很清楚了，和我们在开头说的一样，这里是使用JDK动态代理的方式创建代理对象。创建InvocationHandler及代理对象过程

这里的factory是InvocationHandlerFactory的对象，看一下它的create方法，用于创建FeignInvocationHandler实例来对方法进行拦截。在构造方法中传入了代理类的接口，以及需要代理的方法：

3、拦截方法

通过JDK动态代理我们知道，在InvocationHandler中，invoke方法对进行方法拦截和逻辑增强。那么我们使用一个测试接口，看一下关键的invoke方法是如何工作的：

首先根据方法名去判断是不是Object类内置的一些方法，都不是则往下，执行了一个分发的操作，这个dispatch是初始化阶段生成的MethodHandler列表。调用SynchronousMethodHandler类的invoke方法：

使用RequestTemplate创建了一个http请求的模板，可以看见这里创建了一个请求：

GET /user/1 HTTP/1.1

进入executeAndDecode方法，在该方法中，首先使用刚才创建的模板生成了一个Request请求，并且把我们本次调用的服务名和接口名拼接在了一起：

这里把请求交给了之前创建的LoadBalancerFeignClient，执行了它的execute方法。和开头说的一样，和Ribbon类似的调用流程。只不过需要区别一下的是，Ribbon是使用拦截器拦截请求，而Feign是使用动态代理的invoke方法对方法进行拦截并转发。

进入LoadBalancerFeignClient的execute方法，在其中构建了一个RibbonRequest的请求：

在上面的uriWithoutHost中，去除了url中的服务名。这么做是因为Feign其实只需要这个服务后面的接口字符串，至于如何选择服务与负载均衡，都交给了Ribbon去做。

进入RibbonRequest的构造方法中，可以看见，用的Client的实现类是Client$Default对象，即前面讲到的在配置文件中，LoadBalancerFeignClient中delegate存储的对象。

调用AbstractLoadBalancerAwareClient的executeWithLoadBalancer方法：

进入其submit方法：

进入selectServer方法：

进入LoadBalancerContext的getServerFromLoadBalancer方法：

在这里结合了Ribbon，完成负载均衡，根据负载均衡算法选择Server。之后通过调用FeignLoadBalancer的execute方法，再调用Client$Default的execute方法：

调用convertAndSend创建了一个HttpURLConnection的连接，最后发起远程调用还是用的HttpURLConnection，并在convertResponse方法中封装结果，至此一次调用过程完成。

到这里，我们就能明白为什么说Feign是一个Web客户端并不准确，其实它并没有完成任何请求处理操作，只是一个伪客户端，最终还是调用其他组件完成的请求发送与接收。

总结

最后，对Feign的实现流程进行一下总结：

1、使用JDK动态代理为接口创建代理对象

2、执行接口的方法时，调用代理对象的invoker方法

3、读取FeignClient的注解得到要调用的远程服务的接口

4、通过Ribbon负载均衡得到一个要调用的服务提供者

5、使用HttpURLConnection发起请求，得到响应

Feign核心源码解析

# 1、初始化阶段

# 2、创建代理对象

# 3、拦截方法

# 总结

1、初始化阶段

2、创建代理对象

3、拦截方法

总结