Springboot学习之@Conditional注解

Spring4提供了一个通用的基于特定条件创建Bean的方式：@Conditional注解。条件注解是根据特定的条件来选择Bean对象的创建。如果你想一个或多个Bean只有在应用的路径下包含特定的库时才创建，那么使用这个注解定义条件化的Bean就再适合不过了。

使用示例：

1、在Springboot工程的application.yml文件中添加配置内容：

magicCondition: true

 2、创建MagicCondition类，实现org.springframework.context.annotation.Condition接口，重新实现父类的matches方法：

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 MagicCondition implements Condition {

    /**
     * 实现matches方法，如果返回true就创建该Bean，如果返回false则不创建该Bean。
     * @param context
     * @param metadata
     * @return
     */
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment env = context.getEnvironment();
        if(env.containsProperty("magicCondition")){ // 检查application.xml配置文件中是否存在magicCondition属性key
            String magicCondition = env.getProperty("magicCondition");// 获取属性的值
            return "true".equals(magicCodition); // 返回属性的值是否为true
        }
        return false; // 返回false
    }
}

 3、写demo用的service

public interface MagicService {

    String getInfo();
}

 

import com.wltjack.service.MagicService;

public class MagicServiceImpl implements MagicService {
    @Override
    public String getInfo() {
        return "MagicServiceImpl >>> getInfo() run...";
    }
}

 4、创建MagicConditionConfig配置类

import com.wltjack.common.MagicCondition;
import com.wltjack.service.impl.MagicServiceImpl;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

/**
 * MagicConditionConfig配置类，当Spring容器中存在MagicCondition Bean对象，并满足MagicCondition类的条件时，才去实例化magicService这个Bean。
 */
@Configuration
@ComponentScan(basePackages = {"com.wltjack"})
public class MagicConditionConfig {

    @Bean
    @Conditional(MagicCondition.class) // 指定条件类
    public MagicServiceImpl magicService(){
        return new MagicServiceImpl();
    }

}

 @Conditional(MagicCondition.class) ：指定条件类MagicCondition，当其matches方法返回true时才执行magicService方法实例化Bean。

5、创建MagicConditionController类，提供url访问入口：

import com.wltjack.common.SpringContextUtils;
import com.wltjack.service.MagicService;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/magic/condition")
public class MagicConditionController {

    @GetMapping("/info")
    public String info(){
        try {
            MagicService ms = (MagicService) SpringContextUtils.getApplicationContext().getBean("magicService"); // 从Spring容器中获取magicService bean
            return ms.getInfo();
        }catch (Exception e){
            e.printStackTrace();
        }
        return "null";
    }
}

 其中，SpringContextUtils类提供了应用上下文的注入与获取，代码如下：

import org.springframework.beans.BeansException;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationContextAware;
import org.springframework.stereotype.Component;

@Component
public class SpringContextUtils implements ApplicationContextAware {

    private static ApplicationContext applicationContext;

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        if(SpringContextUtils.applicationContext == null){
            SpringContextUtils.applicationContext  = applicationContext;
        }
        System.out.println("========ApplicationContext配置成功,在普通类可以通过调用SpringContextUtils.getApplicationContext()获取applicationContext对象,applicationContext="+SpringContextUtils.applicationContext+"========");
    }

    public static ApplicationContext getApplicationContext() {
        return applicationContext;
    }
}

代码写完后，开始测试：

首先，将application.yml配置文件中的magicCondition值为true，启动应用，访问url：

http://127.0.0.1:8080/learn/magic/condition/info

可以看页面输出信息：

 然后，将application.yml配置文件中的magicCondition值为false，重启应用，访问url：

http://127.0.0.1:8080/learn/magic/condition/info

可以看页面输出信息：

 页面上已经不能输出serviceImpl方法中返回的文本，看到控制台已经出现如下错误信息：

 

 从错误提示中，我们可以看到magicService并没有实例化到Spring容器中。

最后，我们打开org.springframework.context.annotation.Condition类的类层次结构图，可以看到实现该接口的类：

 其中，SpringBootCondition类为Spring Boot中使用的所有条件实现的基础。