Spring中的@ComponentScan注解使用詳解
基本使用
@ComponentScan 注解的作用就是根據(jù)指定的掃描路徑,把路徑中符合掃描規(guī)則的類裝配到 Spring 容器中。
加入依賴
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>5.1.8.RELEASE</version>
</dependency>
配置啟動類,使用ComponentScan掃描指定包路徑
@ComponentScan(basePackages = "com.cxyxj.componentscan.app")
public class AppMain {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppMain.class);
// 打印 bean 名稱
String[] beanDefinitionNames = context.getBeanDefinitionNames();
for (String name : beanDefinitionNames){
System.out.println(name);
}
}
}
運行結果:
org.springframework.context.annotation.internalConfigurationAnnotationProcessor
org.springframework.context.annotation.internalAutowiredAnnotationProcessor
org.springframework.context.annotation.internalCommonAnnotationProcessor
org.springframework.context.event.internalEventListenerProcessor
org.springframework.context.event.internalEventListenerFactory
appMain
除了 Spring 本身注冊的一些 bean 之外, AppMain這個類也注冊進了容器中。
上述的使用方式,在沒什么特殊的要求下,在實際工作當中完全滿足項目的開發(fā)。@ComponentScan注解還有其他好用的功能,我們有必要了解并會使用。
@ComponentScan注解與XML文件中的context:component-scan標簽等效。
<beans>
<context:component-scan base-package="com.cxyxj"/>
</beans>
注解定義
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
// basePackages 的別名
// 在沒有其他屬性的情況下可以如此寫:@ComponentScan("com.cxyxj.componentscan")
// 而不需要:@ComponentScan(basePackages = "com.cxyxj.componentscan")
@AliasFor("basePackages")
String[] value() default {};
// 掃描帶注解的包路徑,默認是@Component
@AliasFor("value")
String[] basePackages() default {};
// 掃描指定帶注解的類,同時會掃描該類所在的包,默認是@Component
//示例: @ComponentScan(basePackageClasses = {UserServiceImpl.class})
Class<?>[] basePackageClasses() default {};
// beanName 的生成器
Class<? extends BeanNameGenerator> nameGenerator() default BeanNameGenerator.class;
// 解析@Scope注解
Class<? extends ScopeMetadataResolver> scopeResolver() default AnnotationScopeMetadataResolver.class;
// 是否為掃描到的Bean生成代理
/**
* ScopedProxyMode有四個取值
* 1.DEFAULT:默認值,默認情況下取no
* 2.NO:不開啟代理
* 3.INTERFACES:使用jdk動態(tài)代理
* 4.TARGET_CLASS:使用cglib代理
* 假如有一個單例beanA,其中有一個屬性B,B的Scope是session,此時,容器在啟動時創(chuàng)建A的過程中需要注入B屬性,
* 但是B的scope是session,這種情況下是注入不了的(只有用戶訪問時才會創(chuàng)建),是會報錯的
* 但是如果將B的Scope的ProxyMode屬性配置為INTERFACES或者TARGET_CLASS時,那么B就會生成一個ScopedProxyFactoryBean類型的BeanDefinitionHolder
* 在A注入B時,就會注入一個ScopedProxyFactoryBean類型的Bean
*/
ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;
// 控制符合組件檢測條件的類文件,默認是包路徑下的 **/*.class
String resourcePattern() default ClassPathScanningCandidateComponentProvider.DEFAULT_RESOURCE_PATTERN;
// 是否自動檢測帶有 @Component 注解的類,默認為 true
// 像 @Repository、 @Controller、@Service、@Configuration 內部都包含了 @Component
boolean useDefaultFilters() default true;
/**
* 如果掃描到的類符合 includeFilters 中的過濾條件
* 這個類會被注冊到容器中
* 過濾類型與如下5種
* 1、ANNOTATION:注解類型(默認)
* 2、ASSIGNABLE_TYPE:指定類
* 3、ASPECTJ:指定表達式
* 4、REGEX:正則表達式
* 5、CUSTOM:自定義類型
*/
Filter[] includeFilters() default {};
// 如果掃描到的類符合 excludeFilters 中的過濾條件
// 這個類不會被注冊
Filter[] excludeFilters() default {};
// 掃描到的類是否應延遲初始化,默認為 false
boolean lazyInit() default false;
// 聲明要用作包含過濾器或排除過濾器的類型過濾器
@Retention(RetentionPolicy.RUNTIME)
@Target({})
@interface Filter {
// 要使用的過濾器類型,默認為 ANNOTATION
FilterType type() default FilterType.ANNOTATION;
// classes 的別名
@AliasFor("classes")
Class<?>[] value() default {};
/**
* 作用同上面的 value 相同
* 過濾器的參數(shù),參數(shù)必須為class數(shù)組
* 只能用于 ANNOTATION 、ASSIGNABLE_TYPE 、CUSTOM 這三個類型
* ANNOTATION:參數(shù)為注解類,比如:Controller.class
* ASSIGNABLE_TYPE:參數(shù)為類,如 UserServiceImpl.class
* CUSTOM:參數(shù)為實現(xiàn) TypeFilter 接口的類 ,如 MyTypeFilter.class
* 實現(xiàn)了TypeFilter 接口的類,還能實現(xiàn) EnvironmentAware,BeanFactoryAware, BeanClassLoaderAware,ResourceLoaderAware 這四個回調接口
* 它們各自的方法將在 TypeFilter#match 之前被調用
*/
@AliasFor("value")
Class<?>[] classes() default {};
//這個屬性主要用于 ASPECTJ 類型和 REGEX 類型
String[] pattern() default {};
}
}
接下來使用一下幾個重要屬性。
實踐
basePackageClasses
創(chuàng)建 ProductServiceImpl、UserServiceImpl兩個類,并放在 impl包下。整體包結構如下:

