Spring中@Enable功能开关注解的实现

男娘i 2022-12-29 00:06 123阅读 0赞

**目录**

@Import

注解驱动实现（@Import+@Configuration）

接口驱动实现（@Import+自定义ImportSelector接口实例）

自定义功能开关注解

--------------------

经常会用到Spring项目中@EnableXXX这种注解，都是用来启用某种功能，这种注解类似于一种开关，加了这个注解，就能使用某些功能。例如** @EnableAsync、@EnableScheduling 等注解。**

Srping实现Enable模块驱动的方法大致分为两类，一种是**注解驱动实现配置**，另一种是**接口驱动实现配置**,两种方式都需要**@Import**注解。

### **@Import** ###

@Import注解用于导入一个和多个Configuration的类,将其注册为Spring的Bean。这个注解可以导入一下几种类型的类，**下面讲的两种实现方式就分别使用@Import导入了@Configuration 注解的类和实现ImportSelector接口的类。**

>  *  **@Configuration 注解的类**
>  *  **实现ImportSelector接口的类**
>  *  **实现ImportBeanDefinitionRegistrar接口的类**

###  **注解驱动实现（@Import+@**Configuration**）** ###

**看一下@EnableScheduling 定时任务功能开关注解的实现。**

**这个注解里使用@Import注解引入了SchedulingConfiguration这个类，SchedulingConfiguration是一个@Configuration注解的配置类，里面配置了这个功能所需要的Bean。**

**注意要使用注解开关的话，@Configuration注解的配置类不应该在启动时被扫描到**

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

@Configuration
    @Role(2)
    public class SchedulingConfiguration {
        public SchedulingConfiguration() {
        }
    
        @Bean(
            name = {"org.springframework.context.annotation.internalScheduledAnnotationProcessor"}
        )
        @Role(2)
        public ScheduledAnnotationBeanPostProcessor scheduledAnnotationProcessor() {
            return new ScheduledAnnotationBeanPostProcessor();
        }
    }

### **接口驱动实现（@Import+自定义**ImportSelector接口实例） ###

看一下@EnableAsync 启用异步功能注解是实现。

**这个注解里使用****@Import****注解引入了AsyncConfigurationSelector这个类，****AsyncConfigurationSelector类继承AdviceModeImportSelector抽象类（ImportSelector接口的实现类），重写了selectImports方法****，这个方法返回一个数组，数组内放的是需要配置的Bean的类路径限定名。**

**注意在编写selectImports方法中配置路径名的类时，不要在类上加@Component等类似的组件注解以免启动时被自动扫描注册导致开关失效。**

**AdviceModeImportSelector**

这个抽象类实现了ImportSelector接口，并限定选择条件只能是AdviceMode枚举类，也就是说你自定义的注解必须包含AdviceMode属性，在接口实现类里可以较为灵活的根据枚举值配置对应的bean类名。

@Target({ElementType.TYPE})
    @Retention(RetentionPolicy.RUNTIME)
    @Documented
    @Import({AsyncConfigurationSelector.class})
    public @interface EnableAsync {
        Class<? extends Annotation> annotation() default Annotation.class;
    
        boolean proxyTargetClass() default false;
    
        //设置AdviceMode类型值
        AdviceMode mode() default AdviceMode.PROXY;
    
        int order() default 2147483647;
    }

public class AsyncConfigurationSelector extends AdviceModeImportSelector<EnableAsync> {
        private static final String ASYNC_EXECUTION_ASPECT_CONFIGURATION_CLASS_NAME = "org.springframework.scheduling.aspectj.AspectJAsyncConfiguration";
    
        public AsyncConfigurationSelector() {
        }
        @Nullable
        public String[] selectImports(AdviceMode adviceMode) {
            switch(adviceMode) {
            case PROXY:
                return new String[]{ProxyAsyncConfiguration.class.getName()};
            case ASPECTJ:
                return new String[]{"org.springframework.scheduling.aspectj.AspectJAsyncConfiguration"};
            default:
                return null;
            }
        }
    }

上面写了注解开关功能的两种实现方式。第一种需要明确导入的类，实现简单。ImportSelector接口编程的方式封装较好，尤其当你选择的条件是AdviceMode，还可以选择继承AdviceModeSelector进行自定义，灵活的根据选择导入。

### 自定义功能开关注解 ###

实现通过@EnableLogging注解控制是否使用自定义的AOP切点日志打印功能。**注意配置的类编写时不要加组件注解以免启动时被自动扫描注册导致开关失效**。

@EnableLogging
    @Configuration
    @SpringBootApplication
    public class TestApplication {
    	
    	
    	public static void main(String[] args) {
    		SpringApplication.run(BackCenterApplication.class, args);
    	}
    }

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

public class LogImportSelector implements ImportSelector {
    
    	@Override
    	public String[] selectImports(AnnotationMetadata importingClassMetadata) {
    		
    		return new String[] { 
    				"cn.com.fkk.log.aop.LogAnnotationAOP",
    				"cn.com.fkk.log.service.impl.LogServiceImpl",
    				"cn.com.fkk.log.config.LogAutoConfig"
    				
    		};
    	}
    
    }