Spring Enable* 注解

Spring提供了一系列以Enable開頭的注解，這些注解本質上是激活Spring的某些管理功能。比如，EnableWebMvc。 這個注解引入了MVC框架在Spring 應用中需要用到的所有bean。另外一個注解式EnableAsync, 它讓Bean在spring 應用中支持異步功能。

我很好奇這些注解是怎樣工作的，並把我的理解寫下來。這些注解的工作原理可以理解為SPI的一部分，如果將來實現有變化可以切換。

 

簡單的Enable*注解

我們可以把這些簡單的注解理解為為spring 上下文引入一組bean。 我們開始來定義一些這樣的注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@interface EnableSomeBeans {}

並把這個注解應用到spring 配置類上：

@Configuration
@EnableSomeBeans
public static class SpringConfig {}

如果希望引入一組新的bean, 只需要簡單的使用@Import注解，如下：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SomeBeanConfiguration.class)
@interface EnableSomeBeans {}

如果被引入的@Configuration定義了Bean， 那么這么bean就會被引入到spring 上下文。

@Configuration
class SomeBeanConfiguration {
 
    @Bean
    public String aBean1() {
        return "aBean1";
    }
 
    @Bean
    public String aBean2() {
        return "aBean2";
    }
}

完整代碼可以從這里下載：https://gist.github.com/bijukunjummen/847456b55ae2340fff65

 

帶Selector的Enable注解

 當然，Enable注解可以更加復雜，可以根據所在上下文來激活不同類型的bean。比如：EnableCaching，可以根據類路徑上的不同實現來激活對應的緩存。

 這樣的注解比前面的例子復雜些：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Import(SomeBeanConfigurationSelector.class)
public @interface EnableSomeBeansSelector {
    String criteria() default "default";
}

 

上面的注解有一個叫criteria的屬性，我想根據這個屬性來激活不同的bean。這可以通過定義一個@Configuration Selector返回不同的@Configuration來實現。樣板代碼如下：

mport org.springframework.context.annotation.ImportSelector;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;
 
public class SomeBeanConfigurationSelector implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        AnnotationAttributes attributes =
                AnnotationAttributes.fromMap(
                        importingClassMetadata.getAnnotationAttributes(EnableSomeBeansSelector.class.getName(), false));
        String criteria = attributes.getString("criteria");
        if (criteria.equals("default")) {
            return new String[]{"enableannot.selector.SomeBeanConfigurationDefault"};
        }else {
            return new String[]{"enableannot.selector.SomeBeanConfigurationType1"};
        }
    }
}
 
@Configuration
class SomeBeanConfigurationType1 {
 
    @Bean
    public String aBean() {
        return "Type1";
    }
 
}
 
@Configuration
class SomeBeanConfigurationDefault {
 
    @Bean
    public String aBean() {
        return "Default";
    }
 
}

所以，如果criteria是detaul, SomeBeanConfigurationDefault被加入，反之，加入SomeBeanConfigurationType1。

原文地址：http://www.java-allandsundry.com/2015/04/spring-enable-annotation-writing-custom.html