類中內容如下:
ProductServiceImpl類中包含 @Configuration注解
@Configuration
public class ProductServiceImpl {
}
UserServiceImpl則是普通類
public class UserServiceImpl {
}
在ComponentScan注解增加 basePackageClasses的屬性,指定 UserServiceImpl。上面講過basePackageClasses會掃描指定帶注解的類,同時會掃描該類所在的包。
@ComponentScan(basePackages = "com.cxyxj.componentscan.app",basePackageClasses = {UserServiceImpl.class})
啟動結果

由于指定的 UserServiceImpl上面沒有注解,所以沒被加入容器中。
useDefaultFilters
useDefaultFilters 的值默認為 true,也就是默認會往 includeFilters中添加一個為 @Component注解類型的過濾器。這時我們將 useDefaultFilters的值修改為 false ,這會掃描出來幾個類呢?
@ComponentScan(basePackages = "com.cxyxj.componentscan.app",basePackageClasses = {UserServiceImpl.class},useDefaultFilters = false)
啟動結果

答案是一個都沒有,請忽略 AppMain ,這相當于是我們手動調用 context.register(AppMain.class)進行注冊的。
includeFilters
我們想把 ProductServiceImpl掃描出來,需要怎么做呢?
ANNOTATION
修改 @ComponentScan的值,增加 includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Configuration.class},指定 value 的值為 @Configuration。
這代表著只要掃描到的類中包含 @Configuration注解,就會被注冊到容器中。一般我們自定義的注解就可以結合該方式。
@ComponentScan(basePackages = "com.cxyxj.componentscan.app",
basePackageClasses = {UserServiceImpl.class},
useDefaultFilters = false,
includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Configuration.class})
)
啟動結果

ASSIGNABLE_TYPE
將 UserServiceImpl加入到容器中,但是它是一個普普通通的類,這時可以使用 ASSIGNABLE_TYPE。
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,value = {UserServiceImpl.class})
啟動結果

ASPECTJ
如果覺得一個一個的加入比較麻煩,可以使用 ASPECTJ表達式的方式。
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.ASPECTJ,pattern = {"com.cxyxj.componentscan.impl.*"})
啟動結果

