快捷導(dǎo)航

Spring的@ComponentScan注解用法介紹

更新時(shí)間：2023年11月24日 10:02:02 作者：IT技術(shù)分享社區(qū)

這篇文章主要介紹了Spring的@ComponentScan注解用法介紹,@ComponentScan注解一般和@Configuration注解一起使用,主要的作用就是定義包掃描的規(guī)則,然后根據(jù)定義的規(guī)則找出哪些需類需要自動裝配到spring的bean容器中,然后交由spring進(jìn)行統(tǒng)一管理,需要的朋友可以參考下

1、@ComponentScan注解的作用

@ComponentScan注解一般和@Configuration注解一起使用，主要的作用就是定義包掃描的規(guī)則，然后根據(jù)定義的規(guī)則找出哪些需類需要自動裝配到spring的bean容器中，然后交由spring進(jìn)行統(tǒng)一管理。

說明：針對標(biāo)注了@Controller、@Service、@Repository、@Component 的類都可以別spring掃描到。

2、@ComponentScan注解屬性介紹

1 value

指定要掃描的包路徑

2 excludeFilters（排除規(guī)則）

excludeFilters=Filter[] 指定包掃描的時(shí)候根據(jù)規(guī)則指定要排除的組件

3 includeFilters（包含規(guī)則）

includeFilters =Filter[] 指定包掃描的時(shí)候根據(jù)規(guī)則指定要包含的組件.

注意:要設(shè)置useDefaultFilters = false（系統(tǒng)默認(rèn)為true，需要手動設(shè)置） includeFilters包含過濾規(guī)則才會生效。

4 FilterType屬性

FilterType.ANNOTATION：按照注解過濾
FilterType.ASSIGNABLE_TYPE：按照給定的類型,指定具體的類，子類也會被掃描到
FilterType.ASPECTJ：使用ASPECTJ表達(dá)式
FilterType.REGEX：正則
FilterType.CUSTOM：自定義規(guī)則

useDefaultFilters: 配置是否開啟可以對加@Component，@Repository，@Service，@Controller注解的類進(jìn)行檢測，針對Java8 語法可以指定多個(gè)@ComponentScan，Java8以下可以用 @ComponentScans() 配置多個(gè)規(guī)則

3、示例

1 各種過濾過濾規(guī)則示例

// includeFilters 用法 包含Animal.class類可以被掃描到，包括其子類
@ComponentScan(value = "com.spring"
  includeFilters = {@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = {Animal.class}
)}
)
// excludeFilters 用法 排除包含@Controller注解的類
@ComponentScan(value = "com.spring"
        , excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION
                , classes = {Controller.class}
        ),
})
// ComponentScans用法
@ComponentScans(
        value = {
                @ComponentScan(value = "com.spring"
                        , includeFilters = {
                        @ComponentScan.Filter(type = FilterType.ANNOTATION
                                , classes = {Controller.class}
                        )
                }, useDefaultFilters = false) ,
                @ComponentScan(value = "com.spring"
                        , excludeFilters = {
                        @ComponentScan.Filter(type = FilterType.ANNOTATION
                                , classes = { Repository.class}
                        )
                })
        }
)*/
// @ComponentScan 
// 針對Java8 語法可以指定多個(gè)@ComponentScan，Java8以下可以用 //@ComponentScans() 配置多個(gè)規(guī)則
@ComponentScan(value = "com.spring"
        , excludeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION
                , classes = {Controller.class, Controller.class}
        ),
}, includeFilters = {
        @ComponentScan.Filter(type = FilterType.ANNOTATION
                , classes = {Controller.class, Controller.class}
        ),
})

2 自定義過濾規(guī)則需要新建 TestTypeFilter.java

package com.spring.config;
import org.springframework.core.io.Resource;
import org.springframework.core.type.AnnotationMetadata;
import org.springframework.core.type.ClassMetadata;
import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.core.type.filter.TypeFilter;
import java.io.IOException;
/**
 * metadataReader 讀取到當(dāng)前正在掃描的類信息
 * metadataReaderFactory 可以獲取到其他任何類的信息
 */
public class TestTypeFilter implements TypeFilter {
    public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
        //獲取當(dāng)前類注解信息
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        // 獲取當(dāng)前正在掃描的類信息
        ClassMetadata classMetadata = metadataReader.getClassMetadata();
        // 獲取當(dāng)前類資源信息（比如類的文件路徑）
        Resource resource = metadataReader.getResource();
        String className = classMetadata.getClassName();
        System.out.println("類名：" + className);
        if (className.contains("controller")) {
            return true;
        } else {
            return false;
        }
    }
}

3 新建測試類 TestComponentScan.java

package com.spring.test;
import com.spring.config.TestComponentScanConfig;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class TestComponentScan {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext annotationContext = new AnnotationConfigApplicationContext(TestComponentScanConfig.class);
        String[] names = annotationContext.getBeanDefinitionNames();
        for (String name : names) {
            System.out.println(name);
        }
    }
}

具體的運(yùn)行效果可以查看控制臺輸出結(jié)果，是否和預(yù)期的一樣，具體有不清楚的歡迎溝通交流。

到此這篇關(guān)于Spring的@ComponentScan注解用法介紹的文章就介紹到這了,更多相關(guān)@ComponentScan注解內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: