关于Spring的两三事:万物之始—BeanDefinition

携手创造,一起生长!这是我参加「日新计划 8 月更文挑战」的第1天,点击查看活动概况

人生苦短,不如养狗

作者:Brucebat.Sun

大众号:Brucebat的伪技术鱼塘

一、前言

  道家有云:“道生一,一生二,二生三,三生万物。”这句话简略了解便是,人间万物皆是由衍生出来的,而道则是对万物的一种极致抽象

  在不断深入学习和运用Spring结构的进程中,愈发觉得在Spring结构的规划理念中随处可见前面提到的道家理念。在之前的学习中咱们有提到Spring结构中最中心的两个部分,一个是IoC容器,一个是AOP模块,其他功用都是根据这两个中心功用构建起来的。而在IoC容器和AOP模块这两个中心功用中,后者又是根据前者来完结相应的功用。至此,咱们不难得出一个不是那么精确的定论,即Spring所供给的全部功用都是经过IoC容器生成的各式方针来完结的。那么,这些林林总总的方针又是怎么生成的呢?

  遍观网络上大部分Spring系列或许关于Spring IoC容器的博客在谈及Spring Bean生成进程时都喜爱围绕Bean的生命周期进行详尽剖析,但在Bean成员变量是怎么确认、Bean中为什么会包括某些注解等一些Bean界说来历问题以及相应处理流程的讲解上经常是轻描淡写一笔带过(当然笔者之前学习的时分也喜爱干这种工作,哈哈哈~),导致关于Spring中“万物”生成的流程总是感觉了解得不行透彻,好像缺少了什么。其实再往前深挖一步咱们就能够得到答案,上面博客中重视的Bean生命周期的剖析更多的是针对Bean成员变量设置以及办法署理等流程的剖析,而关于Bean界说的规划以及生成的流程却鲜少进行剖析评论。为了更好地了解Spring容器创立方针的进程,咱们需求追本溯源,去探究一下Bean方针的源头BeanDefinition的运作原理。

二、为什么需求BeanDefinition?

  让咱们先抛开IoC容器,抛开Spring,先回归最根本的方针生成流程(需求留意,这儿咱们谈论的方针生成更多的是属于编码运用层面,而非JVM层面)。从以往学习的经历来看,方针的生成能够分为两步:实例创立特点赋值。前者创立了一个空的方针,后者则是对这个空方针的成员变量进行赋值处理。假如让咱们运用人工的办法来处理这两步其实十分简略,先经过new关键字来创立方针类的实例,然后根据咱们的实践需求对方针类实例中的成员变量进行逐一赋值。这儿能够经过下面的例子简略感受一下:

    // 创立实例
    Person person = new Person();
    // 进行方针成员变量赋值
    person.setName("test");
    person.setGender("male");

  可是当咱们测验运用代码办法 (即编程式) 来对上述两个过程进行逻辑抽象时就会发现这其间存在许多难点。

  首先,咱们遇到的榜首个也是最重要的一个问题:应该创立哪个类型的实例? 之所以会遇到这样一个问题首要是Java面向方针语言中的多态特性导致的,即父类引用能够指向子类完结。根据这一特性,咱们在进行方针实例化时需求明确指定运用父类或许子类进行实例化,其间假如父类是抽象类或许接口则有必要运用指定子类来进行方针的实例化。这就意味着咱们需求在对该相关联系进行存储以便在方针实例化时能够依照对应联系进行实例化。

  第二个问题:在每次运用该方针时是否需求创立新的方针? 即是否需求运用单例形式?在咱们实践开发进程中一般会有两种类型的方针,一种是只会存在于一次恳求处理进程中的短周期方针(即每次运用都需求创立新的方针),一种是每次恳求运用的都是同一个实例的全局单例方针。前者一般用于进行数据的临时存储,后者一般用于供给通用的数据处理才能。同样,在运用编程式办法来创立方针时咱们也需求对该方针创立办法进行存储。

  第三个问题:怎么运用类供给的结构函数进行方针的创立? 其实这个问题的难点是在于怎么运用有参结构函数来完结方针实例的创立。当咱们运用无参结构函数时,能够很简略地创立实例而不需求考虑其他问题。但当咱们预备运用有参结构函数时,就需求考虑怎么获取函数参数列表中每个参数的方针实例,即需求怎么设置相应参数哪种类型的方针实例。剖析到这儿能够发现,咱们又绕回到了榜首个问题。和榜首个问题相同,要想正确地运用结构函数完结预期的实例创立,咱们就需求记录结构函数的参数列表和对应参数需求设置的实例方针。

  由第三个问题能够引申出第四个问题:假如方针类型只供给了无参结构函数,咱们需求怎么设置方针实例的成员变量? 这个问题能够说是第三个问题的变种,只不过将成员变量设置的机遇由结构函的调用阶段拖延至运用方针setter办法来设置成员变量阶段。

  除了上面的问题,还有其他一些需求考虑的问题,这儿笔者就不一一列举说明晰。可是经过上面的剖析咱们不难得出一个定论:要想经过编程式的办法来自动化地完结指定方针的实例化和赋值处理,咱们需求抽象出一个能够描绘/存储方针实例内部信息的类型

  剖析完最根本的方针生成流程,让咱们重新回到Spring对Bean的办理功用中。此刻咱们会发现,其实Spring的Bean办理便是经过编程式的办法来统一办理Bean的生成和运用,在这一进程中方针的创立和赋值流程完全由结构自身控制而非由开发人员自主控制(即咱们常说的控制回转)。就好像咱们上面剖析的相同,为了完结这一才能,Spring规划并运用BeanDefinition来进行方针方针实例信息的描绘。根据BeanDefinition供给的方针实例信息,并结合Java供给的反射机制,Spring完结了道生一以致衍生万物的功用。

