Spring源码之Bean创建过程

1. 流程图

废话不多说，直接上图！！！

2. AbstractBeanFactory.doGetBean()源码分析

/**
 * 参数说明
 * @param name Bean的名称(有可能是别名或者工厂Bean名称)
 * @param requiredType Bean需要的类型
 * @param args 创建Bean实例时使用的参数
 * @param typeCheckOnly 创建Bean实例是否仅用于类型检查
 */
protected <T> T doGetBean(String name, @Nullable Class<T> requiredType, @Nullable Object[] args, boolean typeCheckOnly) throws BeansException {
    // 转换Bean名称, 请看本文第 3 点
    String beanName = transformedBeanName(name);
    Object beanInstance;

    // 从单例Bean注册器的三级缓存中获取Bean实例, 请看本文第 4 点
    Object sharedInstance = getSingleton(beanName);
    // 若Bean实例不为null且args为null
    if (sharedInstance != null && args == null) {
        if (logger.isTraceEnabled()) {
            if (isSingletonCurrentlyInCreation(beanName)) {
                logger.trace("Returning eagerly cached instance of singleton bean '" + beanName +
                             "' that is not fully initialized yet - a consequence of a circular reference");
            }
            else {
                logger.trace("Returning cached instance of singleton bean '" + beanName + "'");
            }
        }
        // 验证Bean实例, 其目的是判断实例是否为工厂Bean类型, 请看本文第 5 点
        beanInstance = getObjectForBeanInstance(sharedInstance, name, beanName, null);
    }
    // 若Bean实例为null或者args不为null
    else {
        if (isPrototypeCurrentlyInCreation(beanName)) {
            // 若Bean为原型模式且正在被创建则抛出异常, 因为Spring不支持原型模式的循环依赖
            throw new BeanCurrentlyInCreationException(beanName);
        }

        // 获取父容器
        BeanFactory parentBeanFactory = getParentBeanFactory();
        if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
            // 若当前容器不存在Bean名称的Bean定义, 且父容器不为null
            String nameToLookup = originalBeanName(name);
            // 则从父容器中获取实例
            if (parentBeanFactory instanceof AbstractBeanFactory) {
                return ((AbstractBeanFactory) parentBeanFactory).doGetBean(
                    nameToLookup, requiredType, args, typeCheckOnly);
            }
            else if (args != null) {
                return (T) parentBeanFactory.getBean(nameToLookup, args);
            }
            else if (requiredType != null) {
                return parentBeanFactory.getBean(nameToLookup, requiredType);
            }
            else {
                return (T) parentBeanFactory.getBean(nameToLookup);
            }
        }

        // 判断创建Bean实例是否仅用于类型检查, 若不是则对其进行标记为已创建或者即将被创建
        if (!typeCheckOnly) {
            markBeanAsCreated(beanName);
        }

        StartupStep beanCreation = this.applicationStartup.start("spring.beans.instantiate")
            .tag("beanName", name);
        try {
            if (requiredType != null) {
                beanCreation.tag("beanType", requiredType::toString);
            }
            // 获取Bean定义
            RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
            // 判断Bean定义是否为抽象类型, 若是则抛出异常
            checkMergedBeanDefinition(mbd, beanName, args);

            // 获取Bean定义中该Bean实例所依赖的Bean名称集
            // 注意：这里的依赖并不是指@Autowired的依赖，而是指xml中bean标签的depends-on属性或者Bean类型中的@DependsOn注解的值, 该值可用来控制Bean加载顺序
            String[] dependsOn = mbd.getDependsOn();
            if (dependsOn != null) {
                // 循环遍历被依赖的Bean名称集
                for (String dep : dependsOn) {
                    if (isDependent(beanName, dep)) {
                        throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                                        "Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
                    }
                    // 注册被依赖的Bean名称
                    registerDependentBean(dep, beanName);
                    try {
                        // 创建被依赖的Bean实例
                        getBean(dep);
                    }
                    catch (NoSuchBeanDefinitionException ex) {
                        throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                                        "'" + beanName + "' depends on missing bean '" + dep + "'", ex);
                    }
                }
            }

            // 判断Bean定义的作用域
            if (mbd.isSingleton()) {
                // 获取单例Bean实例, 请看本文第 6 点
                sharedInstance = getSingleton(beanName, () -> {
                    try {
                        // 创建Bean, 请看本文第 7 点
                        return createBean(beanName, mbd, args);
                    }
                    catch (BeansException ex) {
                        destroySingleton(beanName);
                        throw ex;
                    }
                });
                beanInstance = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
            }
            
            else if (mbd.isPrototype()) {
                // 创建原型Bean实例
                Object prototypeInstance = null;
                try {
                    beforePrototypeCreation(beanName);
                    prototypeInstance = createBean(beanName, mbd, args);
                }
                finally {
                    afterPrototypeCreation(beanName);
                }
                beanInstance = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
            }
            
            else {
                // 创建其他作用域类型Bean实例, 如: Request作用域、Session作用域、ServletContext作用域等等
                String scopeName = mbd.getScope();
                if (!StringUtils.hasLength(scopeName)) {
                    throw new IllegalStateException("No scope name defined for bean ´" + beanName + "'");
                }
                Scope scope = this.scopes.get(scopeName);
                if (scope == null) {
                    throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
                }
                try {
                    Object scopedInstance = scope.get(beanName, () -> {
                        beforePrototypeCreation(beanName);
                        try {
                            return createBean(beanName, mbd, args);
                        }
                        finally {
                            afterPrototypeCreation(beanName);
                        }
                    });
                    beanInstance = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
                }
                catch (IllegalStateException ex) {
                    throw new ScopeNotActiveException(beanName, scopeName, ex);
                }
            }
        }
        catch (BeansException ex) {
            beanCreation.tag("exception", ex.getClass().toString());
            beanCreation.tag("message", String.valueOf(ex.getMessage()));
            cleanupAfterBeanCreationFailure(beanName);
            throw ex;
        }
        finally {
            beanCreation.end();
        }
    }

    // 根据requiredType匹配Bean实例类型, 并进行返回
    return adaptBeanInstance(name, beanInstance, requiredType);
}

