SpringBoot開發(fā)實戰(zhàn)之自動配置
在介紹SpringBoot的自動配置之前，先了解下注解@Import的使用，SpringBoot的@Enable*開頭的注解底層依賴于@Import注解導入一些類，使用@Import導入的類會被Spring加載到IOC容器中，而@Import提供了以下4中用法：
- 直接導入Bean
- 通過配置類導入Bean
- 導入ImportSelector實現類,一般用于加載配置文件的類
- 導入ImportBeanDefinitionRegistrar實現類
下面來分別介紹這幾種用法。
直接導入Bean就比較簡單了，新建一個User類
public class User{
private String name;
private String address;
}
然后在啟動類上使用@Import注解導入即可
@SpringBootApplication
@Import(User.class)
public class Application {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(Application.class,args);
System.out.println(context.getBean(User.class));
}
}
這里需要注意的是，通過上下文獲取Bean時，需要使用Bean的class，因為通過Bean的方式導入，Spring存入IOC容器，是用類的全類名存儲的?？梢允褂蒙舷挛牡膅etBeansOfType方法查看，返回的是Map對象。
{com.tenghu.sbc.entity.User=User(name=null, age=0)}
從返回的結果可以看出，key就是存的User的全類名。
通過配置類導入Bean，創(chuàng)建一個配置類;
public class UserConfig {
@Bean(name = "user")
public User user(){
return new User();
}
}
然后通過@Import導入這個配置類
@SpringBootApplication
@Import(UserConfig.class)
public class Application {
public static void main(String[] args) {
ConfigurableApplicationContext context = SpringApplication.run(Application.class,args);
System.out.println(context.getBean(User.class));
}
}
通過配置類的方式可以在配置類里面定義多個Bean，當導入配置類時，配置類下定義的Bean都會被導入。
導入ImportSelector實現類
public class MyImportSelector implements ImportSelector {
@Override
public String[] selectImports(AnnotationMetadata annotationMetadata) {
return new String[]{User.class.getName()};
}
}
實現ImportSelector類，必須實現selectImports，然后返回需要導入的Bean。與上面一樣使用@Import導入這個實現類。
@Import(MyImportSelector.class)
導入ImportBeanDefinitionRegistrar實現類
public class MyImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
BeanDefinition beanDefinition = BeanDefinitionBuilder.genericBeanDefinition(User.class).getBeanDefinition();
registry.registerBeanDefinition("user",beanDefinition);
}
}
使用方式一樣，通過@Import導入
@Import(MyImportBeanDefinitionRegistrar.class)
了解完@Import的使用，接下來可以來看下SpringBoot的自動配置是怎么處理的。從上面的啟動類，使用SpringBoot就用了一個注解@SpringBootApplication，可以打開這個注解的源碼看下：
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
excludeFilters = {@Filter(
type = FilterType.CUSTOM,
classes = {TypeExcludeFilter.class}
), @Filter(
type = FilterType.CUSTOM,
classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication
用到這樣一個注解@EnableAutoConfiguration注解。底層使用@Import導入上面第三種方式AutoConfigurationImportSelector。
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@AutoConfigurationPackage
@Import({AutoConfigurationImportSelector.class})
public @interface EnableAutoConfiguration {
String ENABLED_OVERRIDE_PROPERTY = "spring.boot.enableautoconfiguration";
Class<?>[] exclude() default {};
String[] excludeName() default {};
}
進入源碼找到實現了selectImports方法
public String[] selectImports(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return NO_IMPORTS;
} else {
AutoConfigurationImportSelector.AutoConfigurationEntry autoConfigurationEntry = this.getAutoConfigurationEntry(annotationMetadata);
return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());
}
}
通過調用方法getAutoConfigurationEntry
protected AutoConfigurationImportSelector.AutoConfigurationEntry getAutoConfigurationEntry(AnnotationMetadata annotationMetadata) {
if (!this.isEnabled(annotationMetadata)) {
return EMPTY_ENTRY;
} else {
AnnotationAttributes attributes = this.getAttributes(annotationMetadata);
List<String> configurations = this.getCandidateConfigurations(annotationMetadata, attributes);
configurations = this.removeDuplicates(configurations);
Set<String> exclusions = this.getExclusions(annotationMetadata, attributes);
this.checkExcludedClasses(configurations, exclusions);
configurations.removeAll(exclusions);
configurations = this.getConfigurationClassFilter().filter(configurations);
this.fireAutoConfigurationImportEvents(configurations, exclusions);
return new AutoConfigurationImportSelector.AutoConfigurationEntry(configurations, exclusions);
}
}
這里主要的看調用這個方法getCandidateConfigurations，返回的就是要自動加載的Bean
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
return configurations;
}
通過META-INF/spring.factories配置文件里的EnableAutoConfiguration獲取配置的Bean
# Auto Configure org.springframework.boot.autoconfigure.EnableAutoConfiguration=\ org.springframework.boot.autoconfigure.admin.SpringApplicationAdminJmxAutoConfiguration,\ org.springframework.boot.autoconfigure.aop.AopAutoConfiguration,\ org.springframework.boot.autoconfigure.amqp.RabbitAutoConfiguration,\ org.springframework.boot.autoconfigure.batch.BatchAutoConfiguration,\ org.springframework.boot.autoconfigure.cache.CacheAutoConfiguration,\ org.springframework.boot.autoconfigure.cassandra.CassandraAutoConfiguration,\ .....
太多了，有興趣的可以查看Spring的xxx-autoconfigure包。將讀取到的配置最終返回給selectImports，然后通過工具類StringUtils.toStringArray轉換為字符串數組返回給@Import，從而實現自動配置。第三方包只要是xxx-autoconfigure結尾的包，META-INF都有spring.factories，這個名字是固定寫法。都可以被SpringBoot識別并且進行自動配置，前提是需要配置到org.springframework.boot.autoconfigure.EnableAutoConfiguration下。
從以上總結來看，SpringBoot的自動配置原理如下：
- @EnableAutoConfiguration注解內部使用Import(AutoConfigurationImportSelector.class)來加載配置類
- 通過配置文件：META-INF/spring.factories，配置大量的配置類，SpringBoot啟動時就會自動加載這些類并初始化的Bean。
這里需要說明一點，并不是所有配置到配置文件的Bean都會被初始化，需要符合配置類中使用Condition來加載滿足條件的Bean。比如我們打開RedisAutoConfiguration的源碼查看：
@Configuration(
proxyBeanMethods = false
)
@ConditionalOnClass({RedisOperations.class})
@EnableConfigurationProperties({RedisProperties.class})
@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})
public class RedisAutoConfiguration {
public RedisAutoConfiguration() {
}
@Bean
@ConditionalOnMissingBean(
name = {"redisTemplate"}
)
@ConditionalOnSingleCandidate(RedisConnectionFactory.class)
public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
RedisTemplate<Object, Object> template = new RedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
@Bean
@ConditionalOnMissingBean
@ConditionalOnSingleCandidate(RedisConnectionFactory.class)
public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
StringRedisTemplate template = new StringRedisTemplate();
template.setConnectionFactory(redisConnectionFactory);
return template;
}
}
類上面有這么個注解@ConditionalOnClass({RedisOperations.class})，意思就是需要RedisOperations類存在的情況下，才自動加載；這還不算完，繼續(xù)查看下面的方法上有個@ConditionalOnMissingBean(name = {"redisTemplate"})，這里的意思是，當其他地方沒有redisTemplate實例化這個Bean時，才自動加載。符合這兩個條件，SpringBoot才會進行自動加載并初始化。
總結
到此這篇關于SpringBoot開發(fā)實戰(zhàn)之自動配置的文章就介紹到這了,更多相關SpringBoot自動配置內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
springboot-dubbo cannot be cast to問題及解決
這篇文章主要介紹了springboot-dubbo cannot be cast to問題及解決方案，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-04-04
本篇文章主要介紹了淺談Java中的Filter過濾器，小編覺得挺不錯的，現在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-02-02
俄羅斯方塊是一個最初由阿列克謝帕吉特諾夫在蘇聯設計和編程的益智類視頻游戲。本文將利用Java實現這一經典的小游戲，感興趣的可以動手試一試2022-03-03
這篇文章主要為大家介紹了java?工作流引擎設計與實現及流程定義文件解析，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2023-05-05
SpringBoot整合定時任務之實現Scheduled注解的過程(一個注解全解決)
這篇文章主要介紹了SpringBoot整合定時任務之實現Scheduled注解的過程(一個注解全解決),本文通過使用場景分析給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-09-09
spring event 事件異步處理方式(發(fā)布,監(jiān)聽,異步處理)
這篇文章主要介紹了spring event 事件異步處理方式(發(fā)布,監(jiān)聽,異步處理)，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2023-02-02
這篇文章主要給大家介紹了關于利用Servlet實現簡單的用戶登錄功能的相關資料，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-12-12
Transactional注解導致Spring Bean定時任務失效的解決方法
這篇文章主要介紹了Transactional注解導致Spring Bean定時任務失效的解決方法,文中通過代碼示例介紹的非常詳細,對大家解決問題有一定的幫助,需要的朋友可以參考下2024-10-10
下面小編就為大家?guī)硪黄狤clipse配置maven環(huán)境的圖文教程。小編覺得挺不錯的，現在就分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2017-11-11
在外賣軟件中的附近的美食店鋪、外賣小哥的距離，打車軟件附近的車輛，交友軟件中附近的小姐姐。我們都可以利用redis的GEO地理位置計算得出。本文就來詳細的介紹一下2021-10-10