天天看点

《SpringBoot揭秘:快速构建微服务体系》—第3章3.2节@SpringBootApplication背后的秘密

本节书摘来自华章出版社《springboot揭秘:快速构建微服务体系》一书中的第3章,第3.2节@springbootapplication背后的秘密,作者王福强,更多章节内容可以访问云栖社区“华章计算机”公众号查看。

3.2 @springbootapplication背后的秘密

@springbootapplication是一个“三体”结构,实际上它是一个复合annotation:

虽然它的定义使用了多个annotation进行元信息标注,但实际上对于springboot应用来说,重要的只有三个annotation,而“三体”结构实际上指的就是这三个annotation:

@configuration

@enableautoconfiguration

@componentscan

所以,如果我们使用如下的springboot启动类,整个springboot应用依然可以与之前的启动类功能对等:

但每次都写三个annotation显然过于繁琐,所以写一个@springboot-application这样的一站式复合annotation显然更方便些。

3.2.1 @configuration创世纪

这里的@configuration对我们来说并不陌生,它就是javaconfig形式的spring ioc容器的配置类使用的那个@configuration,既然springboot应用骨子里就是一个spring应用,那么,自然也需要加载某个ioc容器的配置,而springboot社区推荐使用基于javaconfig的配置形式,所以,很明显,这里的启动类标注了@configuration之后,本身其实也是一个ioc容器的配置类!

很多springboot的代码示例都喜欢在启动类上直接标注@configuration或者@springbootapplication,对于初接触springboot的开发者来说,其实这种做法不便于理解,如果我们将上面的springboot启动类拆分为两个独立的java类,整个形势就明朗了:

所以,启动类demoapplication其实就是一个标准的standalone类型java程序的main函数启动类,没有什么特殊的。

而@configuration标注的democonfiguration定义其实也是一个普通的javaconfig形式的ioc容器配置类,没啥新东西,全是spring框架里的概念!

3.2.2 @enableautoconfiguration的功效

@enableautoconfiguration其实也没啥“创意”,各位是否还记得spring框架提供的各种名字为@enable开头的annotation定义?比如@enablescheduling、@enablecaching、@enablembeanexport等,@enableautoconfiguration的理念和“做事方式”其实一脉相承,简单概括一下就是,借助@import的支持,收集和注册特定场景相关的bean定义:

@enablescheduling是通过@import将spring调度框架相关的bean定义都加载到ioc容器。

@enablembeanexport是通过@import将jmx相关的bean定义加载到ioc容器。

而@enableautoconfiguration也是借助@import的帮助,将所有符合自动配置条件的bean定义加载到ioc容器,仅此而已!

@enableautoconfiguration作为一个复合annotation,其自身定义关键信息如下:

其中,最关键的要属@import(enableautoconfigurationimportselector.class),借助enableautoconfigurationimportselector,@enableautoconfiguration可以帮助springboot应用将所有符合条件的@configuration配置都加载到当前springboot创建并使用的ioc容器,就跟一只“八爪鱼”一样(如图3-1所示)。

借助于spring框架原有的一个工具类:springfactoriesloader的支持,@enableautoconfiguration可以“智能”地自动配置功效才得以大功告成!

《SpringBoot揭秘:快速构建微服务体系》—第3章3.2节@SpringBootApplication背后的秘密

自动配置的幕后英雄:springfactoriesloader详解

springfactoriesloader属于spring框架私有的一种扩展方案(类似于java的spi方案java.util.serviceloader),其主要功能就是从指定的配置文件meta-inf/spring.factories加载配置,spring.factories是一个典型的java properties文件,配置的格式为key = value形式,只不过key和value都是java类型的完整类名(fully qualified name),比如:

example.myservice=example.myserviceimpl1,example.myserviceimpl2

然后框架就可以根据某个类型作为key来查找对应的类型名称列表了:

对于@enableautoconfiguration来说,springfactoriesloader的用途稍微不同一些,其本意是为了提供spi扩展的场景,而在@enableautoconfiguration的场景中,它更多是提供了一种配置查找的功能支持,即根据@enableautoconfiguration的完整类名org.springframework.boot.autoconfigure.enableautoconfiguration作为查找的key,获取对应的一组@configuration类:

org.springframework.boot.autoconfigure.enableautoconfiguration=\

org.springframework.boot.autoconfigure.admin.springapplicationadmin- jmxautoconfiguration,\

org.springframework.boot.autoconfigure.aop.aopautoconfiguration,\

org.springframework.boot.autoconfigure.amqp.rabbitautoconfiguration,\

org.springframework.boot.autoconfigure.messagesourceautoconfiguration,\

org.springframework.boot.autoconfigure.propertyplaceholderauto- configuration,\

org.springframework.boot.autoconfigure.batch.batchautoconfiguration,\

org.springframework.boot.autoconfigure.cache.cacheautoconfiguration,\

org.springframework.boot.autoconfigure.cassandra.cassandraauto-configuration,\

org.springframework.boot.autoconfigure.cloud.cloudautoconfiguration,\

org.springframework.boot.autoconfigure.context.configurationproperties-autoconfiguration,\

org.springframework.boot.autoconfigure.dao.persistenceexception-translationautoconfiguration,\

org.springframework.boot.autoconfigure.data.cassandra.cassandra-dataautoconfiguration,\

org.springframework.boot.autoconfigure.data.cassandra.cassandra-repositoriesautoconfiguration,\

...

以上是从springboot的autoconfigure依赖包中的meta-inf/spring.factories配置文件中摘录的一段内容,可以很好地说明问题。

所以,@enableautoconfiguration自动配置的魔法其实就变成了:从classpath中搜寻所有meta-inf/spring.factories配置文件,并将其中org.spring-framework.boot.autoconfigure.enableautoconfiguration对应的配置项通过反射(java reflection)实例化为对应的标注了@configuration的javaconfig形式的ioc容器配置类,然后汇总为一个并加载到ioc容器。

目前为止,还是spring框架的原有概念和支持,依然没有“新鲜事”!

3.2.3 可有可无的@componentscan

为啥说@componentscan是可有可无的?因为原则上来说,作为spring框架里的“老一辈革命家”,@componentscan的功能其实就是自动扫描并加载符合条件的组件或bean定义,最终将这些bean定义加载到容器中。加载bean定义到spring的ioc容器,我们可以手工单个注册,不一定非要通过批量的自动扫描完成,所以说@componentscan是可有可无的。

对于springboot应用来说,同样如此,比如我们本章的启动类:

如果我们当前应用没有任何bean定义需要通过@componentscan加载到当前springboot应用对应使用的ioc容器,那么,除去@componentscan的声明,当前springboot应用依然可以照常运行,功能对等!

看,还是没有啥新东西!