3. AbstractBeanFactory.transformedBeanName()源码分析

/**
 * 参数说明
 * @param name Bean的名称(有可能是别名或者工厂Bean名称)
 */
protected String transformedBeanName(String name) {
    // BeanFactoryUtils.transformedBeanName(name): 若name是工厂Bean名称, 则去掉 & 符号前缀
    // canonicalName(name): 若name是别名, 则循环遍历获取真正的Bean名称
    return canonicalName(BeanFactoryUtils.transformedBeanName(name));
}

4. DefaultSingletonBeanRegistry.getSingleton()源码分析

/**
 * 参数说明
 * @param beanName Bean的名称
 */
public Object getSingleton(String beanName) {
    return getSingleton(beanName, true);
}

/**
 * 参数说明
 * @param beanName Bean的名称
 * @param allowEarlyReference 是否允许提前引用
 */
protected Object getSingleton(String beanName, boolean allowEarlyReference) {
    // 获取一级缓存中的值
    Object singletonObject = this.singletonObjects.get(beanName);
    // 若一级缓存中不存在, 且正在创建的单例Bean缓存中又存在
    if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
        // 获取二级缓存中的值
        singletonObject = this.earlySingletonObjects.get(beanName);
        // 若二级缓存中不存在, 且允许提前引用
        if (singletonObject == null && allowEarlyReference) {
            // 对一级缓存加锁
            synchronized (this.singletonObjects) {
                // 再次获取一级缓存中的值
                singletonObject = this.singletonObjects.get(beanName);
                // 若一级缓存中还是不存在
                if (singletonObject == null) {
                    // 再次获取二级缓存中的值
                    singletonObject = this.earlySingletonObjects.get(beanName);
                    // 若二级缓存中还是不存在
                    if (singletonObject == null) {
                        // 获取三级缓存中的值
                        ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
                        // 若三级缓存中存在
                        if (singletonFactory != null) {
                            // 调用三级缓存的值ObjectFactory实例的getObject()方法生成Bean实例
                            // Bean实例的代理对象就是这里生成的
                            singletonObject = singletonFactory.getObject();
                            // 将生成的Bean实例放入二级缓存
                            this.earlySingletonObjects.put(beanName, singletonObject);
                            // 将三级缓存中的值删除
                            this.singletonFactories.remove(beanName);
                        }
                    }
                }
            }
        }
    }
    return singletonObject;
}

