Spring Boot自动设置装备摆设道理与实践(一)

2019年7月2日10:59:11Spring Boot自动设置装备摆设道理与实践(一)已关闭评论 213

媒介

  Spring Boot尽人皆知是为了简化Spring的设置装备摆设,省去XML的庞杂化设置装备摆设(虽然Spring官方引荐也运用Java设置装备摆设)接纳Java+Annotation体式格局设置装备摆设。以下几个题目是我刚最先打仗Spring Boot的时刻常常碰到的一些疑问,如今总结出来希望能资助到更多的人邃晓Spring Boot,固然这只是小我的邃晓,轻微显得浅薄但易懂!事先我邃晓了以下几个题目后,以为Spring Boot也不过云云,没有啥花狸狐哨的,希望能帮到人人!

  本博文主要由两个局部构成:第一篇经由历程源码等情势引见自动设置装备摆设的道理与构成局部,第二篇经由历程完成自定义的starter完成自动设置装备摆设加深对自动设置装备摆设的邃晓。

  注:创作不容易啊,虽然写只写了5个小时摆布,然则全部预备历程很早就最先了,固然如许的纪录体式格局主若是催促本身对Spring Boot要深切邃晓,顺带希望能帮到更多人

  题目一:那末Spring Boot是靠甚么样的手腕简化设置装备摆设呢?

  从广义上讲,从软件设计范式来讲。Spring Boot供应一种“商定优于设置装备摆设”来简化设置装备摆设;削减开辟人员去开辟没必要的设置装备摆设模块时候,接纳商定,而且对不相符商定的局部接纳天真设置装备摆设知足便可!

  题目二:那末甚么叫商定优于设置装备摆设呢?

  好比:我们晓得Spring Boot都是内嵌Tomcat、Jetty等效劳器的,个中默许的Tomcat效劳器,响应的监听端口也默许绑定,这些默许即为商定大局部状况下我们都邑运用默许默许的Spring Boot自带的内嵌的默许自动设置装备摆设商定,不会大批去自定义设置装备摆设,即这就是我邃晓的商定优于设置装备摆设。那末题目三来了。当我们以为不相符我们现实消费状况的时刻才会去转变默许设置装备摆设,那末须要很贫苦的手腕吗?

  题目三:变动默许的端口或许效劳器(即上述提到的商定)须要很贫苦的代码编写吗?以至须要变动源码吗?

  谜底肯定是不是认的,只须要变动application.yml/properties(application-*.yml/properties)设置装备摆设文件便可。固然也能够从源头上最先从新建立本身须要的模块(正确来讲能够是starter),须要的注册的设置装备摆设类Bean。从而到达天真的自动设置装备摆设目标,这就是本篇要引见的Spring Boot的自动设置装备摆设。

  邃晓以上三个题目后,实在就可以邃晓为何Spring Boot相对Spring越发天真,轻易,简朴的缘由了========>不过就是大批运用默许自动设置装备摆设+天真的自动设置装备摆设

 

 

 

一、Spring Boot自动设置装备摆设的道理引见

 

  主要从spring boot是怎样启动后自动检测自动设置装备摆设与spring boot怎样天真处置惩罚自动设置装备摆设两个方面解说,前者主要剖析源码,从简朴的注解入手到末了的读取spring.facoties文件。后者主要举例RedisAutoConfiguration自动设置装备摆设来讲明spring boot关于相干的设置装备摆设类bean的经由历程注解的天真处置惩罚。

1、Spring Boot是怎样发明自动设置装备摆设的?

都晓得Spring Boot递次进口处(xxxApplication.java)都邑有 @SpringBootApplication 的注解。这个注解注解该递次是主递次进口,也是SpringBoot运用

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

检察 @SpringBootApplication 注解,不难发明是一个组合注解,包罗了 @SpringBootConfiguration @EnableAutoConfiguration @ComponentScan 。换句话说这三个注解能够替换 @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}
)}
)

个中注解  @EnableAutoConfiguration  就是完成SpringBoot自动设置装备摆设的关键所在,值得注意的是@EnableXXXX注解并非SpringBoot特有,在Spring 3.x中就已引出,好比:@EnableWebMvc用来启用Spring MVC而不须要XML设置装备摆设,@EnableTransactionManagement解释用来声明事务管理而不须要XML设置装备摆设。云云可见,@EnableXXXX是用来开启某一个特定的功用,从而运用Java来设置装备摆设,省去XML设置装备摆设。在SpringBoot中自动设置装备摆设的开启就是依托注解  @EnableAutoConfiguration  ,继承检察注解接口 @EnableAutoConfiguration 

