SpringBoot自動(dòng)裝配原理詳解
summary
detail
傳統(tǒng)的Spring項(xiàng)目會(huì)有很多的配置文件,比如我們要使用Redis,一般除了對應(yīng)的依賴的jar包我們還需要在application.xml里面配置JedisConnectionFactory、JedisPoolConfig、RedisTemplate。但是如果使用SpringBoot的話,系統(tǒng)會(huì)根據(jù)pom.xml里面的jar包,自動(dòng)生成這些類并且注入到IOC容器當(dāng)中。
傳統(tǒng)Spring項(xiàng)目中需要配置
<bean id="jedisConnectionFactory" class="...JedisConnectionFactory"></bean> <bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig"></bean> <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate"></bean>
而使用SpringBoot的話,除了pom.xml引入相應(yīng)的jar包外,只需要在application.properties配置對應(yīng)的屬性值即可
以Redis舉例
- 從spring-boot-autoconfigure.jar/META-INF/spring.factories中獲取120多個(gè)默認(rèn)功能配置類,其中包括redis的功能配置類RedisAutoConfiguration的全限定名,一般一個(gè)功能配置類圍繞該功能,負(fù)責(zé)管理創(chuàng)建多個(gè)相關(guān)的功能類,比如RedisAutoConfiguration負(fù)責(zé):
JedisConnectionFactory、RedisTemplate、StringRedisTemplate這3個(gè)功能類的創(chuàng)建
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
- RedisAutoConfiguration配置類生效的一個(gè)條件是@ConditionalOnClass :JedisConnection.class, RedisOperations.class, Jedis.class,所以會(huì)去classpath下去查找對應(yīng)的class文件
@Configuration @ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }) @EnableConfigurationProperties(RedisProperties.class) public class RedisAutoConfiguration {}
- 如果pom.xml有對應(yīng)的jar包,就能匹配到對應(yīng)依賴class:JedisConnection.class, RedisOperations.class, Jedis.class
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> </dependency>
- 匹配成功,這個(gè)功能配置類才會(huì)生效,同時(shí)會(huì)注入默認(rèn)的屬性配置類@EnableConfigurationProperties(RedisProperties.class)
@ConfigurationProperties(prefix = "spring.redis") public class RedisProperties { private int database = 0; private String url; private String host = "localhost"; private String password; private int port = 6379;
- Redis功能配置里面會(huì)根據(jù)條件生成最終的JedisConnectionFactory、RedisTemplate,條件就是IOC環(huán)境里面,沒有用戶自定義的
@ConditionalOnMissingBean(RedisConnectionFactory.class)、RedisTemplate
@Configuration @ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }) @EnableConfigurationProperties(RedisProperties.class) public class RedisAutoConfiguration { @Bean @ConditionalOnMissingBean(RedisConnectionFactory.class) public JedisConnectionFactory redisConnectionFactory() throws UnknownHostException { return applyProperties(createJedisConnectionFactory()); } @Bean @ConditionalOnMissingBean(name = "redisTemplate") public RedisTemplate<Object, Object> redisTemplate( RedisConnectionFactory redisConnectionFactory) throws UnknownHostException { RedisTemplate<Object, Object> template = new RedisTemplate<Object, Object>(); template.setConnectionFactory(redisConnectionFactory); return template; } }
- 最終創(chuàng)建好的默認(rèn)裝配類,會(huì)通過功能配置類里面的 @Bean注解,注入到IOC當(dāng)中
原理和結(jié)果分析
通過各種注解,SpringApplication.run(Application.class, args)在運(yùn)行時(shí),會(huì)讀取spring-boot-autoconfigure.jar里面的spring.factories配置文件,配置文件中有所有自動(dòng)裝配類的配置類的className,然后生成對應(yīng)功能的Configuration類,這些功能配置類要生效的話,會(huì)去classpath中找是否有該類的依賴類(也就是pom.xml必須有對應(yīng)功能的jar包才行),然后配置類里再通過判斷生成最后的功能類,并且配置類里面注入了默認(rèn)屬性值類,功能類可以引用并賦默認(rèn)值。生成功能類的原則是自定義優(yōu)先,沒有自定義時(shí)才會(huì)使用自動(dòng)裝配類。
綜上所述,要想自動(dòng)裝配一個(gè)類需要滿足2個(gè)條件:
- spring.factories里面有這個(gè)類的配置類(一個(gè)配置類可以創(chuàng)建多個(gè)圍繞該功能的依賴類)
- pom.xml里面需要有對應(yīng)的jar包
整個(gè)過程的結(jié)果是兩件事情:
- 根據(jù)各種判斷和依賴,最終生成了業(yè)務(wù)需要的類并且注入到IOC容器當(dāng)中了
- 自動(dòng)裝配生成的類賦予了一些默認(rèn)的屬性值
依賴的注解
- @SpringBootApplication:sb項(xiàng)目應(yīng)用啟動(dòng)類的注解,其實(shí)是3個(gè)注解的組合:@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan,其中在自動(dòng)裝配中起作用的是第二個(gè)
- @EnableAutoConfiguration:表示SB應(yīng)用啟動(dòng)自動(dòng)裝配的功能(包括加載對應(yīng)的Bean到IOC容器中,且根據(jù)默認(rèn)配置對屬性賦值)
- @Import(EnableAutoConfigurationImportSelector.class):這個(gè)注解比較厲害,可以把沒有注冊到IOC中的Bean強(qiáng)行注冊到IOC中,表示啟動(dòng)自動(dòng)配置功能需要引入EnableAutoConfigurationImportSelector.class才行
- @Configuration
- @ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }):表示讓RedisAutoConfiguration配置類起作用的話,必須有包含這些類的jar包才行
- @EnableConfigurationProperties(RedisProperties.class):表示默認(rèn)引用RedisProperties.class里面的配置
- @ConditionalOnMissingBean(RedisConnectionFactory.class):這是個(gè)很厲害的注解,實(shí)現(xiàn)自動(dòng)裝配時(shí)自定義優(yōu)先。表示如果用戶沒有自定義注入RedisConnectionFactory.class類,才會(huì)使用默認(rèn)的JedisConnectionFactory。
自動(dòng)裝配的過程
- 通過各種注解實(shí)現(xiàn)了類與類之間的依賴關(guān)系,容器在啟動(dòng)的時(shí)候Application.run,會(huì)調(diào)用EnableAutoConfigurationImportSelector.class的selectImports方法(其實(shí)是其父類的方法)
- selectImports方法最終會(huì)調(diào)用SpringFactoriesLoader.loadFactoryNames方法來獲取一個(gè)全面的常用BeanConfiguration列表
- loadFactoryNames方法會(huì)讀取FACTORIES_RESOURCE_LOCATION(也就是spring-boot-autoconfigure.jar 下面的spring.factories),獲取到所有的Spring相關(guān)的Bean的全限定名ClassName,大概120多個(gè)
- selectImports方法繼續(xù)調(diào)用filter(configurations, autoConfigurationMetadata);這個(gè)時(shí)候會(huì)根據(jù)這些BeanConfiguration里面的條件,來一一篩選,最關(guān)鍵的是@ConditionalOnClass,這個(gè)條件注解會(huì)去classpath下查找,jar包里面是否有這個(gè)條件依賴類,所以必須有了相應(yīng)的jar包,才有這些依賴類,才會(huì)生成IOC環(huán)境需要的一些默認(rèn)配置Bean
- 最后把符合條件的BeanConfiguration注入默認(rèn)的EnableConfigurationPropertie類里面的屬性值,并且注入到IOC環(huán)境當(dāng)中
以上就是SpringBoot自動(dòng)裝配原理詳解的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot自動(dòng)裝配原理的資料請關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
SpringBoot多數(shù)據(jù)源配置的全過程記錄
在用SpringBoot開發(fā)項(xiàng)目時(shí),隨著業(yè)務(wù)量的擴(kuò)大,我們通常會(huì)進(jìn)行數(shù)據(jù)庫拆分或是引入其他數(shù)據(jù)庫,從而我們需要配置多個(gè)數(shù)據(jù)源,下面這篇文章主要給大家介紹了關(guān)于SpringBoot多數(shù)據(jù)源配置的相關(guān)資料,需要的朋友可以參考下2021-11-11Spring Boot MyBatis 連接數(shù)據(jù)庫配置示例
本篇文章主要介紹了Spring Boot MyBatis 連接數(shù)據(jù)庫示例的相關(guān)資料,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下。2017-02-02輸出java進(jìn)程的jstack信息示例分享 通過線程堆棧信息分析java線程
通過ps到j(luò)ava進(jìn)程號將進(jìn)程的jstack信息輸出。jstack信息是java進(jìn)程的線程堆棧信息,通過該信息可以分析java的線程阻塞等問題。2014-01-01spring?boot項(xiàng)目中如何使用nacos作為配置中心
這篇文章主要介紹了spring?boot項(xiàng)目中如何使用nacos作為配置中心問題,具有很好的參考價(jià)值,希望對大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2022-12-12Spring編程式和聲明式事務(wù)實(shí)例講解小結(jié)
這篇文章主要介紹了Spring編程式和聲明式事務(wù)實(shí)例講解小結(jié),文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-07-07SpringBoot整合Redis實(shí)現(xiàn)登錄失敗鎖定功能(實(shí)例詳解)
本文我們已經(jīng)探討如何利用Redis來實(shí)現(xiàn)鎖定賬戶的安全措施,以及通過SpringBoot整合Redis實(shí)現(xiàn)了這一功能,感興趣的朋友跟隨小編一起學(xué)習(xí)下吧2024-02-02