5. AbstractBeanFactory.getObjectForBeanInstance()源码分析

/**
 * 参数说明
 * @param beanInstance Bean实例
 * @param name Bean的名称(有可能是别名或者工厂Bean名称)
 * @param beanName Bean的名称(准确的Bean的名称)
 * @param mbd 合并Bean的定义
 */
protected Object getObjectForBeanInstance(Object beanInstance, String name, String beanName, @Nullable RootBeanDefinition mbd) {
    // 判断name是否为工厂Bean引用, 即name的前缀是否为 & 符号
    if (BeanFactoryUtils.isFactoryDereference(name)) {
        if (beanInstance instanceof NullBean) {
            return beanInstance;
        }
        if (!(beanInstance instanceof FactoryBean)) {
            // 如果name是工厂Bean引用, 但Bean实例不是工厂Bean, 则抛出异常
            throw new BeanIsNotAFactoryException(beanName, beanInstance.getClass());
        }
        if (mbd != null) {
            mbd.isFactoryBean = true;
        }
        // 返回工厂Bean实例
        return beanInstance;
    }

    if (!(beanInstance instanceof FactoryBean)) {
        // 如果name不是工厂Bean引用, Bean实例也不是工厂Bean, 直接返回Bean实例
        return beanInstance;
    }

    Object object = null;
    if (mbd != null) {
        mbd.isFactoryBean = true;
    }
    else {
        // 从工厂Bean创建的实例的缓存factoryBeanObjectCache中获取Bean实例
        object = getCachedObjectForFactoryBean(beanName);
    }
    if (object == null) {
        FactoryBean<?> factory = (FactoryBean<?>) beanInstance;
        if (mbd == null && containsBeanDefinition(beanName)) {
            mbd = getMergedLocalBeanDefinition(beanName);
        }
        boolean synthetic = (mbd != null && mbd.isSynthetic());
        // 从工厂Bean实例创建实例, 并放入缓存factoryBeanObjectCache中
        object = getObjectFromFactoryBean(factory, beanName, !synthetic);
    }
    return object;
}

6. DefaultSingletonBeanRegistry.getSingleton()源码分析

/**
 * 参数说明
 * @param beanName Bean的名称
 * @param singletonFactory 延迟创建单例Bean实例的对象工厂, 因ObjectFactory是一个函数式接口, 所以singletonFactory实际是一个lambda表达式
 */
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
    Assert.notNull(beanName, "Bean name must not be null");
    // 对一级缓存加锁
    synchronized (this.singletonObjects) {
        // 获取一级缓存中的值
        Object singletonObject = this.singletonObjects.get(beanName);
        // 若一级缓存中不存在, 则继续向下执行
        if (singletonObject == null) {
            if (this.singletonsCurrentlyInDestruction) {
                // 若当前是否正在销毁单例Bean实例的指标为true, 则抛出异常
                throw new BeanCreationNotAllowedException(beanName,
                                                          "Singleton bean creation not allowed while singletons of this factory are in destruction " +
                                                          "(Do not request a bean from a BeanFactory in a destroy method implementation!)");
            }
            if (logger.isDebugEnabled()) {
                logger.debug("Creating shared instance of singleton bean '" + beanName + "'");
            }
            // 单例Bean创建前检查, 检查内容为: 
            // 若该Bean正处于创建中, 且检查排除集合中并不包含该Bean名称, 则抛出异常, 否则继续向下执行
            beforeSingletonCreation(beanName);
            boolean newSingleton = false;
            boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
            if (recordSuppressedExceptions) {
                this.suppressedExceptions = new LinkedHashSet<>();
            }
            try {
                // 创建实例, 因lambda表达式里的内容是调用AbstractBeanFactory的createBean抽象方法, 而这个抽象方法的实现是在AbstractAutowireCapableBeanFactory类中, 所以请看本文第 7 点
                singletonObject = singletonFactory.getObject();
                newSingleton = true;
            }
            catch (IllegalStateException ex) {
                singletonObject = this.singletonObjects.get(beanName);
                if (singletonObject == null) {
                    throw ex;
                }
            }
            catch (BeanCreationException ex) {
                if (recordSuppressedExceptions) {
                    for (Exception suppressedException : this.suppressedExceptions) {
                        ex.addRelatedCause(suppressedException);
                    }
                }
                throw ex;
            }
            finally {
                if (recordSuppressedExceptions) {
                    this.suppressedExceptions = null;
                }
                // 单例Bean创建后检查, 检查内容为: 
                // 若该Bean未处于创建中, 且检查排除集合中并不包含该Bean名称, 则抛出异常, 否则继续向下执行
                afterSingletonCreation(beanName);
            }
            if (newSingleton) {
                // 执行到这里表示该Bean已经实例化完成, 且完成了依赖注入和初始化操作
                // 同时将该Bean实例放入一级缓存, 并删除二三级缓存的值
                addSingleton(beanName, singletonObject);
            }
        }
        return singletonObject;
    }
}