@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 {};
}

个中关键是 @Import({AutoConfigurationImportSelector.class}) ,透露表现挑选一切SpringBoot的自动设置装备摆设。空话不多说,还得继承看该挑选器源码,个中最主要的要领是 getAutoConfiguationEntry 要领,该要领的主要功用是:

取得自动设置装备摆设---->删除反复自动设置装备摆设----->删除排撤除的自动设置装备摆设---->删除过滤掉的自动设置装备摆设------>终究的自动设置装备摆设

Spring Boot自动设置装备摆设道理与实践(一)

这里我们主要存眷怎样猎取自动设置装备摆设,即图中红圈局部,即 getCandidateConfigurations 要领,该要领经由历程SpringFactoresLoader.loadFactoryNames要领读取某个classpath下的文件猎取一切的configurations

Spring Boot自动设置装备摆设道理与实践(一)

注意到: No auto configuration classes found in META-INF/spring.factories..... ,它应该是从META-INF/spring.factories文件中下读取configurations,我们再往下检察要领 SpringFactoresLoader.loadFactoryNames ,该要领果然是读取META-INF/spring.factories文件的,从中猎取自动设置装备摆设键值对。

 Spring Boot自动设置装备摆设道理与实践(一)

末了,我们找到META-INF/spring.factories文件(位于spring-boot-autoconfigure下)

Spring Boot自动设置装备摆设道理与实践(一)

检察其内容:

...
# 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,\
org.springframework.boot.autoconfigure.cloud.CloudServiceConnectorsAutoConfiguration,\
org.springframework.boot.autoconfigure.context.ConfigurationPropertiesAutoConfiguration,\
org.springframework.boot.autoconfigure.context.MessageSourceAutoConfiguration,\
org.springframework.boot.autoconfigure.context.PropertyPlaceholderAutoConfiguration,\
org.springframework.boot.autoconfigure.couchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraReactiveRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.couchbase.CouchbaseDataAutoConfiguration,\
...

 这时刻才名顿开,原来云云。简朴总结起来就是,当SpringBoot运用启动读取自动设置装备摆设以后,从上到下的相干挪用栈(笔墨简朴形貌)

  • @EnableAutoConfiguration开启启动设置装备摆设功用
  • 经由历程@Import导入AutoConfigurationImportSelector挑选器发明(注册)自动设置装备摆设
  • getAutoConfigurationEntry要领猎取并处置惩罚一切的自动设置装备摆设
  • SpringFactoriesLoader.loadFactoryNames读取spring.factories文件并加载自动设置装备摆设键值对。

 

 2、Spring Boot是怎样天真处置惩罚自动设置装备摆设的?

 

  从spring.factories文件中我们拔取RedisAutoConfiguration举例申明,至于为何选这个呢?这是由于之前我有写过关于Spring Boot整合Redis的相干博文。以是好入手!

起首,照样一样进入RedisAutoConfiguration(Idea大法好,点击进入便可检察代码)

Spring Boot自动设置装备摆设道理与实践(一)

源码以下,主要存眷以下几个注解:

1)@ConditionalOnClass在以后classpath下是不是存在指定类,若是则将以后的设置装备摆设注册到spring容器。可见其天真性。相干的@ConditionalXXX注解是spring 4.x推出的天真注册bean的注解,称之为“前提注解”。有以下一系列前提注解:

  • @ConditionalOnMissingBean: 当spring容器中不存在指定的bean时,才会注册该Bean。
  • @ConditionalOnMissingClass:当不存在指定的类时,才会注册该bean。
  • @ConditionalOnProperty:依据设置装备摆设文件中某个属性来决议是不是注册该Bean,相对别的前提注解较为庞杂。主要有以下两种状况运用:

  一种是@ConditionalOnProperty(prefix = “mysql”, name = “enable”, havingValue = “true”)透露表现以为mysql为前缀的mysql.enable属性若是为空或许不是true时不会注册指定Bean,只要mysql.enable属性为true时刻才会注册该指定Bean

    一种是@ConditionalOnProperty(prefix = “mysql”, name = “enable”, havingValue = “true”, matchIfMissing = true)matchIfMissing透露表现若是没有以mysql为前缀的enable属性,则为true透露表现相符前提,能够注册该指定Bean,默许为false。

  • @ConditionalOnJava:是不是是Java运用
  • @ConditionalOnWebApplication:是不是是Web运用
  • @ConditionalOnExpression:依据表达式推断是不是注册Bean

  ...........剩下的另有许多,在autoconfigure.condition包下...........

    Spring Boot自动设置装备摆设道理与实践(一)

 

