Spring Boot 自动配置之条件注解浅析
SpringBoot神奇的自动配置，主要依靠大量的条件注解来使用配置自动化。
根据满足某一个特定条件创建一个特定的Bean。比如说，在某些系统变量下创建Bean，或者只有在某个Bean创建后才去创建另外一个Bean.就是根据条件来控制Bean的创建行为，可以利用该特性来进行一些自动配置。
一、常用的条件注解
- @Conditional依赖的条件
- @ConditionalOnBean 在某个Bean存在的条件下
- @ConditionalOnMissingBean在某个Bean不存在的条件下
- @ConditionalOnClass 在某个Class存在的条件下
- @ConditionalOnMissingClass 在某个Class不存在的条件下
比较常见的是这些注解，还有其它的比如@ConditionalOnWebApplication,@ConditionalOnProperty等，可举一反三
二、特别说明@Conditional注解
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceConditional{
/**
*All{@linkConditionConditions}thatmust{@linkplainCondition#matchesmatch}
*inorderforthecomponenttoberegistered.
*/
Class[]value();
}
使用@Conditional注解，对象需要实现Condition接口，Condition接口是一个函数式接口
@FunctionalInterface
publicinterfaceCondition{
booleanmatches(ConditionContextcontext,AnnotatedTypeMetadatametadata);
}
三、条件注解示例
示例场景：项目中动态的配置Mysql或者Oracle数据源
1.定义配置文件
db-type=oracle
2.定义Condition类
MySqlCondition.java
publicclassMySqlConditionimplementsCondition{
@Override
publicbooleanmatches(ConditionContextcontext,AnnotatedTypeMetadatametadata){
return"mysql".equals(context.getEnvironment().getProperty("db-type"));
}
}
OracleCondition.java
publicclassOracleConditionimplementsCondition{
@Override
publicbooleanmatches(ConditionContextcontext,AnnotatedTypeMetadatametadata){
return"oracle".equals(context.getEnvironment().getProperty("db-type"));
}
}
获取配置文件db-type的值
3.JdbcFactory接口
publicinterfaceJdbcFactory{
voidcreate();
}
4.默认的Mysql和Oracle实现
Mysql
@ConditionalOnMissingBean(value=JdbcFactory.class,ignored=MySqlDefaultFactory.class)
@Conditional(MySqlCondition.class)
@Component
publicclassMySqlDefaultFactoryimplementsJdbcFactory{
@Override
publicvoidcreate(){
System.out.println("DefaultMySqlcreate..");
}
}
Oracle
@ConditionalOnMissingBean(value=JdbcFactory.class,ignored=OracleDefaultFactory.class)
@Conditional(OracleCondition.class)
@Component
publicclassOracleDefaultFactoryimplementsJdbcFactory{
@Override
publicvoidcreate(){
System.out.println("Defaultoraclecreate..");
}
}
5.测试默认实现方式
@Resource
privateJdbcFactoryjdbcFactory;
@Test
publicvoidconditionOnMissBean(){
jdbcFactory.create();
}
结果：DefaultMySqlcreate..
6.自定义实现方式
@Component
publicclassMysqlFactoryimplementsJdbcFactory{
@Override
publicvoidcreate(){
System.out.println("mysql。。create");
}
}
7.测试
@Resource
privateJdbcFactoryjdbcFactory;
@Test
publicvoidconditionOnMissBean(){
jdbcFactory.create();
}
结果：mysql。。create
8.解析
当环境中不存在JdbcFactory的Bean时则使用默认的实现的方式，如例：没有自定义实现时，则默认使用MySqlDefaultFactory。这在自动化配置中会经常用到。比如redisTemplate的默认实现
四、GitHub源码
源码地址
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。