7. AbstractAutowireCapableBeanFactory.createBean()源码分析

/**
 * 参数说明
 * @param beanName Bean的名称
 * @param mbd 合并的Bean的定义
 * @param args 创建Bean实例时使用的参数
 */
protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) throws BeanCreationException {
    if (logger.isTraceEnabled()) {
        logger.trace("Creating instance of bean '" + beanName + "'");
    }
    // 创建一个用来使用的Bean的定义
    RootBeanDefinition mbdToUse = mbd;

    // 解析Bean的类型
    Class<?> resolvedClass = resolveBeanClass(mbd, beanName);
    if (resolvedClass != null && !mbd.hasBeanClass() && mbd.getBeanClassName() != null) {
        mbdToUse = new RootBeanDefinition(mbd);
        // 注入Bean的类型
        mbdToUse.setBeanClass(resolvedClass);
    }

    try {
        mbdToUse.prepareMethodOverrides();
    }
    catch (BeanDefinitionValidationException ex) {
        throw new BeanDefinitionStoreException(mbdToUse.getResourceDescription(),
                                               beanName, "Validation of method overrides failed", ex);
    }

    try {
        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);
    }

    try {
        // 执行创建Bean实例, 请看本文第 8 点
        Object beanInstance = doCreateBean(beanName, mbdToUse, args);
        if (logger.isTraceEnabled()) {
            logger.trace("Finished creating instance of bean '" + beanName + "'");
        }
        return beanInstance;
    }
    catch (BeanCreationException | ImplicitlyAppearedSingletonException ex) {
        throw ex;
    }
    catch (Throwable ex) {
        throw new BeanCreationException(
            mbdToUse.getResourceDescription(), beanName, "Unexpected exception during bean creation", ex);
    }
}

8. AbstractAutowireCapableBeanFactory.doCreateBean()源码分析

/**
 * 参数说明
 * @param beanName Bean的名称
 * @param mbd 合并的Bean的定义
 * @param args 创建Bean实例时使用的参数
 */
