3-Spring IoC容器之BeanDefinition和BeanPostProcessor分析(Spring Boot2)

Spring中有个接口org.springframework.beans.factory.config.BeanDefinition，从名字可以看出，他是对Bean的定义。我们知道Spring的核心就是IOC容器的管理，BeanDefinition就是对IoC中存储的Bean的一种定义，一种数据结构，一种访问接口。他下面的具体实现才是真正的细节，先建立这个概念，后面再详细分析各个实现以及相关使用的地方。先来几条规则树立下价值观：

1、BeanDefinition是Spring IoC中对bean的详细定义，包括bean对象的class类型、是否是抽象类、构造方法和参数，Class,Scope，init-methon等信息；

2、IoC中每一个bean都有一个对应的BeanDefinition定义；

3、BeanDefinition的构建时机在bean实例化之前；

4、并不是所有bean的BeanDefinition都是在同一时机建立的，会分顺序先后建立，目前发现这三个方法里会进行BeanDefinition的注册：
SpringApplication#createApplicationContext()、SpringApplication#prepareContext()、SpringApplication#refreshContext()，

下面我们来看看BeanDefinition的初始化过程，org.springframework.context.annotation.AnnotationConfigApplicationContext这个ApplicationContext是启动SpringBoot创建的，看看部分定义，只有两个数据成员，且在无参构造函数里实例化了。

org.springframework.context.annotation.AnnotatedBeanDefinitionReader官方的注释是：一个方便的适配器，用来以编程方式注册带注解的bean(他并不直接将普通bean的BeanDefinition注册，而是通过将指定的BeanPostProcessor的BeanDefition注册来实现)。他是ClassPathBeanDefinitionScanner的替代物，ClassPathBeanDefinitionScanner对注解应用同样的解决方案但是仅针对显式注册的类。

org.springframework.context.annotation.ClassPathBeanDefinitionScanner官方的注释是：一个bean definition的扫描器，检测classpath下的候选bean，并注册相关bean到BeanFactory或者ApplicationContext。候选类通过配置类型过滤器侦测，默认的过滤器会检测加上了@Component，@Repository，@Service，@Controller注解的类，当然也支持Java EE 6的注解javax.annotation.ManagedBean以及 JSR-330的javax.inject.Named注解。

public class AnnotationConfigApplicationContext extends GenericApplicationContext implements AnnotationConfigRegistry {

	private final AnnotatedBeanDefinitionReader reader;

	private final ClassPathBeanDefinitionScanner scanner;


	/**
	 * Create a new AnnotationConfigApplicationContext that needs to be populated
	 * through {@link #register} calls and then manually {@linkplain #refresh refreshed}.
	 */
	public AnnotationConfigApplicationContext() {
		this.reader = new AnnotatedBeanDefinitionReader(this);
		this.scanner = new ClassPathBeanDefinitionScanner(this);
	}
        ......
}

首先我们需要看看DefaultListableBeanFactory的定义，他是我们研究的入口，这里可以看到存储BeanDefinition的数据结构是ConcurrentHashMap：

public class DefaultListableBeanFactory extends AbstractAutowireCapableBeanFactory
		implements ConfigurableListableBeanFactory, BeanDefinitionRegistry, Serializable {
...
	private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap<>(256);

}

需要我们注意的接口是BeanDefinitionRegistry，这个接口定义了注册BeanDefinition等方法，

public interface BeanDefinitionRegistry extends AliasRegistry {
	void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
			throws BeanDefinitionStoreException;
	void removeBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
	BeanDefinition getBeanDefinition(String beanName) throws NoSuchBeanDefinitionException;
	boolean containsBeanDefinition(String beanName);
	String[] getBeanDefinitionNames();
	int getBeanDefinitionCount();
	boolean isBeanNameInUse(String beanName);
}

我们只需要在DefaultListableBeanFactory的实现上打个断点就能够看到调用堆栈了，第一次注册BeanDefinition的时机是：

中间还有很多，

接下来是

AbstractApplicationContext#refresh()，

AbstractApplicationContext#invokeBeanFactoryPostProcessors()，以及最后到了

DefaultListableBeanFactory#registerBeanDefinition()，

需要注意的是这个是自定义bean的BeanDefinition的创建调用链路，还有一些Spring内部使用的bean的BeanDefinition的创建不是这个链路，这里就不讨论这个了。在DefaultListableBeanFactory中实现的registerBeanDefinition()方法，只是对beanDefinitionMap的put操作而已，具体的操作封装在这个长长的链路中，其中有个类型ClassPathBeanDefinitionScanner我们提一下，Mybatis继承了这个类型的，为的是能使用其中的doScan()和checkCandidate()方法。这里我只把链路中涉及的类型罗列一下，调用顺序是上面调用下面的：

AbstractApplicationContext
PostProcessorRegistrationDelegate
ConfigurationClassPostProcessor
ConfigurationClassParser
ComponentScanAnnotationParser
ClassPathBeanDefinitionScanner
BeanDefinitionReaderUtils
DefaultListableBeanFactory

既然这里说到了AbstractApplicationContext#fresh()中的invokeBeanFactoryPostProcessors()方法，那就顺便提下，源码当中的注释是：

Invoke factory processors registered as beans in the context
调用bean factory的处理程序，这些处理程序已经在Spring上下文中了。
/**
 * Instantiate and invoke all registered BeanFactoryPostProcessor beans,
 * respecting explicit order if given.
 * <p>Must be called before singleton instantiation.
 */
实例化并按照给定顺序调用已经注册过的BeanFactoryPostProcessor，必须在单例实例化之前调用。

只说了调用BeanFactoryPostProcessor，完全没有提及BeanDefinition的初始化，原因就是这里有一个BeanDefinitionRegistryPostProcessor(继承了BeanFactoryPostProcessor)，这个接口的一个实现就是ConfigurationClassPostProcessor，看看上面列出来的调用链涉及的类型，里面就有这个类型，这就对接上了。

那这里顺便就说下另外一个知识点BeanPostProcessor接口的使用方式

先来看看BeanPostProcessor接口的定义：

public interface BeanPostProcessor {
    Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException;
    Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException;
}

需要了解的有几点：

1、接口实现给Spring回调；

2、作用范围是Spring接管的所有Bean，spring管理的每个bean在创建时都会循环遍历并执行所有BeanPostProcessor的实现；

3、作用是实例化任意Bean前和后对Bean实例进行修改；

4、返回的Bean会被装入IOC容器；

5、需要将自定义的实现注册到IOC容器才能生效；

6、BeanPostProcessor和容器绑定，对父容器或子容器中Bean不起作用。

掌握以上几点就可以很轻松的使用BeanPostProcessor接口了，这里说说一种使用场景，在多数据源的情况下，且使用了MyBatis的SqlSessionDaoSupport，这时不同的SqlSessionDaoSupport需要注入不同的DataSource，这个时候就可以在实例化Bean时通过注解判断，注入不同的DataSource。

总结：

Spring实现beandefinition的初始化分两次执行

是通过ConfigurationClassPostProcessor这个BeanFactoryPostProcessor实现的。