当前位置：首页 > news >正文

SpringBoot系列-- @Enable 模块驱动

news 2025/8/19 4:10:38

@Enable 模块驱动

@Enable 模块驱动是以 @Enable 为前缀的注解驱动编程模型。所谓 “模块” 是指具备相同领域的功能组件集合，组合所形成一个独立的单元。比如 WebMVC 模块、AspectJ 代理模块、Caching （缓存）模块、JMX （Java 管理扩展）模块、Async （异步处理）模块等。

举例说明
@EnableWebMvc
@EnableTransactionManagement
@EnableCaching
@EnableMBeanExport
@EnableAsync
@Enable 模块驱动编程模式

定义驱动注解：@EnableXXX
导入注解：@lmport 具体实现

实现方式两类

1. 基于注解方式实现

基于 Configuration Class类。在Enable 注解配置类中引入@Import 注解，导入配置类@Configuration 配置，实现配置类bean的初始化

实现举例

实现配置Configration 配置类

@Configuration
public class HelloWorldConfigration {<!-- -->@Beanpublic String helloWorld() {<!-- -->return "Hello,World";}
}

自定义启动注解

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(HelloWorldConfigration.class)
public @interface EnableHelloWorld {<!-- -->
}

在启动类中启用使用模块

@EnableHelloWorld
@Configuration
public class EnableHelloworldBootstrap {<!-- -->public static void main(String[] args) {<!-- -->AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext();context.register(EnableHelloworldBootstrap.class);context.refresh();String helloworld = context.getBean("helloWorld", String.class);System.out.println("-------"+helloworld);context.close();}
}

2. 基于接口

分别获取注解信息，根据注解获取接入类型，根据接入类型选择不同的接入类型

举例
Access为接入类型的接口，下文的RPC接入和REST接入基于这个实现，定义两个接口，一个为启动，一个停止，内部嵌套一个枚举用于标识是哪一种接入

public interface Access {/*** 初始化配置*/void start();/*** 销毁配置*/void stop();enum Type{REST,RPC}
}

定义RPC和REST的实现

public class RestAccess implements Access{@Overridepublic void start() {System.out.println("rest接入配置");}@Overridepublic void stop() {System.out.println("rest接入销毁配置");}
}

public class RpcAccess implements Access{@Overridepublic void start() {System.out.println("rpc接入配置");}@Overridepublic void stop() {System.out.println("rpc接入销毁配置");}
}

自定义注解EnableAccess

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AccessImportSelector.class)
public @interface EnableAccess {/*** 接入类型* @return*/Access.Type type();
}

1. 基于 ImportSelector 接口实现

定义AccessImportSelector实现ImportSelector，分别获取注解信息，根据注解获取接入类型，根据接入类型选择不同的接入类型；使用spring的AnnotationMetadata 获取注解的元信息，通过注解的值判断需要实例化的bean对象；

public class AccessImportSelector implements ImportSelector{@Overridepublic String[] selectImports(AnnotationMetadata annotationMetadata) {//读取EnableAccess中所有的属性方法Map<String, Object> annotationAttributes = annotationMetadata.getAnnotationAttributes(EnableAccess.class.getName());//获取属性为type的属性方法Access.Type type = (Access.Type )annotationAttributes.get("type");//导入的类名称数组String [] importClassName = new String[0];switch (type){case RPC://设置为RPC，返回RpcAccess组件importClassName = new String[]{RpcAccess.class.getName()};break;case REST://设置为REST，返回RestAccess组件importClassName = new String[]{RestAccess.class.getName()};}return importClassName;}
}

使用

在primarySource也就是这里的DemoApplication上使用注解EnableAccess，选择接入方式，就会初始化不通的接入组件

@SpringBootApplication
@EnableAccess(type=Access.Type.REST)
public class DemoApplication {public static void main(String[] args) {ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);Access access = context.getBean(Access.class);access.start();access.stop();}}

2. 基于 ImportBeanDefinitionRegistrar 接口实现

这里其它步骤一样，主要区别是注解里面Import的类变了，这里是基于基于ImportBeanDefinitionRegistrar实现注解驱动实现；

接口的使用很简单，使用@Import注解导入这个类即可

自定义ImportBeanDefinitionRegistrar

public class AccessImportBeanDefinitionRegistrar implements ImportBeanDefinitionRegistrar {@Overridepublic void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry beanDefinitionRegistry) {ImportSelector importSelector = new AccessImportSelector();//筛选class名称集合String[] selectedClassNames = importSelector.selectImports(annotationMetadata);Stream.of(selectedClassNames).map(BeanDefinitionBuilder::genericBeanDefinition).map(BeanDefinitionBuilder::getBeanDefinition).forEach(beanDefinition ->{//注册beanDefinition到beanDefinitionRegistryBeanDefinitionReaderUtils.registerWithGeneratedName(beanDefinition,beanDefinitionRegistry);});}
}

EnableAccess注解变更
这里import导入了AccessImportBeanDefinitionRegistrar

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Import(AccessImportBeanDefinitionRegistrar.class)
public @interface EnableAccess {/*** 接入类型* @return*/Access.Type type();
}

实现RPC接入type=Access.Type.RPC

@SpringBootApplication
@EnableAccess(type=Access.Type.RPC)
public class DemoApplication {public static void main(String[] args) {ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);Access access = context.getBean(Access.class);access.start();access.stop();}}

REST接入type=Access.Type.REST

@SpringBootApplication
@EnableAccess(type=Access.Type.REST)
public class DemoApplication {public static void main(String[] args) {ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);Access access = context.getBean(Access.class);access.start();access.stop();}}

importBeanDefinitionRegistrar接口是也是spring的扩展点之一,它可以支持我们自己写的代码封装成BeanDefinition对象;实现此接口的类会回调postProcessBeanDefinitionRegistry方法，注册到spring容器中。把bean注入到spring容器不止有 @Service @Component等注解方式；

public class ImportBeanDefinitionRegistrarTest implements ImportBeanDefinitionRegistrar{@Overridepublic void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {BeanDefinition beanDefinition = new GenericBeanDefinition();beanDefinition.setBeanClassName(TestBean.class.getName());MutablePropertyValues values = beanDefinition.getPropertyValues();values.addPropertyValue("id", 1);values.addPropertyValue("name", "ZhangSan");//这里注册beanregistry.registerBeanDefinition("testBean", beanDefinition );	}
}