FeignClient源码深度解析
概述
Spring Cloud Feign 主要对 Netflix Feign 进行了增强和包装。本文将从源码角度梳理 Feign 的装配流程,揭开其底层实现机制。内容主要涵盖 Feign 与 Ribbon、Hystrix、Sleuth 的整合过程,以及生成的代理类最终注入 Spring 容器的完整链路。本文篇幅较长,建议耐心阅读。
Feign 架构图
以下是核心类及大致流程的架构图:

大体步骤:
- 注册 FeignClient 配置类和 FeignClient BeanDefinition
- 实例化 Feign 上下文对象 FeignContext
- 创建 Feign.builder 对象
- 生成负载均衡代理类
- 生成默认代理类
- 注入到 Spring 容器
源码分析
本节将围绕上述六个步骤进行详细分析。
一、注册 FeignClient 配置类和 FeignClient BeanDefinition
从启动类注解开始,首先查看 @EnableFeignClients 注解:
@EnableFeignClients
public class MyApplication {
}这是在启动类开启 Feign 装配的注解。跟进该注解,可以看到其导入了 FeignClientsRegistrar 类:
@Import(FeignClientsRegistrar.class)
public class FeignClientsRegistrar implements ImportBeanDefinitionRegistrar,
ResourceLoaderAware, BeanClassLoaderAware {
// patterned after Spring Integration IntegrationComponentScanRegistrar
// and RibbonClientsConfigurationRegistgrar
private final Logger logger = LoggerFactory.getLogger(FeignClientsRegistrar.class);
private ResourceLoader resourceLoader;
private ClassLoader classLoader;
public FeignClientsRegistrar() {
}
@Override
public void setResourceLoader(ResourceLoader resourceLoader) {
this.resourceLoader = resourceLoader;
}
@Override
public void setBeanClassLoader(ClassLoader classLoader) {
this.classLoader = classLoader;
}
@Override
public void registerBeanDefinitions(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
// 1、先注册默认配置
registerDefaultConfiguration(metadata, registry);
// 2、注册所有的 FeignClient BeanDefinition
registerFeignClients(metadata, registry);
}
//...
}我们分别来看 registerBeanDefinitions 中的两个核心方法。
1. 注册默认配置方法:registerDefaultConfiguration
private void registerDefaultConfiguration(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
Map<String, Object> defaultAttrs = metadata
.getAnnotationAttributes(EnableFeignClients.class.getName(), true);
if (defaultAttrs != null && defaultAttrs.containsKey("defaultConfiguration")) {
String name;
if (metadata.hasEnclosingClass()) {
name = "default." + metadata.getEnclosingClassName();
} else {
name = "default." + metadata.getClassName();
}
// name 默认以 default 开头,后续会根据名称选择配置
registerClientConfiguration(registry, name,
defaultAttrs.get("defaultConfiguration"));
}
}上述方法用于读取启动类上 @EnableFeignClients 注解中声明的 Feign 相关配置类。默认 name 为 default,一般情况下无需配置,使用默认的 FeignAutoConfiguration 即可。
其中比较重要的方法是注册配置 registerClientConfiguration。启动流程一共有两处读取 Feign 配置类,这是第一处。该方法代码如下:
private void registerClientConfiguration(BeanDefinitionRegistry registry, Object name,
Object configuration) {
BeanDefinitionBuilder builder = BeanDefinitionBuilder
.genericBeanDefinition(FeignClientSpecification.class);
builder.addConstructorArgValue(name);
builder.addConstructorArgValue(configuration);
registry.registerBeanDefinition(
name + "." + FeignClientSpecification.class.getSimpleName(),
builder.getBeanDefinition());
}上述代码将 Bean 配置类包装成 FeignClientSpecification 并注入到容器。该对象非常重要,包含 FeignClient 需要的重试策略、超时策略、日志等配置。如果某个服务没有设置特定配置,则读取默认配置。
2. 扫描 FeignClient
该方法主要是扫描类路径,对所有的 FeignClient 生成对应的 BeanDefinition:
public void registerFeignClients(AnnotationMetadata metadata,
BeanDefinitionRegistry registry) {
//...
// 获取扫描目录下面所有的 BeanDefinition
for (String basePackage : basePackages) {
Set<BeanDefinition> candidateComponents = scanner
.findCandidateComponents(basePackage);
for (BeanDefinition candidateComponent : candidateComponents) {
if (candidateComponent instanceof AnnotatedBeanDefinition) {
// verify annotated class is an interface
AnnotatedBeanDefinition beanDefinition = (AnnotatedBeanDefinition) candidateComponent;
AnnotationMetadata annotationMetadata = beanDefinition.getMetadata();
Assert.isTrue(annotationMetadata.isInterface(),
"@FeignClient can only be specified on an interface");
Map<String, Object> attributes = annotationMetadata
.getAnnotationAttributes(
FeignClient.class.getCanonicalName());
String name = getClientName(attributes);
// 这里是第二处调用注册配置
registerClientConfiguration(registry, name,
attributes.get("configuration"));
// 注册 FeignClient
registerFeignClient(registry, annotationMetadata, attributes);
}
}
}
}可以看到这里又调用了 registerClientConfiguration 注册配置的方法,这是第二处调用。这里主要是将扫描目录下每个项目的配置类加载到容器当中。注册到容器中的配置何时使用,后续会有介绍。
回到主流程,继续查看注册 FeignClient 的方法 registerFeignClient:
private void registerFeignClient(BeanDefinitionRegistry registry,
AnnotationMetadata annotationMetadata, Map<String, Object> attributes) {
String className = annotationMetadata.getClassName();
// 声明代理类名称
BeanDefinitionBuilder definition = BeanDefinitionBuilder
.genericBeanDefinition(FeignClientFactoryBean.class);
// logger.info("TEX do some replacement");
// attributes.put("value", ((String)attributes.get("value")).replace('_','-'));
validate(attributes);
definition.addPropertyValue("url", getUrl(attributes));
definition.addPropertyValue("path", getPath(attributes));
String name = getName(attributes);
definition.addPropertyValue("name", name);
definition.addPropertyValue("type", className);
definition.addPropertyValue("decode404", attributes.get("decode404"));
definition.addPropertyValue("fallback", attributes.get("fallback"));
definition.setAutowireMode(AbstractBeanDefinition.AUTOWIRE_BY_TYPE);
String alias = name + "FeignClient";
AbstractBeanDefinition beanDefinition = definition.getBeanDefinition();
beanDefinition.setPrimary(true);
BeanDefinitionHolder holder = new BeanDefinitionHolder(beanDefinition, className,
new String[]{alias});
// 将 BeanDefinition 加入到 Spring 容器
BeanDefinitionReaderUtils.registerBeanDefinition(holder, registry);
}值得注意的是,上面出现了一行相当关键的代码:
BeanDefinitionBuilder definition = BeanDefinitionBuilder.genericBeanDefinition(FeignClientFactoryBean.class);Spring Cloud FeignClient 其实是利用了 Spring 的代理工厂来生成代理类,所以这里将所有的 FeignClient 的描述信息 BeanDefinition 设定为 FeignClientFactoryBean 类型。该类继承自 FactoryBean,很明显这是一个代理工厂类。在 Spring 中,FactoryBean 是一个工厂 Bean,用作创建代理 Bean。因此得出结论:Feign 将所有的 FeignClient Bean 包装成 FeignClientFactoryBean。扫描方法到此结束。
代理类什么时候会触发生成呢?
在 Spring 刷新容器时,当实例化我们的业务 Service 时,如果发现注册了 FeignClient,Spring 就会去实例化该 FeignClient,同时会进行判断是否是代理 Bean。如果为代理 Bean,则调用 FeignClientFactoryBean 的 T getObject() throws Exception; 方法生成代理 Bean。
二、实例化 Feign 上下文对象 FeignContext
接下来详细介绍 FeignClientFactoryBean,后续步骤都基于此类。首先查看代理 FeignClient 生成的入口:getObject 方法。
@Override
public Object getObject() throws Exception {
// 二、实例化 Feign 上下文对象 FeignContext
FeignContext context = applicationContext.getBean(FeignContext.class);
// 三、生成 builder 对象,用来生成 Feign
Feign.Builder builder = feign(context);
// 判断生成的代理对象类型,如果 url 为空,则走负载均衡,生成有负载均衡功能的代理类
if (!StringUtils.hasText(this.url)) {
String url;
if (!this.name.startsWith("http")) {
url = "http://" + this.name;
} else {
url = this.name;
}
url += cleanPath();
// 四、生成负载均衡代理类
return loadBalance(builder, context, new HardCodedTarget<>(this.type,
this.name, url));
}
// 如果指定了 url,则生成默认的代理类
if (StringUtils.hasText(this.url) && !this.url.startsWith("http")) {
this.url = "http://" + this.url;
}
String url = this.url + cleanPath();
// 五、生成默认代理类
return targeter.target(this, builder, context, new HardCodedTarget<>(
this.type, this.name, url));
}getObject() 逻辑较多,每一行都会做一些初始化配置,下面逐步分析。上述方法中第一行便是实例化 FeignContext:
FeignContext context = applicationContext.getBean(FeignContext.class);
获取 FeignContext 对象,如果没有实例化,则主动实例化,如下:
@Configuration
@ConditionalOnClass(Feign.class)
public class FeignAutoConfiguration {
@Autowired(required = false)
private List<FeignClientSpecification> configurations = new ArrayList<>();
@Bean
public HasFeatures feignFeature() {
return HasFeatures.namedFeature("Feign", Feign.class);
}
@Bean
public FeignContext feignContext() {
FeignContext context = new FeignContext();
// 将 Feign 的配置类设置到 Feign 的容器当中
context.setConfigurations(this.configurations);
return context;
}
}可以看到 Feign 的配置类被设置到 Feign 的容器当中,而集合中的元素正是上面提到的两处调用 registerClientConfiguration 方法添加进去的,前后呼应。
然而,当我们引入了 Sleuth 之后,获取的 FeignContext 却是 TraceFeignClientAutoConfiguration 中配置的实例 sleuthFeignContext:

