springboot自動配置原理解析
小伙伴們都知道,現在市面上最流行的web開發框架就是springboot了,在springboot開始流行之前,我們都用的是strust2或者是springmvc框架來開發web應用,但是這兩個框架都有一個特點就是配置非常的繁瑣,要寫一大堆的配置文件,spring在支持了注解開發之后稍微有些改觀但有的時候還是會覺得比較麻煩,這個時候springboot就體現出了它的優勢,springboot只需要一個properties或者yml文件就可以簡化springmvc中在xml中需要配置的一大堆的bean,這就是因為springboot有自動配置,那么springboot自動配置的原理是什么呢,今天我們就來通過源碼分析一下springboot的自動配置原理
開始我以springboot整合redis為例,來向大家分析springboot的自動配置原理
首先創建一個springboot工程用來測試,然后在pom文件中引入springboot-starter-redis的啟動器依賴
<dependencies><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId></dependency><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope></dependency><dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-redis</artifactId> <version>2.1.7.RELEASE</version></dependency></dependencies>
然后,在application.properties中配置redis屬性
spring.redis.port=6379spring.redis.host=localhostspring.redis.database=0
然后,在啟動類中注入redisTemplate類,redisTemplate為spring官方提供的對redis底層開發包(例如jedis)進行了深度封裝的組件,使用redisTemplate可以優雅的操作redis。我在啟動類中寫了一個測試方法,向redis寫入一條數據
@RequestMapping('/redistest') public String test(){redisTemplate.opsForSet().add('aaaaa','123456');return 'OK'; }
運行這個方法,打開redis客戶端可以看到值已經寫入了
先拋開這里的鍵和值讓人看不懂的問題,大家是不是覺得springboot整合redis要比普通的springmvc整合redis簡單多了?我只配置了redis的連接地址,端口號,注入了redisTemplate,就能開始操作redis了,那么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
可以看到SpringbootApplication這個注解是由一系列的注解組合而成,這其中最重要的是@EnableAutoConfiguration和@ComponentScan,@ComponentScan的意思就是組件掃描注解,這個注解會自動注入所有在主程序所在包下的組件。比@ComponentScan注解更重要的就是@EnableAutoConfiguration注解了,這個注解的含義就是開啟自動裝配,直接把bean裝配到ioc容器中,@EnableAutoConfiguration也是一個組合注解,我們點進去看一下
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@AutoConfigurationPackage@Import(AutoConfigurationImportSelector.class)public @interface EnableAutoConfiguration
這個地方我們主要看@AutoConfigurationPackage和@Import(AutoConfigurationImportSelector.class)兩個注解,首先來看@AutoConfigurationPackage注解
@Target(ElementType.TYPE)@Retention(RetentionPolicy.RUNTIME)@Documented@Inherited@Import(AutoConfigurationPackages.Registrar.class)public @interface AutoConfigurationPackage {}
這個注解主要是獲取我們注解所在包下的組件去進行注冊,大家看到這個@Import注解,那么這個注解是什么含義呢,
@Import注解用來導入@Configuration注解的配置類、聲明@Bean注解的bean方法、導入ImportSelector的實現類或導入ImportBeanDefinitionRegistrar的實現類,這里這個AutoConfigurationPackages.Registrar.class就是ImportBeanDefinitionRegistrar的實現類,來看下源碼
static class Registrar implements ImportBeanDefinitionRegistrar, DeterminableImports {//metadata是注解的元信息 registry是bean定義的注冊器@Overridepublic void registerBeanDefinitions(AnnotationMetadata metadata, BeanDefinitionRegistry registry) { //把注解所在的包下所有的組件都進行注冊register(registry, new PackageImport(metadata).getPackageName());}@Overridepublic Set<Object> determineImports(AnnotationMetadata metadata) {return Collections.singleton(new PackageImport(metadata));}}public static void register(BeanDefinitionRegistry registry, String... packageNames) {//首先判斷這個bean有沒有被注冊if (registry.containsBeanDefinition(BEAN)) {//獲取bean定義BeanDefinition beanDefinition = registry.getBeanDefinition(BEAN);//通過bean定義獲取構造函數值ConstructorArgumentValues constructorArguments = beanDefinition.getConstructorArgumentValues();//給構造函數添加參數值constructorArguments.addIndexedArgumentValue(0, addBasePackages(constructorArguments, packageNames));}else {//一個新的bean定義GenericBeanDefinition beanDefinition = new GenericBeanDefinition();//設置beanClass為beanPackages類型beanDefinition.setBeanClass(BasePackages.class);beanDefinition.getConstructorArgumentValues().addIndexedArgumentValue(0, packageNames);beanDefinition.setRole(BeanDefinition.ROLE_INFRASTRUCTURE);//bean注冊registry.registerBeanDefinition(BEAN, beanDefinition);}}
接下來就是@Import(AutoConfigurationImportSelector.class)這個注解,我們來看看AutoConfigurationImportSelector這個類,這個類是我們自動裝配的導入選擇器,首先看這個類的第一個方法,其實也就是這個類的核心方法
@Overridepublic String[] selectImports(AnnotationMetadata annotationMetadata) {if (!isEnabled(annotationMetadata)) {return NO_IMPORTS;}//加載元數據AutoConfigurationMetadata autoConfigurationMetadata = AutoConfigurationMetadataLoader.loadMetadata(this.beanClassLoader);//獲得自動裝配的實體AutoConfigurationEntry autoConfigurationEntry = getAutoConfigurationEntry(autoConfigurationMetadata,annotationMetadata);return StringUtils.toStringArray(autoConfigurationEntry.getConfigurations());}
protected AutoConfigurationEntry getAutoConfigurationEntry(AutoConfigurationMetadata autoConfigurationMetadata,AnnotationMetadata annotationMetadata) {if (!isEnabled(annotationMetadata)) {return EMPTY_ENTRY;}//獲得屬性AnnotationAttributes attributes = getAttributes(annotationMetadata);//獲得候選的配置類,核心方法List<String> configurations = getCandidateConfigurations(annotationMetadata, attributes);//去除重復configurations = removeDuplicates(configurations);//獲得排除的配置Set<String> exclusions = getExclusions(annotationMetadata, attributes);//檢查排除的配置checkExcludedClasses(configurations, exclusions);//排除configurations.removeAll(exclusions);configurations = filter(configurations, autoConfigurationMetadata);fireAutoConfigurationImportEvents(configurations, exclusions);return new AutoConfigurationEntry(configurations, exclusions);}
在這部分中,核心方法是getCandidateConfigurations,我們來看下這個方法
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {//從工廠中獲取自動配置類List<String> configurations = SpringFactoriesLoader.loadFactoryNames(getSpringFactoriesLoaderFactoryClass(),getBeanClassLoader());//這句斷言很重要,告訴了我們工廠是去哪里找自動配置類的,這里顯然META-INF/spring.factories是一個路徑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;}
那我們就找一下這個路徑,去哪里找呢,我們看到這個類的包是org.springframework.boot.autoconfigure;那我們就到這個包的位置去找這個spring.factories,果不其然,我們點開這個文件
我們看到文件中有一行注釋這Auto configure,表示這些都是自動配置相關的類,這里我們不得不說spring框架真的是強大,這里面居然有100多個自動配置類,我們找到redis有關的自動配置類
org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisReactiveAutoConfiguration,org.springframework.boot.autoconfigure.data.redis.RedisRepositoriesAutoConfiguration,
這里我們需要的肯定是第一個自動配置類,我們點進去看看
@Configuration//條件注解,某個class位于類路徑上,才會實例化一個Bean,這個類是redis操作的類@ConditionalOnClass(RedisOperations.class)//使得@ConfigurationProperties 注解的類生效,這個類是配置redis屬性的類@EnableConfigurationProperties(RedisProperties.class)//導入一些配置@Import({ LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class })public class RedisAutoConfiguration {@Bean//僅僅在當前上下文中不存在某個對象時,才會實例化一個Bean,這個就是spring默認的redisTemplate@ConditionalOnMissingBean(name = 'redisTemplate')public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory)throws UnknownHostException {RedisTemplate<Object, Object> template = new RedisTemplate<>();template.setConnectionFactory(redisConnectionFactory);return template;}@Bean@ConditionalOnMissingBeanpublic StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory)throws UnknownHostException {StringRedisTemplate template = new StringRedisTemplate();template.setConnectionFactory(redisConnectionFactory);return template;}}
我們在application.properties中配置的redis屬性,其實就是設置到了這個類中
//前綴spring.redis@ConfigurationProperties(prefix = 'spring.redis')public class RedisProperties {/** * Database index used by the connection factory. */private int database = 0;/** * Connection URL. Overrides host, port, and password. User is ignored. Example: * redis://user:[email protected]:6379 */private String url;/** * Redis server host. */private String host = 'localhost';/** * Login password of the redis server. */private String password;/** * Redis server port. */private int port = 6379;/** * Whether to enable SSL support. */private boolean ssl;/** * Connection timeout. */private Duration timeout;private Sentinel sentinel;private Cluster cluster;private final Jedis jedis = new Jedis();private final Lettuce lettuce = new Lettuce();}
我們前面說了,用了spring默認的redisTemplate操作redis的話,存到redis里的數據對我們的閱讀不友好,我們看不懂,那是因為redisTemplate中默認用了jdk自帶的序列化器
要想讓數據變成我們能看得懂的樣子,我們需要替換掉redisTempalte默認的序列化器,現在我就來實操一下,寫一個配置類
@Configurationpublic class RedisConfig { //這里的上下文已經有了自定義的redisTemplate,所以默認的redisTemplate不會生效 @Bean public RedisTemplate<Object,Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {RedisTemplate<Object,Object> redisTemplate=new RedisTemplate<>();//設置自定義序列化器redisTemplate.setDefaultSerializer(new Jackson2JsonRedisSerializer<Object>(Object.class));redisTemplate.setConnectionFactory(redisConnectionFactory);return redisTemplate; }}
然后我改寫一下測試方法,一起來看結果
public String test(){redisTemplate.opsForSet().add('ffffff','55555555');return 'OK'; }
我們看到,序列化器已經生效了,鍵值對已經是我們能看得懂的了。
總結通過springboot整合redis的過程,我帶大家分析了一下springboot的自動配置原理,基本上市面上流行的組件可以和spring整合的spring官方都有starter,引入starter,配合springboot的自動配置,基本上可以做到只需要幾行屬性的配置加上類的注入,就可以使用了,spring框架博大精深,還有很多很多東西需要學習,有時間我再給大家分享,望大家多多支持,謝謝。
以上就是springboot自動配置原理解析的詳細內容,更多關于springboot自動配置原理的資料請關注好吧啦網其它相關文章!
相關文章:
