从本篇blog开始,笔者开始开始分析IoC容器的依赖注入过程。
1、依赖注入发生的时间有两个:
A、用户第一次调用getBean方法时;
B、<Bean/>配置了lazy-init属性,在IoC容器初始化的时候就发生了;
2、具体看一下第一种,用户第一次调用getBean方法时发生的依赖注入。Spring容器实现了很多的BeanFactory,并且实现了很多getBean方法的重载,但是通过跟踪代码发现,它们很多都是最后调用AbstractBeanFactory 中的doGetBean方法实现的
AOPTest test = context.getBean("test", AOPTest.class);// 用户代码
// AbstractBeanFactory
// getBean很多重载方法
// 但是这些方法都是调用AbstractBeanFactory的doGetBean方法
@Override
public <T> T getBean(String name, Class<T> requiredType) throws BeansException {
return doGetBean(name, requiredType, null, false);
}
// AbstractBeanFactory
// 返回指定bean可能单例或多例的实例。
@SuppressWarnings("unchecked")
protected <T> T doGetBean(
final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly)
throws BeansException {
// 把传递过来的name(可能是别名)转换为beanName
final String beanName = transformedBeanName(name);
Object bean;
// 检查目标bean是否是单例
// 如果是单例且已经存在,则直接获取,不再重复创建
Object sharedInstance = getSingleton(beanName);
// IoC容器实现单例的bean
if (sharedInstance != null && args == null) {
if (logger.isDebugEnabled()) {
if (isSingletonCurrentlyInCreation(beanName)) {
logger.debug("Returning eagerly cached instance of singleton bean '" + beanName +
"' that is not fully initialized yet - a consequence of a circular reference");
}
else {
logger.debug("Returning cached instance of singleton bean '" + beanName + "'");
}
}
// 获取给定bean实例的对象,
// 无论是bean实例本身,都是FactoryBean创建的对象
// 包括完成FactoryBean的相关处理
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
else {
// 缓存没有创建的单例状态的bean
// 如果我们已经创建了这个bean实例,则失败
// 我们假设在一个循环引用。
if (isPrototypeCurrentlyInCreation(beanName)) {
throw new BeanCurrentlyInCreationException(beanName);
}
// 在当前BeanFactory是否存在指定的BeanDefinition
// 如果没有,就获取父类BeanFactory
BeanFactory parentBeanFactory = getParentBeanFactory();
//
if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
// 如果工厂里没有BeanDefinition,且父类BeanFactory存在
// 把传递过来的name(可能是别名)转换为beanName
String nameToLookup = originalBeanName(name);
if (args != null) {
//使用显式参数向父BeanFactory查找实例
return (T) parentBeanFactory.getBean(nameToLookup, args);
}
else {
// 没有参数,根据类型和名字通过父BeanFactory查找实例
return parentBeanFactory.getBean(nameToLookup, requiredType);
}
}
// 创建的Bean类型创建
if (!typeCheckOnly) {
// 把bIoC容器的这个bean标记为已经创建
markBeanAsCreated(beanName);
}
try {
// 获取一个合并的根BeanDefinition,如果指定的bean对应一个子bean定义,则遍历父bean的定义。
final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
checkMergedBeanDefinition(mbd, beanName, args);
// 获取依赖的bean的name
String[] dependsOn = mbd.getDependsOn();
if (dependsOn != null) {
// 遍历依赖bean的name
for (String dep : dependsOn) {
// 判断是否循环依赖
if (isDependent(beanName, dep)) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
}
// 在目标bean创建之前创建依赖bean
registerDependentBean(dep, beanName);
// 递归调用创建依赖bean
getBean(dep);
}
}
// 待创建的BeanDefinition是单例
if (mbd.isSingleton()) {
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
// 创建一个bean实例,
// 并实现bean实例填充,应用后处理器等。
// 如果有父类,则合并
return createBean(beanName, mbd, args);
}
catch (BeansException ex) {
//明确地从单例缓存中移除实例;
//它可能已经更早的被创建过程,
//以允许循环引用解析。
//还要删除接收到bean的临时引用的bean。
destroySingleton(beanName);
throw ex;
}
}
});
// 获取给定bean实例的对象,
// 无论是bean实例本身,还是FactoryBean创建的对象。
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
// 多例情况下
else if (mbd.isPrototype()) {
// 使用原型模式prototype,每次都创建一个新对象
Object prototypeInstance = null;
try {
// 原型创建之前的回调。
// 默认实现在创建时注册当前的原型。
beforePrototypeCreation(beanName);
// 创建一个指定的bean对象实例
prototypeInstance = createBean(beanName, mbd, args);
}
finally {
// 原型创建后回调。
// 默认实现将原型标记为不在创建中。
afterPrototypeCreation(beanName);
}
bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
}
// 不是Singleton和Prototype
// 那么就是其他的生命周期Session、request和global
// 例如:Session、request和global session中的一种
else {
// 获得作用域名
String scopeName = mbd.getScope();
final Scope scope = this.scopes.get(scopeName);
// 作用域名为空则bean的定义不合法
if (scope == null) {
throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
}
try {
// 使用一个匿名内部类
// 获取一个指定生命周期的目标bean
Object scopedInstance = scope.get(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
beforePrototypeCreation(beanName);
try {
return createBean(beanName, mbd, args);
}
finally {
afterPrototypeCreation(beanName);
}
}
});
bean = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
}
catch (IllegalStateException ex) {
throw new BeanCreationException(beanName,
"Scope '" + scopeName + "' is not active for the current thread; consider " +
"defining a scoped proxy for this bean if you intend to refer to it from a singleton",
ex);
}
}
}
catch (BeansException ex) {
cleanupAfterBeanCreationFailure(beanName);
throw ex;
}
}
// 检查创建的Bean实例的类型
if (requiredType != null && bean != null && !requiredType.isAssignableFrom(bean.getClass())) {
try {
return getTypeConverter().convertIfNecessary(bean, requiredType);
}
catch (TypeMismatchException ex) {
if (logger.isDebugEnabled()) {
logger.debug("Failed to convert bean '" + name + "' to required type '" +
ClassUtils.getQualifiedName(requiredType) + "'", ex);
}
throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
}
}
return (T) bean;
}
通过分析doGetBean方法的源码,可以看出该方法主要是描述了依赖注入的基本流程:
A. 如果是单例,先检测容器中是否已经创建,如果已经创建就直接返回。
B. 检测依赖项的完整性。
C. 按照bean的作用域,采用不同创建策略。
3、接下来具体看一下bean的创建过程,具体的代码实现是在AbstractAutowireCapableBeanFactory中的createBean方法中实现,这里同样是采用了委托模式,父类调用,子类实现。
接下来看一下该方法的源码:
// AbstractAutowireCapableBeanFactory
// 实现相关的AbstractBeanFactory模板方法
// 创建一个bean实例
// 并实现bean实例填充,应用后处理器等。
@Override
protected Object createBean(String beanName, RootBeanDefinition mbd, Object[] args) throws BeanCreationException {
if (logger.isDebugEnabled()) {
logger.debug("Creating instance of bean '" + beanName + "'");
}
RootBeanDefinition mbdToUse = mbd;
// 确保bean类实际上是在这个时候被解析的,
// 并且在一个动态解析的Class的情况下克隆bean定义,
// 这个Class不能被存储在共享的合并bean定义中。
Class<?> resolvedClass = resolveBeanClass(mbd, beanName);
if (resolvedClass != null && !mbd.hasBeanClass() && mbd.getBeanClassName() != null) {
mbdToUse = new RootBeanDefinition(mbd);
mbdToUse.setBeanClass(resolvedClass);
}
// 校验覆盖方法
try {
mbdToUse.prepareMethodOverrides();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(mbdToUse.getResourceDescription(),
beanName, "Validation of method overrides failed", ex);
}
try {
//获得一个代理对象而不是目标bean实例
Object bean = resolveBeforeInstantiation(beanName, mbdToUse);
if (bean != null) {
return bean;
}
}
catch (Throwable ex) {
throw new BeanCreationException(mbdToUse.getResourceDescription(), beanName,
"BeanPostProcessor before instantiation of bean failed", ex);
}
// 真正创建bean的方法入口
Object beanInstance = doCreateBean(beanName, mbdToUse, args);
if (logger.isDebugEnabled()) {
logger.debug("Finished creating instance of bean '" + beanName + "'");
}
return beanInstance;
}
在这个方法的源码中如果可以获取一个代理对象就直接返回,如果得到为空,则在AbstractAutowireCapableBeanFactory 中的doCreateBean方法中创建。
4、实际创建bean的过程
// AbstractAutowireCapableBeanFactory
// 实际创建bean的过程
protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final Object[] args)
throws BeanCreationException {
// 对带创建的bean进行封装
BeanWrapper instanceWrapper = null;
if (mbd.isSingleton()) {
// 单例模式,先获取工厂中缓存的instanceWrapper
// 同时删除缓存在工厂中的instanceWrapper
instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
}
if (instanceWrapper == null) {
// 没有在缓存中获取到instanceWrapper
// 创建一个
instanceWrapper = createBeanInstance(beanName, mbd, args);
}
// 获取目标instanceWrapper的对象 为空就返回空
final Object bean = (instanceWrapper != null ? instanceWrapper.getWrappedInstance() : null);
// 获取目标instanceWrapper的类型 为空就返回空
Class<?> beanType = (instanceWrapper != null ? instanceWrapper.getWrappedClass() : null);
mbd.resolvedTargetType = beanType;
// 允许后处理器修改合并(父类)的BeanDefinition。
synchronized (mbd.postProcessingLock) {
if (!mbd.postProcessed) {
try {
applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName);
}
catch (Throwable ex) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Post-processing of merged bean definition failed", ex);
}
mbd.postProcessed = true;
}
}
// 向容器缓存单例bean对象,防止解析循环引用,
boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
isSingletonCurrentlyInCreation(beanName));
if (earlySingletonExposure) {
if (logger.isDebugEnabled()) {
logger.debug("Eagerly caching bean '" + beanName +
"' to allow for resolving potential circular references");
}
//通过尽早的持有对象来防止循环引用
addSingletonFactory(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
return getEarlyBeanReference(beanName, mbd, bean);
}
});
}
// bean对象初始化
// exposedObject就是返回的目标结果
// 也是依赖注入的结果
Object exposedObject = bean;
try {
//使用BeanDefinition中的属性值在给定的BeanWrapper中填充bean实例。
populateBean(beanName, mbd, instanceWrapper);
if (exposedObject != null) {
//初始化给定的bean实例,
//应用工厂回调以及init方法和bean后期处理器。
exposedObject = initializeBean(beanName, exposedObject, mbd);
}
}
catch (Throwable ex) {
if (ex instanceof BeanCreationException && beanName.equals(((BeanCreationException) ex).getBeanName())) {
throw (BeanCreationException) ex;
}
else {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Initialization of bean failed", ex);
}
}
if (earlySingletonExposure) {
// 获取给定名称注册的(原始)单例对象。
// 同时检查已经实例化的单例,
// 并且还允许提前引用一个当前创建的单例(解析循环引用)。
Object earlySingletonReference = getSingleton(beanName, false);
if (earlySingletonReference != null) {
// 根据名称获取已经注册的bean和正在注册的bean是同一个
if (exposedObject == bean) {
// 完成当前bean的初始化
exposedObject = earlySingletonReference;
}
// 当前bean还依赖其他bean
// 并且发送了循环依赖导致无法创建新的实例对象
else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) {
String[] dependentBeans = getDependentBeans(beanName);
Set<String> actualDependentBeans = new LinkedHashSet<String>(dependentBeans.length);
// 获取当前bean的其他对象,逐个进行类型检查
for (String dependentBean : dependentBeans) {
// 找出所有已经创建的bean,并从缓存工厂删除
if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) {
// 保存确实依赖的bean实例
actualDependentBeans.add(dependentBean);
}
}
// 发生循环依赖
if (!actualDependentBeans.isEmpty()) {
throw new BeanCurrentlyInCreationException(beanName,
"Bean with name '" + beanName + "' has been injected into other beans [" +
StringUtils.collectionToCommaDelimitedString(actualDependentBeans) +
"] in its raw version as part of a circular reference, but has eventually been " +
"wrapped. This means that said other beans do not use the final version of the " +
"bean. This is often the result of over-eager type matching - consider using " +
"'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example.");
}
}
}
}
// Register bean as disposable.
//将给定的bean添加到此工厂中的一次性bean列表中,
//注册其DisposableBean接口
//或在工厂关闭时调用的给定销毁方法(如果适用)。
//只适用于单例。
try {
registerDisposableBeanIfNecessary(beanName, bean, mbd);
}
catch (BeanDefinitionValidationException ex) {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
}
return exposedObject;
}
上面的代码逻辑很清晰:
createBeanInstance(beanName, mbd, args);生成一个目标Bean对象实例。
populateBean(beanName, mbd,instanceWrapper);对目标对象实现属性依赖。
,生成目标对象exposedObject,同时完成在IoC容器的注册