可以看到上面创建了一个 TraceFeignContext 实例。因为该对象继承 FeignContext,同时又加了 @Primary 注解,所以在上面第 2 步中通过类型获取 applicationContext.getBean(FeignContext.class); 时,最终拿到的是 TraceFeignContext。
三、构造 FeignBuilder
继续跟进该方法:Feign.Builder builder = feign(context);
protected Feign.Builder feign(FeignContext context) {
Logger logger = getOptional(context, Logger.class);
if (logger == null) {
logger = new Slf4jLogger(this.type);
}
// 1、构造 Feign.Builder
Feign.Builder builder = get(context, Feign.Builder.class)
// required values
.logger(logger)
.encoder(get(context, Encoder.class))
.decoder(get(context, Decoder.class))
.contract(get(context, Contract.class));
// 2、设置重试策略,log 等组件
// 设置 log 级别
Logger.Level level = getOptional(context, Logger.Level.class);
if (level != null) {
builder.logLevel(level);
}
// 设置重试策略
Retryer retryer = getOptional(context, Retryer.class);
if (retryer != null) {
builder.retryer(retryer);
}
// Feign 的错误 code 解析接口
ErrorDecoder errorDecoder = getOptional(context, ErrorDecoder.class);
if (errorDecoder != null) {
builder.errorDecoder(errorDecoder);
}
// 超时时间设置,连接超时时间:connectTimeout 默认 10s,请求超时时间:readTimeout 默认 60s
Request.Options options = getOptional(context, Request.Options.class);
if (options != null) {
builder.options(options);
}
// 拦截器设置,可以看出拦截器也是可以针对单独的 FeignClient 设置
Map<String, RequestInterceptor> requestInterceptors = context.getInstances(
this.name, RequestInterceptor.class);
if (requestInterceptors != null) {
builder.requestInterceptors(requestInterceptors.values());
}
if (decode404) {
builder.decode404();
}
return builder;
}上述代码有两处逻辑,分别来看:
1. Feign.Builder builder = get(context, Feign.Builder.class)
这里会有以下三种情况:
单独使用 Feign,没有引入 Sleuth、Hystrix:
通过加载FeignClientsConfiguration的配置创建 Feign 的静态内部类:Feign.Builder@Bean @Scope("prototype") @ConditionalOnMissingBean public Feign.Builder feignBuilder(Retryer retryer) { return Feign.builder().retryer(retryer); }引入了 Hystrix,没有引入 Sleuth:
通过加载FeignClientsConfiguration的配置创建HystrixFeign的静态内部类:HystrixFeign.Builder@Configuration @ConditionalOnClass({HystrixCommand.class, HystrixFeign.class}) protected static class HystrixFeignConfiguration { @Bean @Scope("prototype") @ConditionalOnMissingBean @ConditionalOnProperty(name = "feign.hystrix.enabled", matchIfMissing = false) public Feign.Builder feignHystrixBuilder() { return HystrixFeign.builder(); } }同时引入 Hystrix 和 Sleuth:
加载TraceFeignClientAutoConfiguration的配置创建:HystrixFeign.Builder
注意:
TraceFeignClientAutoConfiguration的配置类加载一定是在FeignClientsConfiguration之前(先加载先生效),而FeignClientsConfiguration加载是通过FeignAutoConfiguration完成的,所以上图中引入了条件注解:@AutoConfigureBefore({FeignAutoConfiguration.class})
创建的
builder对象和第二种情况一样,只是做了一层包装:final class SleuthFeignBuilder { private SleuthFeignBuilder() {} static Feign.Builder builder(Tracer tracer, HttpTraceKeysInjector keysInjector) { return HystrixFeign.builder() // 各组件 client,retryer,decoder 进行增强,装饰器模式。 .client(new TraceFeignClient(tracer, keysInjector)) .retryer(new TraceFeignRetryer(tracer)) .decoder(new TraceFeignDecoder(tracer)) .errorDecoder(new TraceFeignErrorDecoder(tracer)); } }
2. 设置重试策略,Log 等组件
Feign.builder 在获取之后又分别指定了重试策略、日志级别、错误代码 Code 等。在上一步中调用 SleuthFeignBuilder.build() 时已经设置过默认值了,这里为什么要重复设置呢?
我们跟进去 get() 方法,一探究竟:
protected <T> T get(FeignContext context, Class<T> type) {
// 根据 name,也就是服务名称来生成 builder
T instance = context.getInstance(this.name, type);
if (instance == null) {
throw new IllegalStateException("No bean found of type " + type + " for "
+ this.name);
}
return instance;
}
public <T> T getInstance(String name, Class<T> type) {
// 这里获取 AnnotationConfigApplicationContext 容器
AnnotationConfigApplicationContext context = getContext(name);
if (BeanFactoryUtils.beanNamesForTypeIncludingAncestors(context,
type).length > 0) {
return context.getBean(type);
}
return null;
}
private Map<String, AnnotationConfigApplicationContext> contexts = new ConcurrentHashMap<>();
protected AnnotationConfigApplicationContext getContext(String name) {
if (!this.contexts.containsKey(name)) {
synchronized (this.contexts) {
if (!this.contexts.containsKey(name)) {
// 这里创建容器 createContext(name)
this.contexts.put(name, createContext(name));
}
}
}
return this.contexts.get(name);
}重点来了,上述代码将 FeignContext 做了缓存,每个服务对应一个 FeignContext,服务名作为 Key。继续跟进 createContext(name) 方法:
protected AnnotationConfigApplicationContext createContext(String name) {
// 注意:这里的容器并不是 Spring 的容器,而是每次都重新创建一个
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
// 加载每个服务对应的配置类
if (this.configurations.containsKey(name)) {
for (Class<?> configuration : this.configurations.get(name)
.getConfiguration()) {
context.register(configuration);
}
}
// 加载启动类@EnableFeignClients 注解指定的配置类
for (Map.Entry<String, C> entry : this.configurations.entrySet()) {
if (entry.getKey().startsWith("default.")) {
for (Class<?> configuration : entry.getValue().getConfiguration()) {
context.register(configuration);
}
}
}
// 注册默认的配置类:FeignClientsConfiguration
context.register(PropertyPlaceholderAutoConfiguration.class,
this.defaultConfigType);
context.getEnvironment().getPropertySources().addFirst(new MapPropertySource(
this.propertySourceName,
Collections.<String, Object> singletonMap(this.propertyName, name)));
if (this.parent != null) {
// Uses Environment from parent as well as beans
context.setParent(this.parent);
}
// 刷新容器
context.refresh();
return context;
}可以看到上述 AnnotationConfigApplicationContext 容器并非 Spring 主容器,只是利用了 Spring 刷新容器的方法来实例化配置类,以服务名作为 Key,实现配置隔离。
重点: 上面加载配置的顺序为:先加载每个服务的配置类,然后加载启动类注解上的配置类,最后加载默认的配置类。这样做有什么好处?Spring 刷新容器的方法也是对所有的 Bean 进行了缓存,如果已经创建,则不再实例化。所以优先选取每个 FeignClient 的配置类,最后默认的配置类兜底。
这也证明了 Sleuth 的配置一定在 Feign 的配置类之前加载。至此,FeignBuilder 构造流程结束。
四、生成负载均衡代理类
再贴一下生成代理类的入口:
// 判断 url 是否为空
if (!StringUtils.hasText(this.url)) {
//......
return loadBalance(builder, context, new HardCodedTarget<>(this.type,
this.name, url));
}
//......
return targeter.target(this, builder, context, new HardCodedTarget<>(
this.type, this.name, url));这里有个重要判断:判断 FeignClient 声明的 url 是否为空,来决定具体要生成的代理类。这么做有什么意义?
- 如果为空,则默认走 Ribbon 代理,也就是这个入口,会有加载 Ribbon 的处理。例如:
@FeignClient("MyFeignClient") - 如果不为空,指定 url,则走默认生成代理类的方式,也就是所谓的硬编码。例如:
@FeignClient(value = "MyFeignClient", url = "http://localhost:8081")
这样处理方便开发人员进行测试,无需关注注册中心,直接 HTTP 调用,是个不错的开发小技巧。
生产环境也可以用上述第二种方式,指定域名的方式。
我们跟进 loadBalance 方法:
protected <T> T loadBalance(Feign.Builder builder, FeignContext context,
HardCodedTarget<T> target) {
// 获得 FeignClient
Client client = getOptional(context, Client.class);
if (client != null) {
builder.client(client);
return targeter.target(this, builder, context, target);
}
throw new IllegalStateException(
"No Feign Client for loadBalancing defined. Did you forget to include spring-cloud-starter-ribbon?");
}Client client = getOptional(context, Client.class); 这里会从 FeignContext 上下文中获取 Client 对象,该对象有三种实例,具体是哪个实现呢?

这里又会有三种情况:
- 没有整合 Ribbon、Sleuth: 获取默认的
Client:Default实例。 - 整合了 Ribbon,没有整合 Sleuth: 获取
LoadBalanceFeignClient实例。
整合了 Ribbon 和 Sleuth: 会获取
TraceFeignClient实例,该实例是对LoadBalanceFeignClient的一种包装,实现方式通过BeanPostProcessor实现:FeignBeanPostProcessor中定义了包装逻辑:@Override public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException { return this.traceFeignObjectWrapper.wrap(bean); }通过
wrap方法最终返回TraceFeignClient实例。
继续回到主流程,先来看下 Targeter 接口:
interface Targeter {
<T> T target(FeignClientFactoryBean factory, Feign.Builder feign, FeignContext context,
HardCodedTarget<T> target);
}该对象定义在 FeignClientFactoryBean 静态代码块中:
private static final Targeter targeter;
static {
Targeter targeterToUse;
// 判断类路径是否引入了 HystrixFeign
if (ClassUtils.isPresent("feign.hystrix.HystrixFeign",
FeignClientFactoryBean.class.getClassLoader())) {
targeterToUse = new HystrixTargeter();
} else {
targeterToUse = new DefaultTargeter();
}
targeter = targeterToUse;
}这里会初始化 Targeter,该类是生成 Feign 代理类的工具类,有两种实现,正是上面的 HystrixTargeter, DefaultTargeter。因为我们引入了 Hystrix,所以 Targeter 实现类为 HystrixTargeter。我们继续跟进 targeter.target 方法:
public <T> T target(Target<T> target) {
return build().newInstance(target);
}上面通过 build() 方法获取生成代理类的工具类 ReflectiveFeign,再通过 newInstance 正式创建代理类。继续跟进:
public Feign build() {
SynchronousMethodHandler.Factory synchronousMethodHandlerFactory =
new SynchronousMethodHandler.Factory(client, retryer, requestInterceptors, logger,
logLevel, decode404);
ParseHandlersByName handlersByName =
new ParseHandlersByName(contract, options, encoder, decoder,
errorDecoder, synchronousMethodHandlerFactory);
return new ReflectiveFeign(handlersByName, invocationHandlerFactory);
}这里会创建 Feign 的方法工厂 synchronousMethodHandlerFactory, Feign 通过该工厂为每个方法创建一个 methodHandler,每个 methodHandler 中包含 Feign 对应的配置:retryer、requestInterceptors 等。
继续跟进 newInstance 方法:
public <T> T newInstance(Target<T> target) {
// 创建所有的 MethodHandler
Map<String, MethodHandler> nameToHandler = targetToHandlersByName.apply(target);
Map<Method, MethodHandler> methodToHandler = new LinkedHashMap<Method, MethodHandler>();
List<DefaultMethodHandler> defaultMethodHandlers = new LinkedList<DefaultMethodHandler>();
for (Method method : target.type().getMethods()) {
if (method.getDeclaringClass() == Object.class) {
continue;
// 判断是否启用默认 handler
} else if (Util.isDefault(method)) {
DefaultMethodHandler handler = new DefaultMethodHandler(method);
defaultMethodHandlers.add(handler);
methodToHandler.put(method, handler);
} else {
methodToHandler.put(method, nameToHandler.get(Feign.configKey(target.type(), method)));
}
}
// 创建 InvocationHandler,接收请求,转发到 methodHandler
InvocationHandler handler = factory.create(target, methodToHandler);
// 生成代理类
T proxy = (T) Proxy.newProxyInstance(target.type().getClassLoader(), new Class<?>[]{target.type()}, handler);
// 将默认方法绑定到代理类
for (DefaultMethodHandler defaultMethodHandler : defaultMethodHandlers) {
defaultMethodHandler.bindTo(proxy);
}
return proxy;
}InvocationHandler 最终创建的实例为 HystrixInvocationHandler,核心方法如下:
HystrixCommand<Object> hystrixCommand = new HystrixCommand<Object>(setter) {
@Override
protected Object run() throws Exception {
try {
return HystrixInvocationHandler.this.dispatch.get(method).invoke(args);
} catch (Exception e) {
throw e;
} catch (Throwable t) {
throw (Error) t;
}
}
@Override
protected Object getFallback() {
//......
}
};整个流程:Feign 调用方发起请求,发送至 Hystrix 的 HystrixInvocationHandler,通过服务名称,找到对应方法的 methodHandler,methodHandler 中封装了 loadBalanceClient、retryer、RequestInterceptor 等组件。如果引入了 Sleuth,这几个组件均是 Sleuth 的包装类。然后通过以上组件构造 HTTP 请求完成整个过程。
五、生成默认代理类
理解了第四步的逻辑,生成默认代理类就很容易理解了,唯一不同点就是 client 的实现类为 loadBalanceClient。
注意:不管是哪种代理类,最终发起请求还是由Feign.Default中的execute方法完成,默认使用HttpUrlConnection实现。
六、注入 Spring 容器
总结: 通过 Spring refresh() 方法,触发 FeignClientFactoryBean.getObject() 方法获得了代理类,然后完成注入 Spring 容器的过程。该实现方式同 Dubbo 的实现方式类似,有兴趣的读者可自行研究。
更多阅读
说明
本文基于 Spring Cloud 早期版本(如 Finchley/Greenwich 等)编写,文中涉及的 Netflix Ribbon、Hystrix 组件在新版本 Spring Cloud 中已逐步被 Spring Cloud LoadBalancer 和 Resilience4j 取代。源码分析逻辑适用于理解 Feign 核心机制,但具体类名与配置方式在新版本中可能有所变化。
版权声明:本文为原创文章,版权归 戴老师的博客 所有,转载请联系博主获得授权。
本文地址:https://1diff.fun/archives/feignclient-yuan-ma-shen-du-jie-xi.html
如果对本文有什么问题或疑问都可以在评论区留言,我看到后会尽量解答。