SpringBoot四⼤神器之auto-configuration SpringBoot ⾃动配置主要通过@EnableAutoConfiguration, @Conditional, @EnableConfigurationProperties或者@ConfigurationProperties等⼏个注解来进⾏⾃动配置完成的。
@EnableAutoConfiguration开启⾃动配置,主要作⽤就是调⽤Spring-Core包⾥的loadFactoryNames(),将autoconfig包⾥的已经写好的⾃动配置加载进来。
@Conditional条件注解,通过判断类路径下有没有相应配置的jar包来确定是否加载和⾃动配置这个类。
@EnableConfigurationProperties的作⽤就是,给⾃动配置提供具体的配置参数,只需要写在application.properties中,就可以通过映射写⼊配置类的POJO属性中。
@EnableAutoConfiguration
@Enable*注释并不是SpringBoot新发明的注释,Spring 3框架就引⼊了这些注释,⽤这些注释替代XML配置⽂件。⽐如:
@EnableTransactionManagement注释,它能够声明事务管理
@EnableWebMvc注释,它能启⽤Spring MVC
@EnableScheduling注释,它可以初始化⼀个调度器。
这些注释事实上都是简单的配置,通过@Import注释导⼊。springboot aop
从启动类的@SpringBootApplication进⼊,在⾥⾯到了@EnableAutoConfiguration,
1.png
2.png
@EnableAutoConfiguration⾥通过@Import导⼊了EnableAutoConfigurationImportSelector,
3.png
进⼊他的⽗类AutoConfigurationImportSelector
4.png
到selectImports()⽅法,他调⽤了getCandidateConfigurations()⽅法,在这⾥,这个⽅法⼜调⽤了Spring Core包中的loadFactoryNames()⽅法。这个⽅法的作⽤是,会查询META-INF/spring.factories⽂件中包含的JAR⽂件。
5.png
当到spring.factories⽂件后,SpringFactoriesLoader将查询配置⽂件命名的属性。
6.png
7.png
Jar⽂件在org.springframework.boot.autoconfigure的spring.factories
8.png
spring.factories内容如下(截取部分),在这个⽂件中,可以看到⼀系列Spring Boot⾃动配置的列表
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.CloudAutoConfiguration,\
org.springframework.t.ConfigurationPropertiesAutoConfiguration,\
org.springframework.t.MessageSourceAutoConfiguration,\
org.springframework.t.PropertyPlaceholderAutoConfiguration,\
org.springframework.uchbase.CouchbaseAutoConfiguration,\
org.springframework.boot.autoconfigure.dao.PersistenceExceptionTranslationAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.cassandra.CassandraRepositoriesAutoConfiguration,\
org.springframework.boot.uchbase.CouchbaseDataAutoConfiguration,\
org.springframework.boot.uchbase.CouchbaseRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.elasticsearch.ElasticsearchRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.jpa.JpaRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapDataAutoConfiguration,\
org.springframework.boot.autoconfigure.data.ldap.LdapRepositoriesAutoConfiguration,\
org.springframework.boot.MongoDataAutoConfiguration,\
org.springframework.boot.MongoRepositoriesAutoConfiguration,\
org.springframework.boot.4j.Neo4jDataAutoConfiguration,\
org.springframework.boot.4j.Neo4jRepositoriesAutoConfiguration,\
org.springframework.boot.autoconfigure.data.solr.SolrRepositoriesAutoConfiguration,\
org.springframework.boot.dis.RedisAutoConfiguration,\
org.springframework.boot.dis.RedisRepositoriesAutoConfiguration,\
org.springframework.boot.st.RepositoryRestMvcAutoConfiguration,\
org.springframework.boot.autoconfigure.data.web.SpringDataWebAutoConfiguration,\
下⾯我们来看⾃动配置redis的细节,RedisAutoConfiguration:
RedisAutoConfiguration
redis.png
这个类进⾏了简单的Spring配置,声明了Redis所需典型Bean,和其它很多类⼀样,重度依赖于Spring Boot注释:
1)@ConditionOnClass激活⼀个配置,当类路径中存在这个类时才会配置该类
2)@EnableConfigurationProperties⾃动映射⼀个POJO到Spring Boot配置⽂件(默认是application.properties⽂件)的属性集。
3)@ConditionalOnMissingBean启⽤⼀个Bean定义,但必须是这个Bean之前未定义过才有效。
还可以使⽤@ AutoConfigureBefore注释、@AutoConfigureAfter注释来定义这些配置类的载⼊顺序。
着重了解@Conditional注释,Spring 4框架的新特性
此注释使得只有在特定条件满⾜时才启⽤⼀些配置。SrpingBoot的AutoConfig⼤量使⽤了@Conditional,它会根据运⾏环境来动态注⼊Bean。这⾥介绍⼀些@Conditional的使⽤和原理,并⾃定义@Conditional来⾃定义功能。
@Conditional是SpringFramework的功能,SpringBoot在它的基础上定义了
@ConditionalOnClass,@ConditionalOnProperty等⼀系列的注解来实现更丰富的内容。
具体⼏个@Conditon*注解的含义
@ConditionalOnBean
仅仅在当前上下⽂中存在某个对象时,才会实例化⼀个Bean
@ConditionalOnClass
某个class位于类路径上,才会实例化⼀个Bean),该注解的参数对应的类必须存在,否则不解析该注解修饰的配置类
@ConditionalOnExpression
当表达式为true的时候,才会实例化⼀个Bean
@ConditionalOnMissingBean
仅仅在当前上下⽂中不存在某个对象时,才会实例化⼀个Bean,该注解表⽰,如果存在它修饰的类的bean,则不需要再创建这个bean,可以给该注解传⼊参数例如@ConditionOnMissingBean(name = "example"),这个表⽰如果name为“example”的bean存在,这该注解修饰的代码块不执⾏
@ConditionalOnMissingClass
某个class类路径上不存在的时候,才会实例化⼀个Bean
@ConditionalOnNotWebApplication
不是web应⽤时,才会执⾏
2.Properties系列注释
@EnableConfigurationProperties
@ConfigurationProperties(prefix = "may")
在需要注⼊配置的类上加上这个注解,prefix的意思是,以该前缀打头的配置,以下是例⼦
@ConfigurationProperties(prefix = "may")
public class User {
private String name;
private String gender;
//省略setter,getter⽅法
}
may
name: youjie
gender: man
如果不⽤系统初始的l配置类,⽽是使⽤⾃⼰的如l,可以如下配置
@ConfigurationProperties(prefix = "may",locations = "l")
public class User2 {
private String name;
private String gender;
//省略setter,getter⽅法
}
过时:由于Spring-boot 1.5.2版本移除了,locations这个属性,因此上述这种⽅式在最新的版本中过时。
@PropertySource
Spring-boot 1.5.2版本之后,采⽤下⾯这种⽅式
@Component
//@PropertySource只能加载.properties⽂件,需要将上⾯的yml⽂件,改为.properties⽂件
@PropertySource("classpath:may.properties")
@ConfigurationProperties(prefix="may")
public class User2 {
private String name;
private String gender;
//省略setter,getter⽅法
}
@EnableConfigurationProperties
最后注意在spring Boot⼊⼝类加上@EnableConfigurationProperties
@SpringBootApplication
@EnableConfigurationProperties({User.class,User2.class})
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
其实这⾥@EnableConfigurationProperties({User.class,User2.class}) 可以省略
config.png
总结
SpringBoot 的⾃动配置得益于 SpringFramework 强⼤的⽀撑,框架早已有很多⼯具和注解可以⾃动装配 Bean 。SpringBoot 通过⼀个封装,将市⾯上通⽤的组件直接写好了配置类。当我们程序去依赖了这些组件的 jar 包后,启动 SpringBoot应⽤,于是⾃动加载开始了。
我们也可以定义⾃⼰的⾃动装配组件,依赖之后,Spring直接可以加载我们定义的 starter 。笔者将在后续⽂章中进⾏编码和解读。
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论