Spring高級裝配之條件化創(chuàng)建Bean

上節(jié)介紹了profile機制條件化創(chuàng)建Bean的具體步驟,假如你想一個或多個Bean只有在應用的路徑下包含特定的庫時才創(chuàng)建,那么使用這節(jié)我們所要介紹的Spring 4和@Conditional注解定義條件化的Bean就再適合不過了。
  要實現(xiàn)這種級別的條件化配置是挺不容易的,但是強大的Spring 4為我們提供了@Conditional注解,下面我們就介紹一下具體怎樣使用@Conditional實現(xiàn)條件化配置Bean。
  下面我們就根據(jù)環(huán)境變量中有沒有magic變量來決定是否創(chuàng)建MagicBean:

package com.cache.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

import com.cache.conditional.MagicExistsConditional;
import com.cache.service.MagicBean;
/**
 * <dl>
 * <dd>Description:study @Conditional</dd>
 * <dd>Company: 黑科技</dd>
 * <dd>@date:2016年8月23日 下午7:55:37</dd>
 * <dd>@author:Kong</dd>
 * </dl>
 */
@Configuration
public class ConditionalConfig {
    @Bean
    @Conditional(MagicExistsConditional.class) //條件化的創(chuàng)建bean
    public MagicBean magicBean() {
        return new MagicBean();
    }
}

可以看到MagicBean是否創(chuàng)建取決于@Conditional(MagicExistsConditional.class)中的情況,那么給@Conditional中的參數(shù)又是什么類型的呢,請看:

package com.cache.conditional;

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.env.Environment;
import org.springframework.core.type.AnnotatedTypeMetadata;
/**
 * <dl>
 * <dd>Description:是否創(chuàng)建Bean的條件類</dd>
 * <dd>Company: 黑科技</dd>
 * <dd>@date:2016年8月23日 下午7:59:15</dd>
 * <dd>@author:Kong</dd>
 * </dl>
 */
public class MagicExistsConditional implements Condition{
    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        Environment evn = context.getEnvironment();
        
        return evn.containsProperty("magic");
    }

}

如你所見,設置給@Conditional的類可以是任意實現(xiàn)了Condition接口的的類型。而實現(xiàn)這個接口只需要實現(xiàn)matches方法,如果matches方法返回true就創(chuàng)建該bean,如果返回false則不創(chuàng)建bean,上例中我們就是根據(jù)環(huán)境變量中是否存在magic變量,來決定matches的返回值,進而決定是否創(chuàng)建MagicBean的。
上例中我們只是使用到了ConditionContext的到Environment,但Condition實現(xiàn)的考量因素可能會比這多的多。maches()方法會得到ConditionContextAnnotatedTypeMetadata對象用來做決策。
其實ConditionContext是一個接口:

package org.springframework.context.annotation;

import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.core.env.Environment;
import org.springframework.core.io.ResourceLoader;

/**
 * Context information for use by {@link Condition}s.
 *
 * @author Phillip Webb
 * @since 4.0
 */
public interface ConditionContext {

    BeanDefinitionRegistry getRegistry();

    ConfigurableListableBeanFactory getBeanFactory();

    Environment getEnvironment();

    ResourceLoader getResourceLoader();

    ClassLoader getClassLoader();

}

通過ConditionContext,我們可以做到如下幾點:

方法 作用
getRegistry() 借助返回的BeanDefinitionRegistry檢查bean的定義
getBeanFactory() 借助返回的ConfigrableListableBeanFactory檢查是否存在,甚至檢查bean的屬性
getEnvironment() 借助返回Environment檢查環(huán)境變量是否存在以及讀取它的值是什么
getResourceLoader() 讀取并檢查它返回的ResourceLoader所加載的資源
getClassLoader() 借助它的返回的ClassLoader加載并檢查類是否存在

AnnotatedTypeMetadata則能夠讓我們檢查帶有@Bean注解的方法上是否有其他注解:

package org.springframework.core.type;

import java.util.Map;

import org.springframework.util.MultiValueMap;

