spring源码分析bean的加载

wuxiaofeng      2022-04-06     119

关键词:

摘要:本文结合《Spring源码深度解析》来分析Spring 5.0.6版本的源代码。若有描述错误之处,欢迎指正。

 

 经过前面的分析,我们终于结束了对XML配置文件的解析,接下来将会面临更大的挑战,就是对bean加载的探索。bean加载的功能实现远比bean的解析要复杂得多。同样,我们还是以最开始的示例为基础,对于加载bean的功能,在Spring中的调用方式是:

MySpringBean bean = (MySpringBean) beanFactory.getBean("mySpringBean");

这句代码实现了什么样的功能呢?我们可以先快速体验一下Spring中代码是如何实现的。

@Override
public Object getBean(String name) throws BeansException {
    return doGetBean(name, null, null, false);
}

protected <T> T doGetBean(final String name, @Nullable final Class<T> requiredType,
        @Nullable final Object[] args, boolean typeCheckOnly) throws BeansException {

    // 提取对应的beanName
    final String beanName = transformedBeanName(name);
    Object bean;

    /**
     * 检查缓存中或者实例工厂中是否有对应的实例
     * 为什么首先会使用这段代码呢?
     * 因为在创建bean的时候会存在依赖注入的情况,而在创建依赖的时候为了避免循环依赖,
     * Spring创建bean的原则是不等bean创建完成就会将创建bean的ObjectFactory提早曝光,
     * 也就是将ObjectFactory加入到缓存中,一旦下个bean创建时候需要依赖上个bean则直接使用ObjectFactory
     */
    // Eagerly check singleton cache for manually registered singletons.
    // 首先尝试从缓存获取或者singletonFactories中的ObjectFactory中获取
    Object sharedInstance = getSingleton(beanName);
    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 + "‘");
            }
        }
        // 返回对应的实例,有时候存在诸如BeanFactory的情况并不是直接返回实例本身而是返回指定方法返回的实例
        bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
    }

    else {
        // Fail if we‘re already creating this bean instance:
        // We‘re assumably within a circular reference.
        /**
         * 只有在单例情况才会尝试解决循环依赖,原型模式情况下,如果存在A中有B的属性,B中有A的属性,
         * 那么当依赖注入的时候,就会产生当A还未创建完的时候因为对于B的创建再次返回创建A,
         * 造成循环依赖,也就是下面的情况isPrototypeCurrentlyInCreation(beanName)为true
         */
        if (isPrototypeCurrentlyInCreation(beanName)) {
            throw new BeanCurrentlyInCreationException(beanName);
        }

        // Check if bean definition exists in this factory.
        // 如果beanDefinitionMap中也就是在所有已经加载的类中不包括beanName则尝试从parentBeanFactory中检测
        BeanFactory parentBeanFactory = getParentBeanFactory();
        if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
            // Not found -> check parent.
            String nameToLookup = originalBeanName(name);
            // 递归到BeanFactory中寻找
            if (parentBeanFactory instanceof AbstractBeanFactory) {
                return ((AbstractBeanFactory) parentBeanFactory).doGetBean(
                        nameToLookup, requiredType, args, typeCheckOnly);
            }
            else if (args != null) {
                // Delegation to parent with explicit args.
                return (T) parentBeanFactory.getBean(nameToLookup, args);
            }
            else if (requiredType != null) {
                // No args -> delegate to standard getBean method.
                return parentBeanFactory.getBean(nameToLookup, requiredType);
            }
            else {
                return (T) parentBeanFactory.getBean(nameToLookup);
            }
        }

        // 如果不是仅仅做类型检查则是创建bean,这里要进行记录
        if (!typeCheckOnly) {
            markBeanAsCreated(beanName);
        }

        try {
            // 将存储XML配置文件的GenericBeanDefinition转换为RootBeanDefinition,
            // 如果指定beanName是子Bean的话同时会合并父类的相关属性
            final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
            checkMergedBeanDefinition(mbd, beanName, args);

            // Guarantee initialization of beans that the current bean depends on.
            String[] dependsOn = mbd.getDependsOn();
            // 若存在依赖则需要递归实例化依赖的bean
            if (dependsOn != null) {
                for (String dep : dependsOn) {
                    if (isDependent(beanName, dep)) {
                        throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                "Circular depends-on relationship between ‘" + beanName + "‘ and ‘" + dep + "‘");
                    }
                    // 缓存依赖调用
                    registerDependentBean(dep, beanName);
                    try {
                        getBean(dep);
                    }
                    catch (NoSuchBeanDefinitionException ex) {
                        throw new BeanCreationException(mbd.getResourceDescription(), beanName,
                                "‘" + beanName + "‘ depends on missing bean ‘" + dep + "‘", ex);
                    }
                }
            }

            // Create bean instance.
            // 实例化依赖的bean后便可以实例化mbd本身了
            // singleton模式的创建
            if (mbd.isSingleton()) {
                sharedInstance = getSingleton(beanName, () -> {
                    try {
                        return createBean(beanName, mbd, args);
                    }
                    catch (BeansException ex) {
                        // Explicitly remove instance from singleton cache: It might have been put there
                        // eagerly by the creation process, to allow for circular reference resolution.
                        // Also remove any beans that received a temporary reference to the bean.
                        destroySingleton(beanName);
                        throw ex;
                    }
                });
                bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
            }

            else if (mbd.isPrototype()) {
                // It‘s a prototype -> create a new instance.
                // prototype模式的创建
                Object prototypeInstance = null;
                try {
                    beforePrototypeCreation(beanName);
                    prototypeInstance = createBean(beanName, mbd, args);
                }
                finally {
                    afterPrototypeCreation(beanName);
                }
                bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
            }

            else {
                // 指定的scope上实例化bean
                String scopeName = mbd.getScope();
                final 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);
                        }
                    });
                    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;
        }
    }

    // Check if required type matches the type of the actual bean instance.
    // 检查需要的类型是否符合bean的实际类型
    if (requiredType != null && !requiredType.isInstance(bean)) {
        try {
            T convertedBean = getTypeConverter().convertIfNecessary(bean, requiredType);
            if (convertedBean == null) {
                throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
            }
            return convertedBean;
        }
        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;
}

