Spring中的@ComponentScan注解詳解

更新時(shí)間：2024年01月08日 09:52:39 作者：nsnsttn

這篇文章主要介紹了Spring中的@ComponentScan注解詳解,ComponentScan做的事情就是告訴Spring從哪里找到bean,由你來(lái)定義哪些包需要被掃描,一旦你指定了,Spring將會(huì)在被指定的包及其下級(jí)包中尋找bean,需要的朋友可以參考下

Spring注解 @ComponentScan

1.添加 @ComponentScan 注解

創(chuàng)建一個(gè)配置類，在配置類上添加 @ComponentScan 注解。該注解默認(rèn)會(huì)掃描該類所在的包下所有的配置類，相當(dāng)于之前的

 <context:component-scan>

2.獲取已經(jīng)注冊(cè)到容器中的 bean 的名稱以及數(shù)量

使用 ApplicationContext 的 getBeanDefinitionNames() 方法和getBeanDefinitionCount()獲取已經(jīng)注冊(cè)到容器中的 bean 的名稱以及數(shù)量

@SpringBootApplication
public class ZzyNotesApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(ZzyNotesApplication.class, args);
        String[] beanDefinitionNames = context.getBeanDefinitionNames();
        for (String beanName : beanDefinitionNames) {
            System.out.println("beanName: " + beanName);
        }
        System.out.println("bean總數(shù):"+context.getBeanDefinitionCount());
    }
}

3.@ComponentScan

@SpringBootApplication注解中已經(jīng)存在,也可以根據(jù)需要自定義		
@SpringBootApplication(scanBasePackages = "")

常用參數(shù):

1.value || basePackages = "包路徑,默認(rèn)當(dāng)前類所在包"

2.excludeFilters 使用 excludeFilters 來(lái)按照規(guī)則排除某些包的掃描。

3.includeFilters 用includeFilters配置掃描的類

優(yōu)先級(jí)由上之下,比如自定義的MyTypeFilter如果已經(jīng)Bean已經(jīng)在ioc容器中,或者上面的excludeFilters已經(jīng)過(guò)濾掉這個(gè)Bean,則不掃描這個(gè)類

參數(shù):
FilterType.ANNOTATION ：注解名規(guī)則，Service.class
FilterType.ASSIGNABLE_TYPE : 按照給定的類型，比如當(dāng)前類型的父子類。
FilterType.ASPECTJ ：使用aspectj表達(dá)式
FilterType.REGEX ：使用正則指定
FilterType.CUSTOM

4.useDefaultFilters

默認(rèn)為true ,會(huì)優(yōu)先執(zhí)行默認(rèn)的過(guò)濾器對(duì) @Component、@ManagedBean、@Named注解的Bean進(jìn)行掃描所以要改為false

配置類代碼如下

@Configuration
@ComponentScans(
        {
        @ComponentScan(value = "com.zzy.zzyNotes" ,useDefaultFilters = false),
        @ComponentScan(value = "com.zzy.zzyNotes.spring.createBean",
                excludeFilters = {
                        @ComponentScan.Filter(type = FilterType.ANNOTATION, value = {Service.class}),//排除包含注解Service的類(不生效,原因未知)
                        @ComponentScan.Filter(type = FilterType.ANNOTATION, value = {ExcludeMyAnnotation.class})//排除包含注解MyAnnotation2的類
                },
                includeFilters = {
                        @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {IncludeMyAnnotation.class}),//指定掃描包換注解MyAnnotation的類
                        @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {Controller.class}),//指定注解掃描包換注解Controller的類
                        @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE , classes = {Person2.class}),//指定類型Person2的類
                        @ComponentScan.Filter(type = FilterType.CUSTOM, classes = {MyTypeFilter.class})//自定義過(guò)濾規(guī)則
                }
                , useDefaultFilters = false//這個(gè)沒有效果,必須在啟動(dòng)類上的@ComponentScan( useDefaultFilters = false)中配置 false
        )
        }
)
public class BeanConfig {
}

/**
 * @author zzy
 * @createDate: 2021-12-30 16:26:50
 * @description: 自定義注解 指定某個(gè)類被掃描
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface IncludeMyAnnotation {
}

/**
 * @author zzy
 * @createDate: 2021-12-30 16:26:50
 * @description: 自定義注解 排除某個(gè)類被掃描
 */
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExcludeMyAnnotation {
}

/**
 * 掃描包自定義規(guī)則
 * metadataReader:讀取到當(dāng)前正在掃描類的信息
 * metadataReaderFactory：可以獲取到其他任何類的信息
 *	注意:只有不滿足其它的規(guī)則,才會(huì)被自定義過(guò)濾規(guī)則判斷
 * @author zzy
 */
public class MyTypeFilter implements TypeFilter {

    /**
    * @description:  掃描規(guī)則
    * @params:
    * @return: 返回true 加入IOC容器 false ,排除
    */
    @Override
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
        throws IOException {
        //獲取當(dāng)前類注解信息
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        //獲取當(dāng)前正在掃描類的信息
        ClassMetadata classMetadata = metadataReader.getClassMetadata();
        //獲取當(dāng)前類資源信息 （比如類存在哪個(gè)盤，類的路徑  ）
        Resource resource = metadataReader.getResource();
        String name = classMetadata.getClassName();
        System.out.println("Filter掃描的類名:" + name);
        if(name.contains("Person3")){
            return true;
        }
        return false;
    }
}

/**
 * @author zzy
 * @createDate: 2021-12-30 10:08:35
 * @description: 創(chuàng)建Bean Person1 加IncludeMyAnnotation
 */
@IncludeMyAnnotation
public class Person1 {
}

/**
 * @author zzy
 * @createDate: 2021-12-30 10:10:37
 * @description: 創(chuàng)建Bean Person1 加@ExcludeMyAnnotation 被排除
 * 正常有@Component就會(huì)被掃描,加了@ExcludeMyAnnotation就會(huì)被排除
 */
@ExcludeMyAnnotation
@Component
public class Person2 {
}

/**
 * @author zzy
 * @createDate: 2021-12-30 17:03:44
 * @description: 創(chuàng)建Bean Person3  符合MyTypeFilter過(guò)濾規(guī)則
 */
public class Person3 {
}