/**
 * Defines access to the annotations of a specific type ({@link AnnotationMetadata class}
 * or {@link MethodMetadata method}), in a form that does not necessarily require the
 * class-loading.
 *
 * @author Juergen Hoeller
 * @author Mark Fisher
 * @author Mark Pollack
 * @author Chris Beams
 * @author Phillip Webb
 * @since 4.0
 * @see AnnotationMetadata
 * @see MethodMetadata
 */
public interface AnnotatedTypeMetadata {

    boolean isAnnotated(String annotationType);

    Map<String, Object> getAnnotationAttributes(String annotationType);

    Map<String, Object> getAnnotationAttributes(String annotationType, boolean classValuesAsString);

    MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationType);

    MultiValueMap<String, Object> getAllAnnotationAttributes(String annotationType, boolean classValuesAsString);

}

借助isAnnotated()方法,我們能夠判斷帶有@Bean注解的方法是不是還有其他特定的注解。借助其他的方法,我們能夠檢查@Bean注解的方法上其他注解的屬性。
下面我們來看一下Spring 4使用@Conditional對@Profile的重構:

package org.springframework.context.annotation;

import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.core.env.AbstractEnvironment;
import org.springframework.core.env.ConfigurableEnvironment;

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

    /**
     * The set of profiles for which the annotated component should be registered.
     */
    String[] value();

}

@Profile的實現(xiàn)定義使用了,@Conditional注解和Condition接口,如下,ProfileCondition實現(xiàn)了Condition,并在matches方法中做出了是否創(chuàng)建@Profile的決策:


package org.springframework.context.annotation;

import org.springframework.core.type.AnnotatedTypeMetadata;
import org.springframework.util.MultiValueMap;

/**
 * {@link Condition} that matches based on the value of a {@link Profile @Profile}
 * annotation.
 *
 * @author Chris Beams
 * @author Phillip Webb
 * @author Juergen Hoeller
 * @since 4.0
 */
class ProfileCondition implements Condition {

    @Override
    public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
        if (context.getEnvironment() != null) {
            MultiValueMap<String, Object> attrs = metadata.getAllAnnotationAttributes(Profile.class.getName());
            if (attrs != null) {
                for (Object value : attrs.get("value")) {
                    if (context.getEnvironment().acceptsProfiles(((String[]) value))) {
                        return true;
                    }
                }
                return false;
            }
        }
        return true;
    }

}

我們可以看到,ProfileCondition通過AnnotatedTypeMetadata得到了用于@Profile注解的所有屬性。借助該信息,他會明確地檢查value屬性,該屬性包含了bean的profile名稱。然后根據(jù)ConditionContext得到的Environment來檢查【借助acceptsProfiles()方法】該profile是否處于激活狀態(tài)。

待續(xù),,,,

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
【社區(qū)內容提示】社區(qū)部分內容疑似由AI輔助生成,瀏覽時請結合常識與多方信息審慎甄別。
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發(fā)布,文章內容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務。

相關閱讀更多精彩內容

  • Spring Cloud為開發(fā)人員提供了快速構建分布式系統(tǒng)中一些常見模式的工具(例如配置管理,服務發(fā)現(xiàn),斷路器,智...
    卡卡羅2017閱讀 136,534評論 19 139
  • 一、環(huán)境與profile 在開發(fā)軟件的時候,有一個很大的挑戰(zhàn)就是將應用程序從一個環(huán)境遷移到另一個環(huán)境,因為開發(fā)階段...
    yjaal閱讀 301評論 0 0
  • Spring Boot 參考指南 介紹 轉載自:https://www.gitbook.com/book/qbgb...
    毛宇鵬閱讀 47,261評論 6 342
  • 3.1 環(huán)境與profile 3.1.1 配置profile bean 要使用profile,你首先要將所有不同的...
    如一諾然閱讀 431評論 0 0
  • 今天,是個特別的日子。 一大早我還夢中, 就聽到朋友打電話來 。我兩相隔南北 , 突然看到她的名字有點突然...
    林靜姝閱讀 232評論 0 2

友情鏈接更多精彩內容