protected Object doCreateBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) throws BeanCreationException {

    // Bean实例的包装类
    BeanWrapper instanceWrapper = null;
    if (mbd.isSingleton()) {
        instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
    }
    if (instanceWrapper == null) {
        // 创建Bean实例, 请看本文第 9 点
        instanceWrapper = createBeanInstance(beanName, mbd, args);
    }
    Object bean = instanceWrapper.getWrappedInstance();
    Class<?> beanType = instanceWrapper.getWrappedClass();
    if (beanType != NullBean.class) {
        mbd.resolvedTargetType = beanType;
    }

    synchronized (mbd.postProcessingLock) {
        if (!mbd.postProcessed) {
            try {
                // MergedBeanDefinitionPostProcessor后置处理器执行
                applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName);
            }
            catch (Throwable ex) {
                throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                                "Post-processing of merged bean definition failed", ex);
            }
            mbd.postProcessed = true;
        }
    }

    boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
                                      isSingletonCurrentlyInCreation(beanName));
    // 若Bean的作用域是单例, 且允许循环依赖, 且该Bean正处于创建中, 则放入第三级缓存中
    if (earlySingletonExposure) {
        if (logger.isTraceEnabled()) {
            logger.trace("Eagerly caching bean '" + beanName +
                         "' to allow for resolving potential circular references");
        }
        // 放入第三级缓存, 第三级缓存的值是Bean实例对象工厂, 请看本文第 10 点
        addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
    }

    Object exposedObject = bean;
    try {
        // 对Bean实例进行依赖注入
        populateBean(beanName, mbd, instanceWrapper);
        // 对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) {
            if (exposedObject == bean) {
                exposedObject = earlySingletonReference;
            }
            else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) {
                String[] dependentBeans = getDependentBeans(beanName);
                Set<String> actualDependentBeans = new LinkedHashSet<>(dependentBeans.length);
                for (String dependentBean : dependentBeans) {
                    if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) {
                        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 " +
                                                               "'getBeanNamesForType' with the 'allowEagerInit' flag turned off, for example.");
                }
            }
        }
    }

    try {
        // 注册该Bean可自由使用
        registerDisposableBeanIfNecessary(beanName, bean, mbd);
    }
    catch (BeanDefinitionValidationException ex) {
        throw new BeanCreationException(
            mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
    }

    return exposedObject;
}

9. AbstractAutowireCapableBeanFactory.createBeanInstance()源码分析

protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) {
    // 确保Bean的类型在这里已经是正确解析过的
    Class<?> beanClass = resolveBeanClass(mbd, beanName);

    if (beanClass != null && !Modifier.isPublic(beanClass.getModifiers()) && !mbd.isNonPublicAccessAllowed()) {
        throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                        "Bean class isn't public, and non-public access not allowed: " + beanClass.getName());
    }

    Supplier<?> instanceSupplier = mbd.getInstanceSupplier();
    if (instanceSupplier != null) {
        return obtainFromSupplier(instanceSupplier, beanName);
    }

    if (mbd.getFactoryMethodName() != null) {
        return instantiateUsingFactoryMethod(beanName, mbd, args);
    }

    boolean resolved = false;
    boolean autowireNecessary = false;
    if (args == null) {
        synchronized (mbd.constructorArgumentLock) {
            if (mbd.resolvedConstructorOrFactoryMethod != null) {
                resolved = true;
                autowireNecessary = mbd.constructorArgumentsResolved;
            }
        }
    }
    if (resolved) {
        if (autowireNecessary) {
            return autowireConstructor(beanName, mbd, null, null);
        }
        else {
            return instantiateBean(beanName, mbd);
        }
    }

    Constructor<?>[] ctors = determineConstructorsFromBeanPostProcessors(beanClass, beanName);
    if (ctors != null || mbd.getResolvedAutowireMode() == AUTOWIRE_CONSTRUCTOR ||
        mbd.hasConstructorArgumentValues() || !ObjectUtils.isEmpty(args)) {
        // 使用有参构造函数通过反射创建实例
        return autowireConstructor(beanName, mbd, ctors, args);
    }

    ctors = mbd.getPreferredConstructors();
    if (ctors != null) {
        return autowireConstructor(beanName, mbd, ctors, null);
    }

    // 使用无参构造函数通过反射创建实例
    return instantiateBean(beanName, mbd);
}

10. DefaultSingletonBeanRegistry.addSingletonFactory()源码分析

/**
 * 参数说明
 * @param beanName Bean的名称
 * @param singletonFactory 单例Bean实例对象工厂
 */
protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory) {
    Assert.notNull(singletonFactory, "Singleton factory must not be null");
    // 对一级缓存加锁
    synchronized (this.singletonObjects) {
        if (!this.singletonObjects.containsKey(beanName)) {
            // 将单例Bean实例对象工厂放入三级级缓存
            this.singletonFactories.put(beanName, singletonFactory);
            // 将二级缓存中的值删除
            this.earlySingletonObjects.remove(beanName);
            this.registeredSingletons.add(beanName);
        }
    }
}