留意:下文中的源码均是根据SpringBoot 2.6.10版本进行剖析

三、怎么生成BeanDefinition?

  在上一末节中咱们经过剖析运用编程式办法创立方针存在的问题去探究了一下BeanDefinition的规划含义,但要想真实运用BeanDefinition,咱们还需求了解一下它的生成流程。

1. 一般开发者的BeanDefinition生成流程规划

  同样的,让咱们先抛开Spring源码自身,以一个开发者的身份考虑一下假如要完结生成BeanDefinition这样一个需求需求完结哪些功用。根据上面的剖析和咱们日常开发的运用经历不难发现,要想生成BeanDefinition需求完结以下两个功用:

  • 确认项目中哪些类需求生成BeanDefinition
  • 根据方针类对BeanDefinition进行赋值处理

  咱们先来看一下榜首个功用:确认项目中需求生成BeanDefinition的类。从咱们日常的开发中能够发现并不是一切的类都需求经过Spring来进行创立和办理,比方DO、VO这些用于数据传输的类,再比方一些供给静态办法的工具类,这些类要么是在需求运用的当地由开发人员主动地创立并运用,要么便是不需求实例化直接运用当时类的静态办法。那么咱们应该怎么确认需求生成的BeanDefinition的类呢?这儿咱们需求将其拆分成两步完结,榜首步,找到项目中一切由开发人员自界说的类,第二步,根据标识来区分这些自界说的类哪些是需求生成BeanDefinition的。前者能够经过包名扫描出一切属于这个项意图类型,后者能够经过特殊的注解来对相应的类型进行标识。

  让咱们接着来看一下第二个功用:根据方针类对BeanDefinition进行赋值处理。从上文的剖析中咱们能够知道BeanDefinition傍边存储的都是用于去生成方针实例的类型信息,而要想在运转时去获取一个类型的相关信息信任大部分人的榜首反应根本便是经过反射机制来完结 (为什么要说大部分人,这是由于Spring的开发人员并没有采取这一计划,鄙人面的源码剖析阶段咱们会详细了解一下其间的原因) 。经过反射机制咱们能够获取到当时方针的类型信息、当时方针的注解、依赖的成员变量以及成员变量的注解等等大部分需求的类型信息,然后咱们就能够将这些需求的类型信息赋值到BeanDefinition傍边。

  以上是咱们作为一个开发人员根据生成BeanDefinition这样一个需求做出的技术计划揣测,下面让咱们结合源码来详细看一下Spring是怎么规划生成BeanDefinition的技术计划。

2. Spring开发者的BeanDefinition生成流程规划

  从SpringBoot项意图启动类开端向内逐层debug,咱们会找到自界说类型的BeanDefinition生成进口org.springframework.context.annotation.ClassPathBeanDefinitionScanner#doScan (需求留意,这儿特别标示了这儿的进口是非Spring结构、非二方包内的类型的BeanDefinition生成进口) 。详细能够参阅下图:

