spring boot 神奇的自动配置,主要依靠大量的条件注解来使用配置自动化。
根据满足某一个特定条件创建一个特定的bean。比如说,在某些系统变量下创建bean,或者只有在某个bean创建后才去创建另外一个bean. 就是根据条件来控制bean的创建行为,可以利用该特性来进行一些自动配置。
一、常用的条件注解
- @conditional 依赖的条件
- @conditionalonbean 在某个bean存在的条件下
- @conditionalonmissingbean 在某个bean不存在的条件下
- @conditionalonclass 在某个class存在的条件下
- @conditionalonmissingclass 在某个class不存在的条件下
比较常见的是这些注解,还有其它的比如 @conditionalonwebapplication,@conditionalonproperty 等,可举一反三
二、特别说明 @conditional 注解
1
2
3
4
5
6
7
8
9
10
11
12
|
@target ({elementtype.type, elementtype.method}) @retention (retentionpolicy.runtime) @documented public @interface conditional { /** * all {@link condition conditions} that must {@linkplain condition#matches match} * in order for the component to be registered. */ class <? extends condition>[] value(); } |
使用@conditional注解,对象需要实现condition接口,condition 接口是一个函数式接口
1
2
3
4
5
|
@functionalinterface public interface condition { boolean matches(conditioncontext context, annotatedtypemetadata metadata); } |
三、条件注解示例
示例场景:项目中动态的配置mysql或者oracle数据源
1. 定义配置文件
1
|
db-type=oracle |
2. 定义condition类
mysqlcondition.java
1
2
3
4
5
6
7
|
public class mysqlcondition implements condition { @override public boolean matches(conditioncontext context, annotatedtypemetadata metadata) { return "mysql" .equals(context.getenvironment().getproperty( "db-type" )); } } |
oraclecondition.java
1
2
3
4
5
6
7
|
public class oraclecondition implements condition { @override public boolean matches(conditioncontext context, annotatedtypemetadata metadata) { return "oracle" .equals(context.getenvironment().getproperty( "db-type" )); } } |
获取配置文件db-type的值
3. jdbcfactory接口
1
2
3
4
|
public interface jdbcfactory { void create(); } |
4. 默认的mysql和oracle实现
mysql
1
2
3
4
5
6
7
8
9
10
11
|
@conditionalonmissingbean (value = jdbcfactory. class , ignored = mysqldefaultfactory. class ) @conditional (mysqlcondition. class ) @component public class mysqldefaultfactory implements jdbcfactory { @override public void create() { system.out.println( "default mysql create .." ); } } |
oracle
1
2
3
4
5
6
7
8
9
10
|
@conditionalonmissingbean (value = jdbcfactory. class , ignored = oracledefaultfactory. class ) @conditional (oraclecondition. class ) @component public class oracledefaultfactory implements jdbcfactory { @override public void create() { system.out.println( "default oracle create.." ); } } |
5. 测试默认实现方式
1
2
3
4
5
6
7
|
@resource private jdbcfactory jdbcfactory; @test public void conditiononmissbean() { jdbcfactory.create(); } |
结果:default mysql create ..
6. 自定义实现方式
1
2
3
4
5
6
7
8
|
@component public class mysqlfactory implements jdbcfactory { @override public void create() { system.out.println( "mysql 。。 create" ); } } |
7. 测试
1
2
3
4
5
6
7
|
@resource private jdbcfactory jdbcfactory; @test public void conditiononmissbean() { jdbcfactory.create(); } |
结果:mysql 。。 create
8.解析
当环境中不存在 jdbcfactory 的bean时则使用默认的实现的方式,如例:没有自定义实现时,则默认使用mysqldefaultfactory。这在自动化配置中会经常用到。比如redistemplate 的默认实现
四、github源码
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持服务器之家。
原文链接:https://juejin.im/post/5c6c2189e51d45713911466d