傳統(tǒng)的Spring項目會有很多的配置文件主籍,比如我們要使用Redis,一般除了對應的依賴的jar包我們還需要在application.xml里面配置JedisConnectionFactory眷蜈、JedisPoolConfig、RedisTemplate阿迈。但是如果使用SpringBoot的話,系統(tǒng)會根據(jù)pom.xml里面的jar包稚伍,自動生成這些類并且注入到IOC容器當中弯予。
- 傳統(tǒng)Spring項目中需要配置
<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引入相應的jar包外个曙,只需要在application.properties配置對應的屬性值即可
以Redis舉例
- 從spring-boot-autoconfigure.jar/META-INF/spring.factories中獲取120多個默認功能配置類锈嫩,其中包括redis的功能配置類RedisAutoConfiguration的全限定名,一般一個功能配置類圍繞該功能垦搬,負責管理創(chuàng)建多個相關的功能類呼寸,比如RedisAutoConfiguration負責:JedisConnectionFactory、RedisTemplate悼沿、StringRedisTemplate這3個功能類的創(chuàng)建
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,\
- RedisAutoConfiguration配置類生效的一個條件是@ConditionalOnClass :JedisConnection.class, RedisOperations.class, Jedis.class,所以會去classpath下去查找對應的class文件
@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class })
@EnableConfigurationProperties(RedisProperties.class)
public class RedisAutoConfiguration {}
- 如果pom.xml有對應的jar包,就能匹配到對應依賴class:JedisConnection.class, RedisOperations.class, Jedis.class
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
- 匹配成功,這個功能配置類才會生效骚灸,同時會注入默認的屬性配置類@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功能配置里面會根據(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)建好的默認裝配類义郑,會通過功能配置類里面的 @Bean注解,注入到IOC當中
原理和結果分析
通過各種注解丈钙,SpringApplication.run(Application.class, args)在運行時非驮,會讀取spring-boot-autoconfigure.jar里面的spring.factories配置文件,配置文件中有所有自動裝配類的配置類的className雏赦,然后生成對應功能的Configuration類劫笙,這些功能配置類要生效的話,會去classpath中找是否有該類的依賴類(也就是pom.xml必須有對應功能的jar包才行)星岗,然后配置類里再通過判斷生成最后的功能類填大,并且配置類里面注入了默認屬性值類,功能類可以引用并賦默認值俏橘。生成功能類的原則是自定義優(yōu)先允华,沒有自定義時才會使用自動裝配類。
綜上所述寥掐,要想自動裝配一個類需要滿足2個條件:
- spring.factories里面有這個類的配置類(一個配置類可以創(chuàng)建多個圍繞該功能的依賴類)
- pom.xml里面需要有對應的jar包
整個過程的結果是兩件事情:
- 根據(jù)各種判斷和依賴靴寂,最終生成了業(yè)務需要的類并且注入到IOC容器當中了
- 自動裝配生成的類賦予了一些默認的屬性值
依賴的注解
@SpringBootApplication:sb項目應用啟動類的注解,其實是3個注解的組合:@SpringBootConfiguration召耘、@EnableAutoConfiguration百炬、@ComponentScan,其中在自動裝配中起作用的是第二個
@EnableAutoConfiguration:表示SB應用啟動自動裝配的功能(包括加載對應的Bean到IOC容器中污它,且根據(jù)默認配置對屬性賦值)
@Import(EnableAutoConfigurationImportSelector.class):這個注解比較厲害收壕,可以把沒有注冊到IOC中的Bean強行注冊到IOC中,表示啟動自動配置功能需要引入EnableAutoConfigurationImportSelector.class才行
@Configuration
@ConditionalOnClass({ JedisConnection.class, RedisOperations.class, Jedis.class }):表示讓RedisAutoConfiguration配置類起作用的話妓灌,必須有包含這些類的jar包才行
@EnableConfigurationProperties(RedisProperties.class):表示默認引用RedisProperties.class里面的配置
@ConditionalOnMissingBean(RedisConnectionFactory.class):這是個很厲害的注解,實現(xiàn)自動裝配時自定義優(yōu)先蜜宪。表示如果用戶沒有自定義注入RedisConnectionFactory.class類虫埂,才會使用默認的JedisConnectionFactory。
自動裝配的過程
通過各種注解實現(xiàn)了類與類之間的依賴關系圃验,容器在啟動的時候Application.run掉伏,會調用EnableAutoConfigurationImportSelector.class的selectImports方法(其實是其父類的方法)
selectImports方法最終會調用SpringFactoriesLoader.loadFactoryNames方法來獲取一個全面的常用BeanConfiguration列表
loadFactoryNames方法會讀取FACTORIES_RESOURCE_LOCATION(也就是spring-boot-autoconfigure.jar 下面的spring.factories),獲取到所有的Spring相關的Bean的全限定名ClassName澳窑,大概120多個
selectImports方法繼續(xù)調用filter(configurations, autoConfigurationMetadata);這個時候會根據(jù)這些BeanConfiguration里面的條件斧散,來一一篩選,最關鍵的是
@ConditionalOnClass摊聋,這個條件注解會去classpath下查找鸡捐,jar包里面是否有這個條件依賴類,所以必須有了相應的jar包麻裁,才有這些依賴類箍镜,才會生成IOC環(huán)境需要的一些默認配置Bean最后把符合條件的BeanConfiguration注入默認的EnableConfigurationPropertie類里面的屬性值,并且注入到IOC環(huán)境當中
參考資料
主要是取自這個大佬的內容煎源,不過這篇博客內容量太大色迂,功力太深
http://www.reibang.com/p/83693d3d0a65