自定义@EnableXXX注解

自定义@EnableXXX注解

场景

自定义注解 + AOP 实现接口日志的自动记录（日志记录器），将本项目打包到别的项目上使用时，一开始没有效果，后来发现是因为SpringBoot项目默认注册主程序所在包以及子包的Bean , 而导入的日志记录器里面的所有Bean都没有注入Spring IOC容器 ， 所以在主程序上使用@ComponentScan(basePackages = {“com.lian.song”}) 注解，显式的使得当前项目去注入日志记录器中的Bean ，

但是这样就暴露出一些问题

1 包名暴露了

2 使用起来不是特别的方便

经过大佬的指定，把注入Bean的功能放到日志记录器中，并且使用@EnableLogger注解实现此功能，使用的时候也能见名知意

作用

就是为了解决本项目的Bean不能在本项目注入，而需要在引入项目进行显式注入的问题（本项目的Bean由本项目注入）

自定义

第一步 定义一个配置文件，将本项目中所有Bean都返回并且使其配置文件和Bean定义能够被扫描

@Configuration
public class LoggerConfig {
   // 一定要注入所有的Bean

    @Bean
    public LoggingAspects getLoggingAspects() {
        return new LoggingAspects();
    }

    @Bean
    public LogMapper getLogMapper() {
        return new DefaultLogMapperImpl();
    }

    @Bean
    public LoggingUtils getLoggingUtils() {
        return new LoggingUtils();
    }

    @Bean
    public SpringUtils getSpringUtils() {
        return new SpringUtils();
    }
}

2 自定义一个注解（@EnableXXX），用于在别的项目使用时开启特定功能（本质就是注入特定的功能所需要的Bean）

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import(LoggerEnableAutoConfig.class)  //关注@Import() 注解及其导入的配置类
public @interface EnableLogger {

}

到现在为止，知道@EnableLogger注解用于注入项目的Bean , 用在别的项目的主程序上，但是这个注解用在了那个主程序上，别的项目的主程序和本项目的配置文件是怎么勾连上的呢？这时候就是

@Import(LoggerEnableAutoConfig.class)  

发挥作用的时候了

看名字就知道@Import注解导入一个自动配置类（LoggerEnableAutoConfig）

第三步 自定义自动配置类

@Slf4j
@Configuration
public class LoggerEnableAutoConfig implements ImportSelector {
    Logger logger = LoggerFactory.getLogger(LoggerEnableAutoConfig.class);

    @Override
    public String[] selectImports(AnnotationMetadata annotationMetadata) {
        //判断主程序上是否存在指定注解
        Map<String, Object> attributes = annotationMetadata.getAnnotationAttributes(EnableLogger.class.getName());
        if(attributes == null){
            log.info("@EnableLogger is not used on the main program");
            return new String[0];
        }
        return  new String[]{LoggerConfig.class.getName()};
    }


}

编写一个实现了ImportSelector接口类

ImportSelector接口，查看其具体实现源码（根据AnnotationMetadata元数据注册bean类，即返回的Bean 会自动的被注入，被Spring所管理）

public interface ImportSelector {

	/**
	 * Select and return the names of which class(es) should be imported based on
	 * the {@link AnnotationMetadata} of the importing @{@link Configuration} class.
	 * @return the class names, or an empty array if none
	 */
	String[] selectImports(AnnotationMetadata importingClassMetadata);
    
}

这个接口返回的类的全类名对应的Bean都会被注入到IOC容器中

其实现自动配置的方式的底层就是通过@Import注解引入相关配置类，然后再在配置类将所需的bean注册到spring容器中和实现组件相关处理逻辑