Spring @Enable模块自定义

Spring @Enable模块自定义

Spring Framework 3.1 开始支持”@Enable 模块驱动“。比如常用@EnableWebMvc、@EnableAsync、@EnableAspectJAutoProxy等。实现自定义Enable模块方式有两种，注解方式、编程方式。本文将通过这两种方式来讲解怎么实现自定义Enable模块。

Spring框架@Enable 模块有哪些

@Enable 注解模块	激活模块
@EnableWebMvc	Web MVC 模块
@EnableTransactionManagement	事务管理模块
@EnableAsync	异步处理模块
@EnableCaching	Caching 模块
@EnableAspectJAutoProxy	AspectJ 代理模块
@EnableMBeanExport	JMX 模块

注解方式(通过@Configuration来驱动)

实现步骤

• 实现一个配置类MyEnableConfiguration
• 自定义@Enable注解，并导入配置类MyEnableConfiguration

demo

• MyEnableConfiguration

public class MyConfig {
    private String jdkVersion = "V1.0";

    @Override
    public String toString() {
        return "MyConfig{" +
                "jdkVersion='" + jdkVersion + '\'' +
                '}';
    }

    public String getJdkVersion() {
        return jdkVersion;
    }

    public void setJdkVersion(String jdkVersion) {
        this.jdkVersion = jdkVersion;
    }
}

@Configuration(proxyBeanMethods = false)
public class MyEnableConfiguration {
    @Bean
    public MyConfig myConfig() {
        return new MyConfig();
    }
}

• EnableMyConfig 注解

@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import(MyEnableConfiguration.class)
public @interface EnableMyConfig {
}

• 运行

@EnableMyConfig
public class EnableApplicationDemo {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.register(EnableApplicationDemo.class);
        context.refresh();
        MyConfig myConfig = context.getBean(MyConfig.class);
        System.out.println(myConfig);
    }
}

官方参考案例:@EnableWebMvc

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE})
@Documented
@Import({DelegatingWebMvcConfiguration.class})
public @interface EnableWebMvc {
}


@Configuration(
    proxyBeanMethods = false
)
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
    .............
}

编程方式

实现步骤

• 实现一个实现ImportSelector或者ImportBeanDefinitionRegistrar类
• 自定义@Enable注解，并导入

demo

• MyConfigImport

public class MyConfigImport implements ImportSelector {
    @Override
    public String[] selectImports(AnnotationMetadata importingClassMetadata) {
        return new String[]{"com.github.bearboy80.spring.enable.MyConfig"};
    }
}

public class MyConfig {
    private String jdkVersion = "V1.0";

    @Override
    public String toString() {
        return "MyConfig{" +
                "jdkVersion='" + jdkVersion + '\'' +
                '}';
    }

    public String getJdkVersion() {
        return jdkVersion;
    }

    public void setJdkVersion(String jdkVersion) {
        this.jdkVersion = jdkVersion;
    }
}

• EnableMyConfig 注解

@Documented
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Import(MyConfigImport.class)
@Import(MyEnableConfiguration.class)
public @interface EnableMyConfig {
}

• 运行

@EnableMyConfig
public class EnableApplicationDemo {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();
        context.register(EnableApplicationDemo.class);
        context.refresh();
        MyConfig myConfig = context.getBean(MyConfig.class);
        System.out.println(myConfig);
    }
}

总结

本文只是简单的介绍通过注解或者编程方式实现一个简单的@Enable模块。