源码深度剖析SpringBoot启动流程中开启OpenFeign的入口（ImportBeanDefinitionRegistrar详解）

一、前言

最近在研究OpenFeign源码时，@EnableFeignClients注解中会通过@Import注解导入一个ImportBeanDefinitionRegistrar接口的实现类FeignClientsRegistrar，出于好奇又回头研究了一下SpringBoot启动流程中处理@Import的逻辑，在此记录一下。

我们在SpringBoot启动流程系列聊了以下内容：

1> 《SpringBoot启动流程一》：万字debug梳理SpringBoot如何加载并处理META-INF/spring.factories文件中的信息；
2> 《SpringBoot启动流程二》：七千字源码分析SpringApplication构造阶段；
3> 《SpringBoot启动流程三》：两万+字图文带你debug源码分析SpringApplication准备阶段（含配置文件加载时机、日志系统初始化时机）；
4> 《SpringBoot启动流程四》：图文带你debug源码分析SpringApplication运行阶段和运行后阶段。
5> 《SpringBoot启动流程五》：你真的知道SpringBoot自动装配原理吗（两万字图文源码分析）；
6> SpringBoot自动装配时做条件装配的原理；
7> 源码分析SpringBoot如何内嵌并启动Tomcat服务器的；

在《SpringBoot启动流程五》：你真的知道SpringBoot自动装配原理吗（两万字图文源码分析）；一文中我们聊了在哪里会解析@Import注解，并处理其中自动装配相关的内容（即DeferredImportSelector接口的实现类），本文我们接着讨论如何处理@Import注解导入的ImportBeanDefinitionRegistrar接口实现类。

二、ImportBeanDefinitionRegistrar介绍

ImportBeanDefinitionRegistrar是spring对外提供的动态注册beanDefinition的接口，并且spring内部大多也用该接口动态注册beanDefinition。

1. ImportBeanDefinitionRegistrar接口的Bean不会直接注册到IOC容器，它的执行时机比较早，发生在SpringBoot启动流程的注册BeanDefinition时；
2. ImportBeanDefinitionRegistrar接口提供了registerBeanDefinitions(AnnotationMetadata, BeanDefinitionRegistry)供子类重写；
   • 开发者可以直接调用BeanDefinitionRegistry#registerBeanDefinition()方法传入BeanDefinitionName和对应的BeanDefinition对象，直接往Spring临时容器（beanDefinitionMap）中注册。
   • 所谓的Spring临时容器是指：在Spring解析类时会将所有符合注册要求的类放到一个临时容器中，后续执行完BeanPostProcessor、initMessageSource、initApplicationEventMulticaster、onRefresh等操作之后，才会从临时容器中取出所有类，真正注入到Spring容器（singletonObjects）中。

此外，ImportBeanDefinitionRegistrar 通常和@Import注解配合使用，@Import注解将ImportBeanDefinitionRegistrar的实现类注入到@Import所属根类的ConfigurationClass属性中，在注册跟类的BeanDefinition时，会遍历调用其@Import的所有ImportBeanDefinitionRegistrar接口的 registerBeanDefinitions()方法。

三、ImportBeanDefinitionRegistrar在SpringBoot启动流程中的体现？

建议大家先把SpringBoot启动流程系列看完，然后再看这里，不然有可能会存在一些困惑。

1、处理ImportBeanDefinitionRegistrar的入口

在SpringBoot启动流程中，通过ConfigurationClassParser#doProcessConfigurationClass()解析启动类的注解时，会做@Import注解的process操作，即进入到ConfigurationClassParser#processImports()方法；

具体代码执行流程参考博文：《SpringBoot启动流程五》：你真的知道SpringBoot自动装配原理吗（两万字图文源码分析）。

另外debug的项目是我们在OpenFeign系列中的案例（SpringCloud之Feign实现声明式客户端负载均衡详细案例）。

扫描二维码关注公众号，回复： 14375541 查看本文章

2、将ImportBeanDefinitionRegistrar添加到所属ConfigClass的一个属性上

进入到ConfigurationClassParser#processImports()方法中，就启动类FeignConsumerApplication而言，它直接或间接一共@Import了三个类，分别如下：

其中FeignClientsRegistrar实现了ImportBeanDefinitionRegistrar接口，FeignClientsRegistrar类图如下：

下面接着看processImports()方法针对ImportBeanDefinitionRegistrar接口的具体处理逻辑；

processImports()方法中会判断如果一个类A实现了ImportBeanDefinitionRegistrar接口，会对类A做实例化，并将其存储到当前ConfigClass的一个属性（Map类型的变量importBeanDefinitionRegistrars）中，以在注册ConfigurationClass到Spring容器时，拿出importBeanDefinitionRegistrars中的所有内容，执行每个ImportBeanDefinitionRegistrar的registerBeanDefinitions()方法。

就FeignClientsRegistrar而言，会将其添加到启动类FeignConsumerApplication属性中，具体添加过程如下：

到这里，@Import的内容解析也就结束了，后面会根据@Import解析出的内容再做处理（即：执行ImportBeanDefinitionRegistrar接口方法）。

3、执行ImportBeanDefinitionRegistrar接口方法的时机

解析完所有的candidates候选类之后，会进入到ConfigurationClassBeanDefinitionReader#loadBeanDefinitions(Set<ConfigurationClass>)方法对所有的ConfigurationClass做条件装配、属性处理，然后将相应BeanDefinition注册到Spring中。

代码执行流程如下：

代码逻辑解释：

在加载并注册启动类的BeanDefinition时，会将启动类ConfigurationClass下的一些属性进行解析处理，其中就包括对@Import的所有ImportBeanDefinitionRegistrar接口方法进行执行。

就FeignClientsRegistrar而言，其实现的ImportBeanDefinitionRegistrar接口方法执行流程如下：

这里逻辑就很简单，ImportBeanDefinitionRegistrar接口提供了一个“模板方法”供子类实现。

最后走到FeignClientsRegistrar中，也就进入到了开启OpenFeign的入口。

四、后续文章

本篇文章我们讨论了在SpringBoot启动流程中开启OpenFeign的入口，下一篇文章，我们接着讨论OpenFeign如何扫描所有的FeignClient？如何生成FeignClient的代理类？