如果啟動報錯需要加入 aspectj的依賴。
<!--aspectj 支持-->
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjrt</artifactId>
<version>1.9.6</version>
</dependency>
<dependency>
<groupId>org.aspectj</groupId>
<artifactId>aspectjweaver</artifactId>
<version>1.9.6</version>
</dependency>
REGEX
跟 ASPECTJ能達到效果的是 REGEX,使用正則表達式進行匹配。需要注意的是進行匹配的值是類的全限定名,比如:com.cxyxj.componentscan.impl.UserServiceImpl。
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.REGEX,pattern = {"[A-Za-z.]+Impl$"})
啟動結果

CUSTOM
如果覺得上述幾種方式都不滿足需求,我們可以進行自定義過濾規(guī)則。
創(chuàng)建 CustomTypeFilter 類,并實現(xiàn) TypeFilter接口,重寫其 match方法。
public class CustomTypeFilter implements TypeFilter {
/**
*
* @param metadataReader:可以獲得當前正在掃描的類的信息
* @param metadataReaderFactory:可以獲得 MetadataReader。metadataReaderFactory.getMetadataReader(UserServiceImpl.class.getName());
* @return match方法返回false 則表示不通過過濾規(guī)則,true 表示通過過濾規(guī)則
* @throws IOException
*/
@Override
public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
//Class元數(shù)據(jù)
ClassMetadata classMetadata = metadataReader.getClassMetadata();
//全限定名稱
String className = classMetadata.getClassName();
//如果名稱包含 User 則通過過濾
if(className.contains("User")){
return true;
}
return false;
}
}
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.CUSTOM,value = {CustomTypeFilter.class})
啟動結果

通過自定義過濾規(guī)則的掃描,只有 UserServiceImpl符合。
excludeFilters 的使用方式與 includeFilters一致。只不過 excludeFilters是排除而已。
到此這篇關于Java中的@ComponentScan注解使用詳解的文章就介紹到這了,更多相關@ComponentScan注解使用內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
java實現(xiàn)微信掃碼登錄第三方網站功能(原理和代碼)
為避免繁瑣的注冊登陸,很多平臺和網站都會實現(xiàn)三方登陸的功能,增強用戶的粘性。這篇文章主要介紹了java實現(xiàn)微信掃碼登錄第三方網站功能(原理和代碼),避免做微信登錄開發(fā)的朋友們少走彎路2022-12-12
MyBatis實現(xiàn)插入大量數(shù)據(jù)方法詳解
最近在公司項目開發(fā)中遇到批量數(shù)據(jù)插入或者更新,下面這篇文章主要給大家介紹了關于MyBatis實現(xiàn)批量插入的相關資料,需要的朋友可以參考下2022-11-11
Java中import java.util.Scanner的用處詳解
文章主要介紹Java中的Scanner類及其常用方法next()和nextLine()的區(qū)別,next()方法在遇到空格、Tab鍵、回車鍵等分隔符時結束輸入,而nextLine()方法則接收所有輸入,直到遇到回車鍵2024-11-11
JDK1.6“新“特性Instrumentation之JavaAgent(推薦)
這篇文章主要介紹了JDK1.6“新“特性Instrumentation之JavaAgent,本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2020-08-08
SpringMVC中使用bean來接收form表單提交的參數(shù)時的注意點
本篇文章主要介紹了SpringMVC中使用bean來接收form表單提交的參數(shù)時的注意點,具有很好的參考價值。下面跟著小編一起來看下吧2017-05-05
SpringBoot3 Spring WebFlux簡介(推薦)
SpringWebFlux是Spring Framework 5中引入的響應式Web框架,用于支持非阻塞異步通信和響應式流處理,與傳統(tǒng)的SpringMVC相比,WebFlux提供了完全異步非阻塞的編程模型,適用高并發(fā)、微服務架構和實時數(shù)據(jù)流,本文介紹SpringBoot3 Spring WebFlux簡介,感興趣的朋友一起看看吧2024-10-10