仅从代码量就能看出来bean的加载经历了一个相当复杂的过程,其中涉及各种各样的考虑。相信读者细心阅读上面的代码,并参照部分代码注释,是可以粗略地了解整个加载bean的过程。对于加载过程中所涉及的步骤大致如下。

(1)转换对应的beanName。

或许很多人不理解转换对应的beanName是什么意思,传入的参数name不就是beanName吗?其实不是,这里传入的参数可能是别名,也可能是FactoryBean,所以需要进行一系列的解析,这些解析内容包括如下内容。

  • 去除BeanFactory的修饰符,也就是如果name="&hello",那么会首先去除&而使name="hello"。
  • 取指定alias所表示的最终beanName,例如别名A指向名称为B的bean则返回B;若别名A指向别名B,别名B又指向名称为C的bean则返回C。 

(2)尝试从缓存中加载单例。

单例在Spring的同一个容器内只会被创建一次,后续再获取bean,就直接从单例缓存中获取了。当然这里也只是尝试加载,首先尝试从缓存中加载,如果加载不成功则再次尝试从singletonFactories中加载。因为在创建单例bean的时候会存在依赖注入的情况,而在创建依赖的时候为了避免循环依赖,Spring创建bean的原则是不等bean创建完成就会将创建bean的ObjectFactory提早曝光,也就是将ObjectFactory加入到缓存中,一旦下个bean创建时候需要依赖上个bean则直接使用ObjectFactory。

(3)bean的实例化。

如果从缓存中得到了bean的原始状态,则需要对bean进行实例化。这里有必要强调一下,缓存中记录的只是最原始的bean状态,并不一定是我们最终想要的bean。举个例子,假如我们需要对工厂bean进行处理,那么这里得到的其实是工厂bean的初始状态,但是我们真正需要的是工厂bean中定义的factory-method方法返回的bean,而getObjectForBeanInstance就是完成这个工作的,后续会详细讲解。

(4)原型模式的依赖检查。

只有在单例情况才会尝试解决循环依赖,原型模式情况下,如果存在A中有B的属性,B中有A的属性,那么当依赖注入的时候,就会产生当A还未创建完的时候因为对于B的创建再次返回创建A,造成循环依赖,也就是情况:isPrototypeCurrentlyInCreation(beanName)为true。

