伪造一个@Component?扫描指定目录注入IOC容器(SpringBoot自定义包扫描)

扫描指定目录注入IOC容器(自定义包扫描)

自定义包扫描主要通过自定义注解+ImportBeanDefinitionRegistrar实现.

1.创建用于添加到启动类上的注解(类似于MyBatis的@MapperScan)

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
// 快速导入AutoConfig类,该类中实现自定义扫描逻辑
@Import(AutoConfig.class)
public @interface AutoScan {
    // 自定义的路径
    String[] basePackage() default {};
}

2.自定义扫描器,继承ClassPathBeanDefinitionScanner

import org.springframework.beans.factory.annotation.AnnotatedBeanDefinition;
import org.springframework.beans.factory.config.BeanDefinitionHolder;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.ClassPathBeanDefinitionScanner;
import org.springframework.core.type.filter.AnnotationTypeFilter;

// 此处不添加任何注解,该类在使用时通过new创建
public class AutoScanHandle extends ClassPathBeanDefinitionScanner {
    public AutoScanHandle(BeanDefinitionRegistry registry, boolean useDefaultFilters) {
        // 如果不使用默认的过滤器,useDefaultFilters应该设置为false
        super(registry, useDefaultFilters);
    }

    @Override
    public Set<BeanDefinitionHolder> doScan(String... basePackages) {
        // 添加扫描条件,此处为仅扫描添加了@AutoNew.class注解的类
        addIncludeFilter(new AnnotationTypeFilter(AutoNew.class));
        // 调用Spring的扫描
        Set<BeanDefinitionHolder> beanDefinitionHolders = super.doScan(basePackages);
        // 此处可以对集合中的数据进行操作
        return beanDefinitionHolders;
    }
    
    @Override
    protected boolean isCandidateComponent(AnnotatedBeanDefinition beanDefinition) {
        // 此处定义条件,和addIncludeFilter指定的条件为 与 的关系
        // beanDefinition.getMetadata()可以获取到数据的元信息,可以用来判断是否是接口,是否是独立类等
        return  beanDefinition.getMetadata().isIndependent();
    }

}

3.实现ImportBeanDefinitionRegistrar

import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.annotation.AnnotationAttributes;
import org.springframework.core.type.AnnotationMetadata;

// 此处不添加任何注解,在AutoScan注解上通过@Import进行快速注入
public class AutoConfig implements ImportBeanDefinitionRegistrar {
    @Override
    public void registerBeanDefinitions(AnnotationMetadata annotationMetadata, BeanDefinitionRegistry registry) {
        // 获取AutoScan的注解属性
        AnnotationAttributes annotationAttributes = 		            AnnotationAttributes.fromMap(annotationMetadata.getAnnotationAttributes(AutoScan.class.getName()));
        // 获取注解字段的值
        String[] basePackages = annotationAttributes.getStringArray("basePackage");
        // 创建自定义包扫描器进行扫描.如果不使用默认过滤方式第二个参数设置为false
        AutoScanHandle autoScanHandle = new AutoScanHandle(registry, false);
        autoScanHandle.doScan(basePackages);
    }
}

4.在启动器上添加自定义的注解

@SpringBootApplication
// 根据上面的内容,项目启动时会自动扫描该路径下添加了@AutoNew注解的类并添加到Spring IOC容器中
@AutoScan(basePackage = {"com.silwings.classscan.bean"})
public class AutoScanApplication {
    public static void main(String[] args) {
        SpringApplication.run(AutoScanApplication.class, args);
    }
}

服务启动后，添加了AutoNew注解的类就会被注入到IOC容器