Spring 注解驱动开发_组件注册-@Conditional 注解

一、@Conditional 注解

@Conditional 注解:按照一定的条件进行判断,满足条件向容器中注册 bean

1.1 注解定义:

@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {

	// 必须满足所有的条件才能被注册到 IoC 容器中
	// value 属性值是一个继承自 Condition 接口的子类
	Class<? extends Condition>[] value();

}
  • @Conditional 注解中只有一个属性 value,该 value 值必须是实现了 Condition 接口的子类
  • 该接口可以配置在类上以及方法上

1.2 Condition 接口

再来看一下 Condition 接口:

@FunctionalInterface
public interface Condition {
	boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}

Condition 接口中只定义了一个 matches 方法,所有的配置在 @Conditional 注解上的类都需要实现该方法。该方法主要用于确定配置了该注解的类或方法是否可以注册到 IoC 容器中,确定条件即为 matches 方法,如果 matches 方法返回 true,表示条件匹配,可以注册到 IoC 容器。
matches 方法有两个参数:

  • context:条件上下文,是一个接口
  • metadata:被检查的类或方法的元数据,是一个接口

1.3 ConditionContext 接口:

public interface ConditionContext {

	// 如果条件匹配,则返回将保存 bean 定义的 BeanDefinitionRegistry。
	BeanDefinitionRegistry getRegistry();

	// 获取容器
	@Nullable
	ConfigurableListableBeanFactory getBeanFactory();

	// 获取当前应用的环境
	Environment getEnvironment();

	// 获取当前正在使用的资源加载器
	ResourceLoader getResourceLoader();

	@Nullable
	ClassLoader getClassLoader();

}

1.4 AnnotatedTypeMetadata 接口:

public interface AnnotatedTypeMetadata {

	// 获取当前类的所有的注解
	MergedAnnotations getAnnotations();

	// 判断当前类的所有的注解当中是否存在要查找的注释类型
	default boolean isAnnotated(String annotationName) {
		return getAnnotations().isPresent(annotationName);
	}

	// 根据注解名称获取注解属性
	@Nullable
	default Map<String, Object> getAnnotationAttributes(String annotationName) {
		return getAnnotationAttributes(annotationName, false);
	}

	// 获取所有的注解属性
	@Nullable
	default Map<String, Object> getAnnotationAttributes(String annotationName,
			boolean classValuesAsString) {

		MergedAnnotation<Annotation> annotation = getAnnotations().get(annotationName,
				null, MergedAnnotationSelectors.firstDirectlyDeclared());
		if (!annotation.isPresent()) {
			return null;
		}
		return annotation.asAnnotationAttributes(Adapt.values(classValuesAsString, true));
	}

	// 根据注解名称获取所有的注解属性
	@Nullable
	default MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationName) {
		return getAllAnnotationAttributes(annotationName, false);
	}

	// 获取所有的注解属性值
	@Nullable
	default MultiValueMap<String, Object> getAllAnnotationAttributes(
			String annotationName, boolean classValuesAsString) {

		Adapt[] adaptations = Adapt.values(classValuesAsString, true);
		return getAnnotations().stream(annotationName)
				.filter(MergedAnnotationPredicates.unique(MergedAnnotation::getMetaTypes))
				.map(MergedAnnotation::withNonMergedAttributes)
				.collect(MergedAnnotationCollectors.toMultiValueMap(map ->
						map.isEmpty() ? null : map, adaptations));
	}

}

二、@Conditional 注解配置在方法上

案例:如果系统是 Windows,则给容器中注册 Person 对象bill,如果系统是 Mac OS,则给容器中注册 Person 对象 jobs。

WindowConditon 类:

package org.example.condition;

import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;

public class WindowsCondition implements Condition {
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        // 获取 IoC 使用的 BeanFactory
        ConfigurableListableBeanFactory beanFactory = context.getBeanFactory();
        // 获取类加载器
        ClassLoader classLoader = context.getClassLoader();
        // 获取当前环境信息
        Environment environment = context.getEnvironment();
        // 获取 bean 定义的注册类
        BeanDefinitionRegistry registry = context.getRegistry();
		System.out.println("WindowsCondition................");
        String property = environment.getProperty("os.name");
        if(property.contains("Windows")){
            return true;
        }
        return false;
    }
}

MacCondition 类:

package org.example.condition;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;

public class MacCondition implements Condition {
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment environment = context.getEnvironment();
        System.out.println("MacCondition................");
        String property = environment.getProperty("os.name");
        if(property.contains("Mac")){
            return true;
        }
        return false;
    }
}

配置类:

package org.example.config;

import org.example.condition.MacCondition;
import org.example.condition.WindowsCondition;
import org.example.pojo.Person;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

@Configuration
@ComponentScan("org.example")
public class ConditionTestConfig {

    @Conditional(WindowsCondition.class)
    @Bean("bill")
    public Person person01(){
        return new Person("Bill Gates", "62");
    }

    @Conditional(MacCondition.class)
    @Bean("jobs")
    public Person person02(){
        return new Person("Steve Jobs", "66");
    }
}

测试方法:

@Test
public void testConditional(){
    ApplicationContext ac = new AnnotationConfigApplicationContext(ConditionTestConfig.class);
    Environment environment = ac.getEnvironment();
    String property = environment.getProperty("os.name");
    System.out.println(property);
    // 获取容器中所有 Person 类的定义
    String[] beanNamesForType = ac.getBeanNamesForType(Person.class);
    for (String s : beanNamesForType) {
        System.out.println(s);
    }
    Map<String, Person> beansOfType = ac.getBeansOfType(Person.class);
    System.out.println(beansOfType);
}