(5)检测parentBeanFactory。

从代码上看,如果缓存没有数据的话直接转到父类工厂上去加载了,这是为什么呢?

可能读者忽略了一个很重要的判断条件:parentBeanFactory != null && !containsBeanDefinition(beanName)。parentBeanFactory如果为空,则其他一切都是浮云,但是!containsBeanDefinition(beanName)就比较重要了,它是在检测如果当前加载的XML配置文件中不包含beanName所对应的配置,就只能到parentBeanFactory去尝试了,然后再去递归地调用getBean方法。

(6)将存储XML配置文件的GenericBeanDefinition转换为RootBeanDefinition。

因为从XML配置文件中读取到的Bean信息是存储在GenericBeanDefinition中的,但是所有的Bean后续处理都是针对于RootBeanDefinition的,所以这里需要进行转换,转换的同时如果父类bean不为空的话,则会一并合并父类的属性。

(7)寻找依赖。

因为 bean 的初始化过程中很可能会用到某些属性,而某些属性很可能是动态配置的,并且配置成依赖于其他的 bean ,那么这个时候就有必要先加载依赖的 bean ,所以,在 Sring 的加载顺序中,在初始化某一个 bean 的时候首先会初始化这个 bcan 所对应的依赖。

( 8 )针对不同的 scope 进行 bean 的创建。

我们都知道,在 Spring 中存在着不同的 scope ,其中默认的是 singleton ,但是还有些其他的配置诸如 prototype、 request 之类的。在这个步骤中, Sring会根据不同的配置进行不同的初始化策略。

( 9 )类型转换。

程序到这里返回 bean 后已经基本结束了,通常对该方法的调用参数 requiredType 是为空的,但是可能会存在这样的情况,返回的 bean 其实是个 String ,但是 requiredType却传入 Integer类型,那么这时候本步骤就会起作用了 ,它的功能是将返回的 bean转换为 requiredType 所指定的类型。当然, String 转换为 Integer 是最简单的一种转换,在 Spring 中提供了各种各样的转换器,用户也可以白己扩展转换器来满足需求。

经过上面的步骤后bean的加载就结束了,这个时候就可以返回所需要的 bean 了。其中最重要的就是步骤( 8 ) ,针对不同的 scope 进行 bean 的创建,你会看到各种常用的 Spring 特性在这里的实现。

 

spring源码跟踪,bean加载流程分析。(代码片段)

...周末加班砍了一天假,利用周日的时间宅家撸了一次Spring加载流程,把加载步骤列了出来。不才,还望大佬指教。一.基于注解进入容器@Testpublicvoidtest03()AnnotationConfigApplicationContextcontext=newAnnotationConfigApplicationCont... 查看详情

spring源码分析(十三)缓存中获取单例bean

摘要:本文结合《Spring源码深度解析》来分析Spring5.0.6版本的源代码。若有描述错误之处,欢迎指正。 介绍过FactoryBean的用法后,我们就可以了解bean加载的过程了。前面已经提到过,单例在Spring的同一个容器内只会被创建一... 查看详情

springioc源码分析之bean的加载和构造

我们都知道,SpringIoc和Aop是Spring的核心的功能,因此花一点时间去研究还是很有意义的,如果仅仅是知其所以然,也就体会不到大师设计Spring的精华,还记得那句话,Spring为JavaEE开发带来了春天。IOC就是Inversionofcontrol也就是控制... 查看详情

spring源码分析销毁方法,初始化之前的方法加载和执行过程分析

