Spring注解@Conditional案例解析
【1】@Conditional介绍
@Conditional是Spring4新提供的注解，它的作用是按照一定的条件进行判断，满足条件给容器注册bean。
@Conditional源码：
//此注解可以标注在类和方法上
@Target({ElementType.TYPE,ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public@interfaceConditional{
Class[]value();
}
从代码中可以看到，需要传入一个Class数组，并且需要继承Condition接口：
publicinterfaceCondition{
booleanmatches(ConditionContextvar1,AnnotatedTypeMetadatavar2);
}
Condition是个接口，需要实现matches方法，返回true则注入bean，false则不注入。
【2】@Conditional示例
首先，创建Person类：
publicclassPerson{
privateStringname;
privateIntegerage;
publicStringgetName(){
returnname;
}
publicvoidsetName(Stringname){
this.name=name;
}
publicIntegergetAge(){
returnage;
}
publicvoidsetAge(Integerage){
this.age=age;
}
publicPerson(Stringname,Integerage){
this.name=name;
this.age=age;
}
@Override
publicStringtoString(){
return"Person{"+"name='"+name+'\''+",age="+age+'}';
}
}
创建MyConfig类，用于配置两个Person实例并注入，一个是BillGates，一个是linus。
@Configuration
publicclassMyConfig{
@Bean(name="bill")
publicPersonperson1(){
returnnewPerson("BillGates",62);
}
@Bean("linus")
publicPersonperson2(){
returnnewPerson("Linus",48);
}
}
写一个测试类，测试是否注入成功
publicclassConditionalTest{
AnnotationConfigApplicationContextapplicationContext=newAnnotationConfigApplicationContext(BeanConfig.class);
@Test
publicvoidtest1(){
Mapmap=applicationContext.getBeansOfType(Person.class);
System.out.println(map);
}
}
/**测试结果
{bill=Person{name='BillGates',age=62},linus=Person{name='Linus',age='48'}}
*/
这是一个简单的例子，现在问题来了，如果我想根据当前操作系统来注入Person实例，windows下注入bill，linux下注入linus，怎么实现呢？
这就需要我们用到@Conditional注解了，前言中提到，需要实现Condition接口，并重写方法来自定义match规则。
首先，创建一个WindowsCondition类：
publicclassWindowsConditionimplementsCondition{
/**
*@paramconditionContext:判断条件能使用的上下文环境
*@paramannotatedTypeMetadata:注解所在位置的注释信息
**/
@Override
publicbooleanmatches(ConditionContextconditionContext,AnnotatedTypeMetadataannotatedTypeMetadata){
//获取ioc使用的beanFactory
ConfigurableListableBeanFactorybeanFactory=conditionContext.getBeanFactory();
//获取类加载器
ClassLoaderclassLoader=conditionContext.getClassLoader();
//获取当前环境信息
Environmentenvironment=conditionContext.getEnvironment();
//获取bean定义的注册类
BeanDefinitionRegistryregistry=conditionContext.getRegistry();
//获得当前系统名
Stringproperty=environment.getProperty("os.name");
//包含Windows则说明是windows系统，返回true
if(property.contains("Windows")){
returntrue;
}
returnfalse;
}
}
接着，创建LinuxCondition类：
publicclassLinuxConditionimplementsCondition{
@Override
publicbooleanmatches(ConditionContextconditionContext,AnnotatedTypeMetadataannotatedTypeMetadata){
Environmentenvironment=conditionContext.getEnvironment();
Stringproperty=environment.getProperty("os.name");
if(property.contains("Linux")){
returntrue;
}
returnfalse;
}
}
修改MyConfig：
@Configuration
publicclassMyConfig{
//只有一个类时，大括号可以省略
//如果WindowsCondition的实现方法返回true，则注入这个bean
@Conditional({WindowsCondition.class})
@Bean(name="bill")
publicPersonperson1(){
returnnewPerson("BillGates",62);
}
//如果LinuxCondition的实现方法返回true，则注入这个bean
@Conditional({LinuxCondition.class})
@Bean("linus")
publicPersonperson2(){
returnnewPerson("Linus",48);
}
}
标注在方法上：
修改测试程序，开始测试：
publicclassConditionalTest{
AnnotationConfigApplicationContextapplicationContext=newAnnotationConfigApplicationContext(BeanConfig.class);
@Test
publicvoidtest1(){
StringosName=applicationContext.getEnvironment().getProperty("os.name");
System.out.println("当前系统为："+osName)；
Mapmap=applicationContext.getBeansOfType(Person.class);
System.out.println(map);
}
}
/**测试结果
当前系统为：Windows10
{bill=Person{name='BillGates',age=62}}
*/
一个方法只能注入一个bean实例，所以@Conditional标注在方法上只能控制一个bean实例是否注入
标注在类上:
@Configuration
@Conditional({WindowsCondition.class})
publicclassMyConfig{
//只有一个类时，大括号可以省略
//如果WindowsCondition的实现方法返回true，则注入这个bean
@Bean(name="bill")
publicPersonperson1(){
returnnewPerson("BillGates",62);
}
//如果LinuxCondition的实现方法返回true，则注入这个bean
@Bean("linus")
publicPersonperson2(){
returnnewPerson("Linus",48);
}
}
一个类中可以注入很多实例，@Conditional标注在类上就决定了一批bean是否注入。
以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持毛票票。
声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。