关于Spring的两三事:万物之始—BeanDefinition

  首先咱们来看下办法参数列表中的basePackages。在逐层debug的进程中咱们能够看到办法入参中basePackages会经过两种办法获取到,一种是缺省状况下会运用启动类地点的包名作为basePackage,另一种则是从@ComponentScan注解的设置傍边获取。需求留意的是,假如预备运用第二种办法来自界说设置basePackages,在咱们实践运用SpringBoot时并不是直接运用@componentScan来进行basePackages设置的,而是经过@SpringBootApplication注解的scanBasePackages或scanBasePackageClasses参数来进行设置的。

  在了解到basePackages的由来之后咱们再来看下上面的办法,能够看到上面的办法实践上首要做了两件事:

  • 根据basePackages获取指定自界说类的BeanDefinition实例;
  • 根据生成BeanDefinition调集进行额定的包装,并将这些BeanDefinition注册到上下文傍边;

  这儿咱们首要探究一下榜首部分内容的完结,从上面的代码中能够看到该部分内容的逻辑都放置在public Set<BeanDefinition> findCandidateComponents(String basePackage)办法傍边。经过实践的debug会发现流程最终会进入到该办法内部的scanCandidateComponents(basePackage)中。该办法的详细内容如下:

关于Spring的两三事:万物之始—BeanDefinition

  从上面的代码中能够看出,Spring的开发者们确实和咱们之前猜测的相同,根据basePackages来扫描出一切有或许需求生成BeanDefinition的类文件。可是和咱们猜测的不同,这儿扫描的不是单纯的类全限定名,而是class文件的文件途径,一起最终生成类型的元数据信息时并没有运用反射机制,而是运用了读取.class文件字节码的办法(这部分逻辑在org.springframework.asm.ClassReader#accept(org.springframework.asm.ClassVisitor, int)办法中处理,这儿不展现详细的代码内容)。相比一些同学会发生疑惑,为什么没有运用简略好用的反射机制,而是运用了极其复杂难用的读取字节码的办法来获取类型的元数据信息?这首要是由于JVM自身特性导致的,在实践的运转进程中,JVM并不会时时刻刻加载全部的类型信息,只会将部分需求运用到的类型加载到虚拟机内存傍边。这就意味着在项目启动的初始化进程中,JVM傍边或许并没有将对应类型加载到内存傍边,运用反射机制并不能获取到对应类型的元数据信息。一起,从效率上来讲经过字节码的办法比运用反射机制会更高。

  除此以外,在实践生成BeanDefinition时,Spring结构做了进一步的判别和阻拦。和咱们上面的剖析相同,根据basePackages的.class文件扫描会将一切自界说类型都扫描出来,这其间就包括不少不需求生成BeanDefinition的类型。从上面的代码中咱们能够看到,实践的判别和阻拦是经过isCandidateComponent(metadataReader)isCandidateComponent(sbd)来完结的。榜首个办法中经过根据注解的过滤器(excludeFilter)和包括器(includeFilter)来判别当时类型是否需求生成BeanDefinition,第二个办法在榜首个办法的判别基础上进一步针对BeanDefinition进行了判别,假如当时类型属于接口、抽象类或许关闭类(enclosing class) 则舍弃当时BeanDefinition。弥补第二判别的首要原因是,开发者在实践开发时或许会将注解标示在不能生成方针实例的类(比方上面提到的三种类型)上,即单纯靠注解进行判别是不完全可信的。

在isCandidateComponent(metadataReader)办法中的包括器会根据@Component注解来判别是否包括当时类型的元数据,根据这一条件,运用包括@Component注解的注解对类进行标记时也会被包括器包括(比方@Configuration、@Service、@Controller、@RestController等)

  以上即为根据basePackages获取指定自界说类的BeanDefinition实例的完结进程,在这一进程中Spring还完结了类型元数据相关信息的赋值处理。而在第二部分中更多是根据Spring自身规划以及其他功用的额定信息设置(包括scope、init办法、destory办法等信息的设置),有爱好的同学能够自行进行源码的阅览,这儿笔者就不过多剖析了。

四、BeanDefinition的运用

  铺垫了这么久,咱们终于来到了BeanDefinition运用环节的剖析。在Spring结构傍边,关于BeanDefinition的运用首要分为两个方面:

  • 根据BeanDefinition进行Bean方针的创立;
  • 根据BeanDefinition对Bean方针进行额定的加工处理(比如Bean特点设置、运用BeanPostProcessor对Bean进行额定处理等);

  在本篇文章中咱们会将目光聚焦在榜首个方面,关于第二个方面网上现已有太多的博客进行过剖析,这儿就不加赘述了(其实咱们经常看到的关于Bean生命周期的剖析其实便是这儿所说的第二个方面的一部分)。

  从榜首小结的剖析傍边咱们能够看到假如不运用new关键字的办法来进行方针实例的创立,咱们就需求运用反射机制来完结。运用反射机制的意图是为了获取到方针类型的结构器Constructor<T> ctor,然后经过结构器办法的Constructor#newInstance来创立对应的实例。在Spring结构中便是运用了反射机制中的相应流程来完结关于Bean实例的创立,详细办法org.springframework.beans.BeanUtils#instantiateClass(java.lang.reflect.Constructor<T>, java.lang.Object...)如下:

关于Spring的两三事:万物之始—BeanDefinition

  这个办法的内部逻辑十分简略,咱们需求重视的是办法的参数列表,或许说是该办法参数列表中的值是从什么当地获取到的。为了处理这个问题,咱们需求向上回溯,回到org.springframework.beans.factory.support.AbstractAutowireCapableBeanFactory#createBeanInstance办法:

关于Spring的两三事:万物之始—BeanDefinition

  从上面展现的代码中咱们能够归纳出三种利用BeanDefinition生成方针实例的状况:

  • 运用开发自界说的创立实例的办法,即代码中展现的obtainFromSupplier(instanceSupplier, beanName)instantiateUsingFactoryMethod(beanName, mbd, args),前者由开发自界说所需的Supplier<?>,后者则需求开发完结对应的工厂办法;
  • 运用类默认的无参结构函数进行方针实例的创立,即代码中的instantiateBean(beanName, mbd)办法;
  • 运用特定的结构函数进行方针实例的创立,即代码中的autowireConstructor(beanName, mbd, ctors, args)办法;

  榜首种状况是经过开发者自行控制,是Spring供给一个扩展点,这儿不需求做过多重视。第二种办法和第三种办法从本质上来说其实是一种办法,即运用反射机制中的结构器来进行方针实例创立,两者的差异在于一个运用的是默认的无参结构函数,另一个则是经过读取BeanDefinition中指定的首选结构器或候选结构器来完结方针实例的生成。

这儿需求弥补一点,在AbstractAutowireCapableBeanFactory#createBeanInstance办法的榜首行Class<?> beanClass = resolveBeanClass(mbd, beanName);中能够看到,这儿经过BeanDefinition进行了方针类型的加载处理,即保证方针类型现已加载到JVM傍边,这也解释了为什么后续办法能够运用反射机制来生成方针实例。

  在这儿咱们能够处理BeanUtils#instantiateClass参数列表中榜首个参数Constructor<T>的来历问题,可是貌似并没有找到处理第二个参数结构函数的参数列表的来历。这儿笔者运用了貌似是由于假如咱们持续向上回溯会发现上游在最开端设置结构函数的参数args时设置的便是null,也便是说args的值需求向下探究。这儿咱们需求从autowireConstructor(beanName, mbd, ctors, args)这个进口向下求解,直到进入org.springframework.beans.factory.support.ConstructorResolver#autowireConstructor办法内部咱们会发现一直找寻的args值出现了:

关于Spring的两三事:万物之始—BeanDefinition

  至此,BeanDefinition在创立方针实例中的运用根本现已剖析结束。

五、总结

  不得不说,在阅览剖析完BeanDefinition生成和运用的源码规划之后,以往关于Spring结构中Bean办理模块的功用了解才算真实含义上做到了一个闭环。当然这儿的闭环并不是十分完美的闭环,由于这儿咱们仅仅简略的答复了Bean办理模块中关于Bean创立流程的相关问题,可是关于Bean办理模块是怎么支撑Spring结构中比如事务办理、MVC等其他模块的问题并没有做出相应的答复。这部分内容有爱好的朋友能够先自行探究,也能够耐性等候笔者后续不知哪一天的更新(要学要写的东西太多,哈哈哈)。

  本文在剖析和讲解进程中大多仅仅展现了进口或许关键节点的代码,关于更细节的源码并没有贴出来,所以在学习的进程中最好能自己在结合源码进行debug来实践感受一下。

  最后,世事无常,生活不易,愿诸位身体健康,早日升职加薪~~