先看两个注解:@ComponentpublicclassPeople{//bean销毁之前执行,容器关闭的时候执行@PreDestroypublicvoidpredesory(){System.out.println("predesory执行了");}//bean创建之前执行@PostConstructpublicvoidinit(){System.out.println("PostConstru 查看详情

spring源码分析ioc容器初始化

前言:经过前几篇文章的讲解,我们已经得到了BeanDefinition,接下来将分析Bean的加载。获取Bean的入口:AbstractApplicationContext#getBean1publicObjectgetBean(Stringname)throwsBeansException{2//检测bean工厂是否存活3assertBeanFactoryActive();4returngetB 查看详情

spring源码分析ioc容器初始化(总结)

...的bean,转换成我们实际所需要的真正的bean对象。总结【spring源码分析】IOC容器初始化(一):主要分析了Spring是如何解析占位符以及BeanFactory的最终实现类DefaultListableBeanFactory。【s 查看详情

spring读源码系列04----bean的加载---上

Spring读源码系列04----bean的加载---上Bean的加载AbstractBeanFactory#getBean(Stringname)----根据名字获取beanAbstractBeanFactory#doGetBean---真正干活的方法goGetBean方法流程小结FactoryBean的使用缓存中获取单例beanDefaultSingletonBeanRegistry#getS 查看详情

spring源码解析之bean加载

最近准备把spring,springmvc,mybtais,springboot,部分的cloud组件的源码重头梳理一下,并在语雀记录一下。Spring源码解析之bean加载(二):https://www.yuque.com/dalianpai/spring/eigy2f 查看详情

spring源码分析(二十四)初始化非延迟加载单例

摘要:本文结合《Spring源码深度解析》来分析Spring5.0.6版本的源代码。若有描述错误之处,欢迎指正。  完成BeanFactory的初始化工作,其中包括ConversionService的设置、配置冻结以及非延迟加载的bean的初始化工作。/***Finishtheini... 查看详情

spring源码学习bean的加载

加油加油??  bean加载的大致过程1/**2*Returnaninstance,whichmaybesharedorindependent,ofthespecifiedbean.3*4*@paramnamethenameofthebeantoretrieve5*@paramrequiredTypetherequiredtypeofthebeantoretrieve6*@pa 查看详情

bean的加载(代码片段)

...,开始。Bean加载入口下面有很简单的一段代码可以作为Spring代码加载的入口:1ApplicationContextac=newClassPathXmlApplicationContext("spring.xml");2ac.getBean(XXX.class); ClassPathXmlApplicationContext用于加载CLASSPATH下的Spring配置文件,可以看到,第... 查看详情

spring源码-bean之加载-2

  一、前面说了bean的容器初始化,后面当然是说bean的加载。这里还是不讲解ApplicationContext的bean的加载过程,还是通过最基础的XmlBeanFactory来进行讲解,主要是熟悉通过BeanFactory是怎么实现class的实例化的。  二、声明一下:... 查看详情

spring读源码系列05----bean的加载---中

Spring读源码系列05----bean的加载---中循环依赖什么是循环依赖spring是如何解决循环依赖的1.构造器循环依赖2.setter循环依赖3.prototype范围的依赖处理创建BeanAbstractAutowireCapableBeanFactory#createBean—创建bean前的准备AbstractAutowireCapableBeanFac... 查看详情

spring源码分析ioc容器初始化(代码片段)

前言:在上文bean加载过程中还要一个非常重要的方法没有分析createBean,该方法非常重要,因此特意提出来单独分析。createBean方法定义在AbstractBeanFactory中:该方法根据给定的beanName、BeanDefinition和args实例化一个bean对象。所有bean... 查看详情

spring源码--bean的加载(代码片段)

bean的加载在AbstractBeanFactory的doGetBean中protected<T>TdoGetBean( Stringname,@NullableClass<T>requiredType,@NullableObject[]args,booleantypeCheckOnly) throwsBeansExceptiondoGetBean 查看详情

spring启动过程源码分析基本概念(代码片段)

...AnnotationConfigApplicationContext读取配置类来一步一步去了解Spring的启动过程。在看源码之前,我们要知道某些类的作用,这样更方便后续的了解。1、BeanDefinitionBeanDefinition就是Bean的定义,它是用来描述Bean的,里面存... 查看详情

spring中bean命名源码分析

Spring中Bean命名源码分析一、案例代码首先是demo的整体结构其次是各个部分的代码,代码本身比较简单,不是我们关注的重点配置类/***@AuthorHelius*@Create2019-10-25-20:16*/@Configuration@ComponentScan(basePackages={"service"})publicclassSpringCon... 查看详情

spring读源码系列05----bean的加载---下(代码片段)

Spring读源码系列05----bean的加载---下初始化BeanAbstractAutowireCapableBeanFactory#initializeBean---初始化BeanAbstractAutowireCapableBeanFactory#invokeAwareMethods---激活aware方法AbstractAutowireCapableBeanFactory#applyB 查看详情