2)@EnableConfigurationProperties让 @ConfigurationProperties 注解的properties类见效并运用。如让RedisProperties见效并注册到Spring容器中,而且运用!

3)@ConditionalOnMissingBean以后Spring容器中没有该bean(name或许class指定),则注册该bean到spring容器。

@Configuration
@ConditionalOnClass({RedisOperations.class})
@EnableConfigurationProperties({RedisProperties.class})
@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})
public class RedisAutoConfiguration {
    public RedisAutoConfiguration() {
    }

    @Bean
    @ConditionalOnMissingBean(
        name = {"redisTemplate"}
    )
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        RedisTemplate<Object, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

    @Bean
    @ConditionalOnMissingBean
    public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        StringRedisTemplate template = new StringRedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }
}

 因而可知Spring Boot关于自动设置装备摆设的天真性,能够通报给我们一种信息,Spring Boot是怎样天真处置惩罚自动设置装备摆设的?

往大了说,就是你能够挑选商定运用大批默许设置装备摆设简化开辟历程,你也能够自定义开辟历程当中须要的自动设置装备摆设。往细了说,就是经由历程形形色色的前提注解注册须要的Bean来完成天真设置装备摆设。

那末完成一个自动设置装备摆设有哪些主要的环节呢?

继承往下看第二局部!

 

二、Spring Boot自动设置装备摆设的主要构成局部

 

  上面只是对自动设置装备摆设中几个主要的注解做了简朴引见,然则并没有引见要开辟一个简朴的自动设置装备摆设须要哪些环节(局部),同样地我们照样以RedisAutoConfiguration与RabbitAutoConfiguration为例,主要检察注解头:

RedisAutoConfiguration:

@Configuration
@ConditionalOnClass({RedisOperations.class})
@EnableConfigurationProperties({RedisProperties.class})
@Import({LettuceConnectionConfiguration.class, JedisConnectionConfiguration.class})

RabbitAutoConfiguration:

@Configuration
@ConditionalOnClass({RabbitTemplate.class, Channel.class})
@EnableConfigurationProperties({RabbitProperties.class})
@Import({RabbitAnnotationDrivenConfiguration.class})

你会发明一样平常的一样平常的AutoConfiguration都有@Configuration,@ConditionalOnClass,@EnableConfigurationProperties,@Import 注解:

  • @Configuration:天然没必要多说,透露表现是设置装备摆设类,是必需存在的!
  • @ConditionalOnClass:透露表现该设置装备摆设依靠于某些Class是不是在ClassPath中,若是不存在那末这个设置装备摆设类是毫无意义的。也能够说是该class在设置装备摆设类中充任主要的脚色,是必需存在的!。在后面的自定义spring boot starter中我们能够简朴统称为效劳类
  • @EnableConfigurationProperties:读取设置装备摆设文件,须要让相干的Properties见效,每一个自动设置装备摆设都离不开properties属性,是必需存在的!
  • @Import:导入设置装备摆设类中须要用到的bean,一样平常是一些设置装备摆设类。透露表现此时的自动设置装备摆设类须要基于一些设置装备摆设类而完成自动设置装备摆设功用。固然不是必需的,有些是没有这个注解的,是不须要基于某些设置装备摆设类的!

那末,能够简朴总结获得一个自动设置装备摆设类主要有以下几局部构成(纯真是依据小我邃晓总结出来的,没有官方申明)

  • properties bean设置装备摆设属性:用来读取spring设置装备摆设文件中的属性,@EnableConfigurationProperties与@ConfigurationProperties连系运用,详细请看下一篇实践stater例子。
  • 该设置装备摆设类依靠的一些Class,运用@ConditionalOnClass推断;
  • 该设置装备摆设类依靠的一些设置装备摆设Bean,运用@Import导入。
  • 能够另有加载递次的掌握,如@AutoConfigureAfter,@AutoConfigureOrder等
  • 一些Bean的加载,每每经由历程要领返回Object,加@Bean以及一些前提注解来完成

========================================未完待续(下一篇增补自定义starter会触及自动设置装备摆设构成局部)==========================================

 

avatar