测试结果:
在这里插入图片描述
可以看出,Condition 接口的两个实现类其实都执行了,但是由于系统是 Mac OS,所以只有 MacCondition 中的 matches 方法返回了 true,从而只有 jobs 注入到容器中。

三、@Conditional 注解配置在类上

当 @Conditional 注解配置在类上时,只有当条件满足时,这个类中配置的所有 bean 才会被注册到容器中。

将注解 @Conditional(WindowsCondition.class) 配置到配置类上进行测试:

package org.example.config;

import org.example.condition.MacCondition;
import org.example.condition.WindowsCondition;
import org.example.pojo.Person;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

@Conditional(WindowsCondition.class)
@Configuration
@ComponentScan("org.example")
public class ConditionTestConfig {
 
    @Bean("bill")
    public Person person01(){
        return new Person("Bill Gates", "62");
    }

    @Bean("jobs")
    public Person person02(){
        return new Person("Steve Jobs", "66");
    }
}

测试方法同上,测试结果如下:
在这里插入图片描述

总结

  • @Conditional 注解可以按照一定的条件进行判断,满足条件则向容器中注册 bean,该注解可以配置在类上、方法上。当配置在类上时,只有当条件被满足时,当前类中的所有的 bean 才会被注册到容器中。
  • @Conditional 中的条件需要实现 Condition 接口,该接口中定义了唯一的方法 matches,在该方法中可以编写需要实现的条件,当条件结果返回true,说明条件被满足,可以被注册到容器中,返回false,则表示条件不满足,无法注册到容器中。
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
Java8新特性及实战视频教程完整版Java 8 API添加了一个新的抽象称为流Stream,可以让你以一种声明的方式处理数据。Stream 使用一种类似用 SQL 语句从数据库查询数据的直观方式来提供一种对 Java 集合运算和表达的高阶抽象。Stream API可以极大提高Java程序员的生产力,让程序员写出高效率、干净、简洁的代码。这种风格将要处理的元素集合看作一种流, 流在管道中传输, 并且可以在管道的节点上进行处理, 比如筛选, 排序,聚合等。元素流在管道中经过中间操作(intermediate operation)的处理,最后由最终操作(terminal operation)得到前面处理的结果。 Lambda 表达式,也可称为闭包,它是推动 Java 8 发布的最重要新特性。Lambda 允许把函数作为一个方法的参数(函数作为参数传递进方法中)。使用Lambda 表达式可以使代码变的更加简洁紧凑。Java8实战视频-01让方法参数具备行为能力Java8实战视频-02Lambda表达式初探Java8实战视频-03Lambda语法精讲Java8实战视频-04Lambda使用深入解析Java8实战视频-05Lambda方法推导详细解析-上.wmvJava8实战视频-06Lambda方法推导详细解析-下Java8实战视频-07Stream入门及Stream在JVM中的线程表现Java8实战视频-08Stream知识点总结Stream源码阅读Java8实战视频-09如何创建Stream上集Java8实战视频-10如何创建Stream下集.wmvJava8实战视频-11Stream之filter,distinct,skip,limit,map,flatmap详细介绍Java8实战视频-12Stream之Find,Match,Reduce详细介绍Java8实战视频-13NumericStream的详细介绍以及和Stream之间的相互转换Java8实战视频-14Stream综合练习,熟练掌握API的用法Java8实战视频-15在Optional出现之前经常遇到的空指针异常.wmvJava8实战视频-16Optional的介绍以及API的详解Java8实战视频-17Optional之flatMap,综合练习,Optional源码剖析Java8实战视频-18初识Collector体会Collector的强大Java8实战视频-19Collector使用方法深入详细介绍-01Java8实战视频-20Collector使用方法深入详细介绍-02Java8实战视频-21Collector使用方法深入详细介绍-03.wmvJava8实战视频-22Collector使用方法深入详细介绍-04Java8实战视频-23Collector原理讲解,JDK自带Collector源码深度剖析Java8实战视频-24自定义Collector,结合Stream的使用详细介绍Java8实战视频-25Parallel Stream编程体验,充分利用多核机器加快计算速度Java8实战视频-26Fork Join框架实例深入讲解Java8实战视频-27Spliterator接口源码剖析以及自定义Spliterator实现一个Stream.wmvJava8实战视频-28Default方法的介绍和简单的例子Java8实战视频-29Default方法解决多重继承冲突的三大原则详细介绍Java8实战视频-30多线程Future设计模式原理详细介绍,并且实现一个Future程序Java8实战视频-31JDK自带Future,Callable,ExecutorService介绍Java8实战视频-32实现一个异步基于事件回调的Future程序.wmvJava8实战视频-33CompletableFuture用法入门介绍Java8实战视频-34CompletableFuture之supplyAsync详细介绍Java8实战视频-35CompletableFuture流水线工作,join多个异步任务详细讲解Java8实战视频-36CompletableFuture常用API的重点详解-上Java8实战视频-37CompletableFuture常用API的重点详解-下Java8实战视频-38JDK老DateAPI存在的问题,新的DateAPI之LocalDate用法及其介绍.wmvJava8实战视频-39New Date API之LocalTime,LocalDateTime,Instant,Duration,Period详细介绍Java8实战视频-40New Date API之format和parse介绍

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值