基于@ComponentScan注解的使用詳解
更新時(shí)間：2021年08月16日 11:18:29 作者：Code0cean
這篇文章主要介紹了@ComponentScan注解的使用詳解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教
@ComponentScan注解的使用
一、注解定義
@ComponentScan注解的定義如下：
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
/**
* 掃描路徑
* @ComponentScan(value = "spring.annotation.componentscan")
*/
@AliasFor("basePackages")
String[] value() default {};
/**
* 掃描路徑
*/
@AliasFor("value")
String[] basePackages() default {};
/**
* 指定掃描類(lèi)
* @ComponentScan(basePackageClasses = {BookDao.class, BookService.class})
*/
Class<?>[] basePackageClasses() default {};
/**
* 命名注冊(cè)的Bean，可以自定義實(shí)現(xiàn)命名Bean，
* 1、@ComponentScan(value = "spring.annotation.componentscan",nameGenerator = MyBeanNameGenerator.class)
* MyBeanNameGenerator.class 需要實(shí)現(xiàn) BeanNameGenerator 接口，所有實(shí)現(xiàn)BeanNameGenerator 接口的實(shí)現(xiàn)類(lèi)都會(huì)被調(diào)用
* 2、使用 AnnotationConfigApplicationContext 的 setBeanNameGenerator方法注入一個(gè)BeanNameGenerator
* BeanNameGenerator beanNameGenerator = (definition,registry)-> String.valueOf(new Random().nextInt(1000));
* AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
* annotationConfigApplicationContext.setBeanNameGenerator(beanNameGenerator);
* annotationConfigApplicationContext.register(MainConfig2.class);
* annotationConfigApplicationContext.refresh();
* 第一種方式只會(huì)重命名@ComponentScan掃描到的注解類(lèi)
* 第二種只有是初始化的注解類(lèi)就會(huì)被重命名
* 列如第一種方式不會(huì)重命名 @Configuration 注解的bean名稱(chēng)，而第二種就會(huì)重命名 @Configuration 注解的Bean名稱(chēng)
*/
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
/**
* 用于解析@Scope注解，可通過(guò) AnnotationConfigApplicationContext 的 setScopeMetadataResolver 方法重新設(shè)定處理類(lèi)
* ScopeMetadataResolver scopeMetadataResolver = definition -> new ScopeMetadata(); 這里只是new了一個(gè)對(duì)象作為演示，沒(méi)有做實(shí)際的邏輯操作
* AnnotationConfigApplicationContext annotationConfigApplicationContext = new AnnotationConfigApplicationContext();
* annotationConfigApplicationContext.setScopeMetadataResolver(scopeMetadataResolver);
* annotationConfigApplicationContext.register(MainConfig2.class);
* annotationConfigApplicationContext.refresh();
* 也可以通過(guò)@ComponentScan 的 scopeResolver 屬性設(shè)置
*@ComponentScan(value = "spring.annotation.componentscan",scopeResolver = MyAnnotationScopeMetadataResolver.class)
*/
Class<? extends ScopeMetadataResolver> scopeResolver() default AnnotationScopeMetadataResolver.class;
/**
* 用來(lái)設(shè)置類(lèi)的代理模式
*/
ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;
/**
* 掃描路徑 如 resourcePattern = "**/*.class"
* 使用 includeFilters 和 excludeFilters 會(huì)更靈活
*/
String resourcePattern() default ClassPathScanningCandidateComponentProvider.DEFAULT_RESOURCE_PATTERN;
/**
* 指示是否應(yīng)啟用對(duì)帶有{@code @Component}，{@ code @Repository}，
* {@ code @Service}或{@code @Controller}注釋的類(lèi)的自動(dòng)檢測(cè)。
*/
boolean useDefaultFilters() default true;
/**
* 對(duì)被掃描的包或類(lèi)進(jìn)行過(guò)濾，若符合條件，不論組件上是否有注解，Bean對(duì)象都將被創(chuàng)建
* @ComponentScan(value = "spring.annotation.componentscan",includeFilters = {
* @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {Controller.class, Service.class}),
* @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = {SchoolDao.class}),
* @ComponentScan.Filter(type = FilterType.CUSTOM, classes = {MyTypeFilter.class}),
* @ComponentScan.Filter(type = FilterType.ASPECTJ, pattern = "spring.annotation..*"),
* @ComponentScan.Filter(type = FilterType.REGEX, pattern = "^[A-Za-z.]+Dao$")
* },useDefaultFilters = false)
* useDefaultFilters 必須設(shè)為 false
*/
Filter[] includeFilters() default {};
/**
* 指定哪些類(lèi)型不適合進(jìn)行組件掃描。
* 用法同 includeFilters 一樣
*/
Filter[] excludeFilters() default {};
/**
* 指定是否應(yīng)注冊(cè)掃描的Bean以進(jìn)行延遲初始化。
* @ComponentScan(value = "spring.annotation.componentscan",lazyInit = true)
*/
boolean lazyInit() default false;
/**
* 用于 includeFilters 或 excludeFilters 的類(lèi)型篩選器
*/
@Retention(RetentionPolicy.RUNTIME)
@Target({})
@interface Filter {
/**
* 要使用的過(guò)濾器類(lèi)型，默認(rèn)為 ANNOTATION 注解類(lèi)型
* @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = {Controller.class, Service.class})
*/
FilterType type() default FilterType.ANNOTATION;
/**
* 過(guò)濾器的參數(shù)，參數(shù)必須為class數(shù)組，單個(gè)參數(shù)可以不加大括號(hào)
* 只能用于 ANNOTATION 、ASSIGNABLE_TYPE 、CUSTOM 這三個(gè)類(lèi)型
* @ComponentScan.Filter(type = FilterType.ANNOTATION, value = {Controller.class, Service.class})
* @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = {SchoolDao.class})
* @ComponentScan.Filter(type = FilterType.CUSTOM, classes = {MyTypeFilter.class})
*/
@AliasFor("classes")
Class<?>[] value() default {};
/**
* 作用同上面的 value 相同
* ANNOTATION 參數(shù)為注解類(lèi)，如 Controller.class, Service.class, Repository.class
* ASSIGNABLE_TYPE 參數(shù)為類(lèi)，如 SchoolDao.class
* CUSTOM 參數(shù)為實(shí)現(xiàn) TypeFilter 接口的類(lèi) ，如 MyTypeFilter.class
* MyTypeFilter 同時(shí)還能實(shí)現(xiàn) EnvironmentAware，BeanFactoryAware，BeanClassLoaderAware，ResourceLoaderAware
* 這四個(gè)接口
* EnvironmentAware
* 此方法用來(lái)接收 Environment 數(shù)據(jù) ，主要為程序的運(yùn)行環(huán)境，Environment 接口繼承自 PropertyResolver 接口，
* 詳細(xì)內(nèi)容在下方
* @Override
* public void setEnvironment(Environment environment) {
* String property = environment.getProperty("os.name");
* }
*
* BeanFactoryAware
* BeanFactory Bean容器的根接口，用于操作容器，如獲取bean的別名、類(lèi)型、實(shí)例、是否單例的數(shù)據(jù)
* @Override
* public void setBeanFactory(BeanFactory beanFactory) throws BeansException {
* Object bean = beanFactory.getBean("BeanName")
* }
*
* BeanClassLoaderAware
* ClassLoader 是類(lèi)加載器，在此方法里只能獲取資源和設(shè)置加載器狀態(tài)
* @Override
* public void setBeanClassLoader(ClassLoader classLoader) {
* ClassLoader parent = classLoader.getParent();
* }
*
* ResourceLoaderAware
* ResourceLoader 用于獲取類(lèi)加載器和根據(jù)路徑獲取資源
* public void setResourceLoader(ResourceLoader resourceLoader) {
* ClassLoader classLoader = resourceLoader.getClassLoader();
* }
*/
@AliasFor("value")
Class<?>[] classes() default {};
/**
* 這個(gè)參數(shù)是 classes 或 value 的替代參數(shù)，主要用于 ASPECTJ 類(lèi)型和 REGEX 類(lèi)型
* ASPECTJ 為 ASPECTJ 表達(dá)式
* @ComponentScan.Filter(type = FilterType.ASPECTJ, pattern = "spring.annotation..*")
* REGEX 參數(shù)為 正則表達(dá)式
* @ComponentScan.Filter(type = FilterType.REGEX, pattern = "^[A-Za-z.]+Dao$")
*/
String[] pattern() default {};
}
}
二、使用
1.環(huán)境準(zhǔn)備
創(chuàng)建Maven項(xiàng)目，添加依賴(lài)：
<dependencies>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.3.26.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/junit/junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
</dependencies>
創(chuàng)建bean，controller，dao，service層，并在類(lèi)上加上對(duì)應(yīng)的注解，項(xiàng)目結(jié)構(gòu)如下：
編寫(xiě)測(cè)試類(lèi)，如下：
public class IoCTest {
@Test
public void test01() {
//獲取Spring的IOC容器
ApplicationContext applicationContext=new AnnotationConfigApplicationContext(SpringConfig.class);
//從容器中獲取bean
String[] names= applicationContext.getBeanDefinitionNames();
for(String i:names) {
System.out.println(i);
}
}
}
2.excludeFilters的使用
使用excludeFilters不掃描com.learn包中的Controller、Service注解，如下：
@Configuration
@ComponentScan(basePackages = "com.learn",excludeFilters = {
@Filter(type = FilterType.ANNOTATION,classes = {Controller.class,Service.class})
})
public class SpringConfig {
}
上面使用的excludeFilters用于設(shè)置排除的過(guò)濾條件，實(shí)現(xiàn)Filter接口的type屬性用于設(shè)置過(guò)濾類(lèi)型，默認(rèn)值為FilterType.ANNOTATION，提供了這幾個(gè)過(guò)濾類(lèi)型：
FilterType.ANNOTATION：按照注解過(guò)濾FilterType.ASSIGNABLE_TYPE：按照給定的類(lèi)型過(guò)濾FilterType.ASPECTJ：按照ASPECTJ表達(dá)式過(guò)濾FilterType.REGEX：按照正則表達(dá)式過(guò)濾FilterType.CUSTOM：按照自定義規(guī)則過(guò)濾
classes和value屬性為過(guò)濾器的參數(shù)，必須為class數(shù)組，類(lèi)只能為以下三種類(lèi)型：
ANNOTATION參數(shù)為注解類(lèi)，如 Controller.class, Service.class,Repository.classASSIGNABLE_TYPE參數(shù)為類(lèi)，如 SchoolDao.classCUSTOM參數(shù)為實(shí)現(xiàn) TypeFilter 接口的類(lèi) ，如 MyTypeFilter.class
3.includeFilters的使用
includeFilters屬性用于定義掃描過(guò)濾條件，滿足該條件才進(jìn)行掃描。用法與excludeFilters一樣。
但是因?yàn)閡seDefaultFilters屬性默認(rèn)為true，即使用默認(rèn)的過(guò)濾器，啟用對(duì)帶有@Component，@Repository，@Service，@Controller注釋的類(lèi)的自動(dòng)檢測(cè)。會(huì)將帶有這些注解的類(lèi)注冊(cè)為bean裝配到IoC容器中。所以使用includeFilters時(shí)，需要把useDefaultFilters設(shè)置為false，如下：
@Configuration
@ComponentScan(basePackages = "com.learn",includeFilters = {
@Filter(type = FilterType.ANNOTATION,classes = {Controller.class,Service.class})
},useDefaultFilters = false)
public class SpringConfig {
}
結(jié)果如下，只掃描了帶有Controller，Service注解的自定義的類(lèi)：
4.自定義過(guò)濾規(guī)則
@ComponentScan注解掃描或解析的bean只能是Spring內(nèi)部所定義的，比如@Component、@Service、@Controller或@Repository。如果要掃描一些自定義的注解，就可以自定義過(guò)濾規(guī)則來(lái)完成這個(gè)操作。
自定義一個(gè)類(lèi)MyTypeFilter實(shí)現(xiàn)TypeFilter接口，這樣這個(gè)TypeFilter就掃描所有類(lèi)并只通過(guò)類(lèi)名包含了controller的類(lèi)，如下：
public class MyTypeFilter implements TypeFilter {
/**
* 兩個(gè)參數(shù)的含義：
* metadataReader：包含讀取到的當(dāng)前正在掃描的類(lèi)的信息
* metadataReaderFactory:可以獲取到當(dāng)前正在掃描的類(lèi)的其他類(lèi)信息(如父類(lèi)和接口)
* match方法返回false即不通過(guò)過(guò)濾規(guī)則，true通過(guò)過(guò)濾規(guī)則
*/
@Override
public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
throws IOException {
// TODO Auto-generated method stub
//獲取當(dāng)前類(lèi)注解的信息
AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
//獲取當(dāng)前正在掃描的類(lèi)的類(lèi)信息
ClassMetadata classMetadata = metadataReader.getClassMetadata();
//獲取當(dāng)前類(lèi)資源（類(lèi)的路徑）
Resource resource = metadataReader.getResource();
String className = classMetadata.getClassName();
if(className.contains("controller")){
return true;
}
return false;
}
}
在@ComponentScan注解中進(jìn)行配置，如下：
@Configuration
@ComponentScan(basePackages = "com.learn",includeFilters = {
@Filter(type = FilterType.ASSIGNABLE_TYPE,classes = {Person.class}),
@Filter(type = FilterType.CUSTOM,classes = {MyTypeFilter.class}),
},useDefaultFilters = false)
public class SpringConfig {
}
經(jīng)過(guò)上面的配置，第一個(gè)@Filter通過(guò)FilterType.ASSIGNABLE_TYPE規(guī)定了只掃描Person類(lèi)型的類(lèi)，第二個(gè)@Filter通過(guò)FilterType.CUSTOM自定義過(guò)濾規(guī)則規(guī)定了只掃描類(lèi)名包含controller的類(lèi)。結(jié)果：
關(guān)于@ComponentScan注解的一些細(xì)節(jié)
@ComponentScan注解可以掃描 任意 類(lèi) 或者 注解 中內(nèi)部類(lèi)bean；
要想被掃描的前提是內(nèi)部類(lèi)標(biāo)注了@Component及其相關(guān)衍生注解、內(nèi)部類(lèi)必須是static修飾，否則掃描不到；如果是注解的內(nèi)部類(lèi)則只能是public static修飾
//@Configuration
public class ProfileConfig {
@Component("class1")
private static class Class1 {
@Bean
public Class3 class3() {
return new Class3();
}
}
@Component("class2")
static class Class2 {
}
//@Component("class3")
protected static class Class3 {
}
// @Component("class4") //出錯(cuò)
// protected class Class4 {
//
// }
}
--------------------------------------------------------
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
//@Bean
public @interface MyBean {
public static final int age1=3; //常量可以
int age=2;
public abstract String value() default "qwer"; //屬性可以
//內(nèi)部類(lèi)可以
@Component
@DependsOn("myBean.EventZ") //依賴(lài)事件bean的創(chuàng)建，保證該bean在事件bean之后創(chuàng)建
//細(xì)節(jié)：因?yàn)槭莾?nèi)部類(lèi)，所以默認(rèn)bean的id是類(lèi)名首字母小寫(xiě)，不是eventZ而是myBean.EventZ
class EventSource {
public EventSource(){
System.out.println("事件源創(chuàng)建了...");
}
}
@Component//("eventZ")
public static class EventZ {
public EventZ(){
System.out.println("事件創(chuàng)建了...");
}
}
}
以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。
相關(guān)文章
單個(gè)的?RabbitMQ?肯定無(wú)法實(shí)現(xiàn)高可用，要想高可用，還得上集群。這篇文章主要介紹了SpringBoot中RabbitMQ集群的兩種模式的搭建：普通集群搭建和鏡像集群搭建，需要的朋友可以參考一下2021-12-12
JAVA開(kāi)發(fā)常用類(lèi)庫(kù)UUID、Optional、ThreadLocal、TimerTask、Base64使用方法與實(shí)例詳
這篇文章主要介紹了JAVA開(kāi)發(fā)常用類(lèi)庫(kù)UUID、Optional、ThreadLocal、TimerTask、Base64使用方法與實(shí)例詳解,需要的朋友可以參考下2020-02-02
IDEA下Maven的pom文件導(dǎo)入依賴(lài)出現(xiàn)Auto build completed with errors的問(wèn)題
這篇文章主要介紹了IDEA下Maven的pom文件導(dǎo)入依賴(lài)出現(xiàn)Auto build completed with errors,本文通過(guò)圖文并茂的形式給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下2020-06-06
這篇文章主要介紹了Java中的ArrayList容量及擴(kuò)容方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-09-09
這篇文章主要介紹了關(guān)于Dubbo初始問(wèn)題，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2023-03-03
使用nacos命名空間namespace用法,測(cè)試時(shí)做實(shí)例隔離
Nacos命名空間用于管理多套不同環(huán)境的服務(wù)器,增加一個(gè)命名空間的概念,可以用一套Nacos注冊(cè)中心管理多套不同的環(huán)境2024-12-12
這篇文章主要為大家詳細(xì)介紹了Java使用字節(jié)流復(fù)制文件的方法，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2017-05-05
Spring?Boot?Actuator使用說(shuō)明
SpringBootActuator?是一個(gè)用于監(jiān)控和管理?Spring?Boot?應(yīng)用程序的強(qiáng)大工具,通過(guò)引入依賴(lài)并配置,可以啟用默認(rèn)的監(jiān)控接口,本文介紹Spring?Boot?Actuator的使用,感興趣的朋友一起看看吧2025-02-02
Java集合List和Map互轉(zhuǎn)的方法總結(jié)
有時(shí)候我們需要將給定的List轉(zhuǎn)換為Map,或者M(jìn)ap轉(zhuǎn)換為L(zhǎng)ist,本文主要介紹了Java集合List和Map互轉(zhuǎn)的方法總結(jié),具有一定的參考價(jià)值,感興趣的可以了解一下2023-09-09
springboot時(shí)間格式化的五種方法總結(jié)(解決后端傳給前端的時(shí)間顯示不一致)
這篇文章主要給大家介紹了關(guān)于springboot時(shí)間格式化的五種方法,文中介紹的方法解決了后端傳給前端的時(shí)間顯示不一致,文中通過(guò)圖文以及代碼介紹的非常詳細(xì),需要的朋友可以參考下2024-01-01