SpringBoot中@Conditional注解的使用
作者：Splaying
这篇文章主要介绍了SpringBoot中@Conditional注解的使用,@Conditional注解是一个条件装配注解,主要用于限制@Bean注解在什么时候才生效,以指定的条件形式控制bean的创建,需要的朋友可以参考下
1、基本介绍
- @Conditional注解是一个条件装配注解，主要用于限制@Bean注解在什么时候才生效。以指定的条件形式控制bean的创建
- @Conditional可以自定义条件进行装配或者不装配…
- @Conditional本身还是一个父注解，派生出大量的子注解；可以按需加载！
- 因此在学习SpringBoot的时候是非常有必要学习这个注解的使用的，SpringBoot就是按需加载。
- Conditional注解和所有子注解首先必须依托@Configuration配置类注解
- 都可以加载类或者方法上；加载类上的含义所有的方法都按照这个条件装配、加载方法上只有该方法进行条件装配。
- 注：Conditional注解是Spring4.0就有的，旗下的子注解是SpringBoot1.0有的。
2、@Conditional注解
使用Conditional注解进行条件装配时需要自定义类实现Condition接口（spring包下的，不是JUC包下）
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
// 自定义类实现Condition接口，完成给出指定的条件。
Class<? extends Condition>[] value();
}2.1、自定义条件
如果存在dog1则不会对条件装配bean进行创建。
public class MyCondition implements Condition {
/**
* @param context: 判断条件使用的上下文环境
* @param metadata: 扫描的注解信息
*/
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// 1. 获取bean工厂
ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
// 2. 获取运行环境, 可以根据操作系统的环境进行限制bean
Environment environment = context.getEnvironment();
// 3. 获取BeanDefinition注册定义表
context.getRegistry();
// 4. 获取资源加载器
context.getResourceLoader();
// 5. 获取类加载器
ClassLoader classLoader = context.getClassLoader();
if (beanFactory.containsBean("dog1")) {
return false;
}
/**
* 可以根据以上条件进行条件装配
* true: 装配
* false： 不装配
*/
return true;
}
}2.2、条件装配测试
@Configuration
public class MyConfig {
@Bean("user1")
public User user1(){
return new User("splay", 22, "男");
}
@Bean("dog1")
//@ConditionalOnBean(name = {"dog2"})
public Dog dog1(){
return new Dog("金毛", 4,"公");
}
@Bean("dog2")
@Conditional(value = MyCondition.class)
public Dog dog2(){
return new Dog("拉布拉多", 3,"母");
}
}在dog2上加上条件装配，当扫描到这个bean时会进行条件判断。
3、@ConditionalOnBean子注解
子注解其实也是Conditional注解的特定装配，只不过条件类已经实现好了。
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class) //OnBeanCondition是一个Condition接口的实现类
public @interface ConditionalOnBean {
// 1. 按照bean的类型进行检查
Class<?>[] value() default {};
// 2. 按照bean的类型进行检查
String[] type() default {};
// 3. 按照bean的注解进行检查
Class<? extends Annotation>[] annotation() default {};
// 4. 按照BeanName进行检查
String[] name() default {};
// 5. 搜索策略
SearchStrategy search() default SearchStrategy.ALL;
// 6. 不详
Class<?>[] parameterizedContainer() default {};
}
3.1、条件装配测试（一）
当容器中存在dog1的时候在创建dog2，否则就不会进行创建。
@Configuration
public class MyConfig {
@Bean("user1")
public User user1(){
return new User("splay", 22, "男");
}
@Bean("dog1")
public Dog dog1(){
return new Dog("金毛", 4,"公");
}
@Bean("dog2")
@ConditionalOnBean(name = {"dog1"})
public Dog dog2(){
return new Dog("拉布拉多", 3,"母");
}
}
3.2、条件装配测试（二）
在使用时发现条件装配与bean的编写注册顺序有关系，如果先后顺序导致将会出现失败的情况。
@Configuration
public class MyConfig {
@Bean("user1")
public User user1(){
return new User("splay", 22, "男");
}
@Bean("dog1")
@ConditionalOnBean(name = {"dog2"}) //当有dog2组件的时候创建dog1
public Dog dog1(){
return new Dog("金毛", 4,"公");
}
@Bean("dog2")
public Dog dog2(){
return new Dog("拉布拉多", 3,"母");
}
}
对比上面测试一发现dog1并没有成功创建，猜测创建的时候估计是按照某种顺序进行的！
因此在使用条件装配进行创建的时候一定要注意呗依赖的条件是否要先创建的问题！
到此这篇关于SpringBoot 中@Conditional注解的使用的文章就介绍到这了,更多相关@Conditional注解使用内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！