Spring中的@ComponentScan注解使用詳解
基本使用
@ComponentScan 注解的作用就是根據(jù)指定的掃描路徑,把路徑中符合掃描規(guī)則的類裝配到 Spring 容器中。
加入依賴
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>5.1.8.RELEASE</version> </dependency>
配置啟動(dòng)類,使用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); } } }
運(yùn)行結(jié)果:
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 本身注冊(cè)的一些 bean 之外, AppMain這個(gè)類也注冊(cè)進(jìn)了容器中。
上述的使用方式,在沒什么特殊的要求下,在實(shí)際工作當(dāng)中完全滿足項(xiàng)目的開發(fā)。@ComponentScan注解還有其他好用的功能,我們有必要了解并會(huì)使用。
@ComponentScan注解與XML文件中的context:component-scan標(biāo)簽等效。
<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 {}; // 掃描帶注解的包路徑,默認(rèn)是@Component @AliasFor("value") String[] basePackages() default {}; // 掃描指定帶注解的類,同時(shí)會(huì)掃描該類所在的包,默認(rèn)是@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有四個(gè)取值 * 1.DEFAULT:默認(rèn)值,默認(rèn)情況下取no * 2.NO:不開啟代理 * 3.INTERFACES:使用jdk動(dòng)態(tài)代理 * 4.TARGET_CLASS:使用cglib代理 * 假如有一個(gè)單例beanA,其中有一個(gè)屬性B,B的Scope是session,此時(shí),容器在啟動(dòng)時(shí)創(chuàng)建A的過程中需要注入B屬性, * 但是B的scope是session,這種情況下是注入不了的(只有用戶訪問時(shí)才會(huì)創(chuàng)建),是會(huì)報(bào)錯(cuò)的 * 但是如果將B的Scope的ProxyMode屬性配置為INTERFACES或者TARGET_CLASS時(shí),那么B就會(huì)生成一個(gè)ScopedProxyFactoryBean類型的BeanDefinitionHolder * 在A注入B時(shí),就會(huì)注入一個(gè)ScopedProxyFactoryBean類型的Bean */ ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT; // 控制符合組件檢測(cè)條件的類文件,默認(rèn)是包路徑下的 **/*.class String resourcePattern() default ClassPathScanningCandidateComponentProvider.DEFAULT_RESOURCE_PATTERN; // 是否自動(dòng)檢測(cè)帶有 @Component 注解的類,默認(rèn)為 true // 像 @Repository、 @Controller、@Service、@Configuration 內(nèi)部都包含了 @Component boolean useDefaultFilters() default true; /** * 如果掃描到的類符合 includeFilters 中的過濾條件 * 這個(gè)類會(huì)被注冊(cè)到容器中 * 過濾類型與如下5種 * 1、ANNOTATION:注解類型(默認(rèn)) * 2、ASSIGNABLE_TYPE:指定類 * 3、ASPECTJ:指定表達(dá)式 * 4、REGEX:正則表達(dá)式 * 5、CUSTOM:自定義類型 */ Filter[] includeFilters() default {}; // 如果掃描到的類符合 excludeFilters 中的過濾條件 // 這個(gè)類不會(huì)被注冊(cè) Filter[] excludeFilters() default {}; // 掃描到的類是否應(yīng)延遲初始化,默認(rèn)為 false boolean lazyInit() default false; // 聲明要用作包含過濾器或排除過濾器的類型過濾器 @Retention(RetentionPolicy.RUNTIME) @Target({}) @interface Filter { // 要使用的過濾器類型,默認(rèn)為 ANNOTATION FilterType type() default FilterType.ANNOTATION; // classes 的別名 @AliasFor("classes") Class<?>[] value() default {}; /** * 作用同上面的 value 相同 * 過濾器的參數(shù),參數(shù)必須為class數(shù)組 * 只能用于 ANNOTATION 、ASSIGNABLE_TYPE 、CUSTOM 這三個(gè)類型 * ANNOTATION:參數(shù)為注解類,比如:Controller.class * ASSIGNABLE_TYPE:參數(shù)為類,如 UserServiceImpl.class * CUSTOM:參數(shù)為實(shí)現(xiàn) TypeFilter 接口的類 ,如 MyTypeFilter.class * 實(shí)現(xiàn)了TypeFilter 接口的類,還能實(shí)現(xiàn) EnvironmentAware,BeanFactoryAware, BeanClassLoaderAware,ResourceLoaderAware 這四個(gè)回調(diào)接口 * 它們各自的方法將在 TypeFilter#match 之前被調(diào)用 */ @AliasFor("value") Class<?>[] classes() default {}; //這個(gè)屬性主要用于 ASPECTJ 類型和 REGEX 類型 String[] pattern() default {}; } }
接下來使用一下幾個(gè)重要屬性。
實(shí)踐
basePackageClasses
創(chuàng)建 ProductServiceImpl、UserServiceImpl兩個(gè)類,并放在 impl包下。整體包結(jié)構(gòu)如下:
類中內(nèi)容如下:
ProductServiceImpl類中包含 @Configuration注解
@Configuration public class ProductServiceImpl { }
UserServiceImpl則是普通類
public class UserServiceImpl { }
在ComponentScan注解增加 basePackageClasses的屬性,指定 UserServiceImpl。上面講過basePackageClasses會(huì)掃描指定帶注解的類,同時(shí)會(huì)掃描該類所在的包。
@ComponentScan(basePackages = "com.cxyxj.componentscan.app",basePackageClasses = {UserServiceImpl.class})
啟動(dòng)結(jié)果
由于指定的 UserServiceImpl上面沒有注解,所以沒被加入容器中。
useDefaultFilters
useDefaultFilters 的值默認(rèn)為 true,也就是默認(rèn)會(huì)往 includeFilters中添加一個(gè)為 @Component注解類型的過濾器。這時(shí)我們將 useDefaultFilters的值修改為 false ,這會(huì)掃描出來幾個(gè)類呢?
@ComponentScan(basePackages = "com.cxyxj.componentscan.app",basePackageClasses = {UserServiceImpl.class},useDefaultFilters = false)
啟動(dòng)結(jié)果
答案是一個(gè)都沒有,請(qǐng)忽略 AppMain ,這相當(dāng)于是我們手動(dòng)調(diào)用 context.register(AppMain.class)進(jìn)行注冊(cè)的。
includeFilters
我們想把 ProductServiceImpl掃描出來,需要怎么做呢?
ANNOTATION
修改 @ComponentScan的值,增加 includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Configuration.class},指定 value 的值為 @Configuration。
這代表著只要掃描到的類中包含 @Configuration注解,就會(huì)被注冊(cè)到容器中。一般我們自定義的注解就可以結(jié)合該方式。
@ComponentScan(basePackages = "com.cxyxj.componentscan.app", basePackageClasses = {UserServiceImpl.class}, useDefaultFilters = false, includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION,value = {Configuration.class}) )
啟動(dòng)結(jié)果
ASSIGNABLE_TYPE
將 UserServiceImpl加入到容器中,但是它是一個(gè)普普通通的類,這時(shí)可以使用 ASSIGNABLE_TYPE。
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,value = {UserServiceImpl.class})
啟動(dòng)結(jié)果
ASPECTJ
如果覺得一個(gè)一個(gè)的加入比較麻煩,可以使用 ASPECTJ表達(dá)式的方式。
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.ASPECTJ,pattern = {"com.cxyxj.componentscan.impl.*"})
啟動(dòng)結(jié)果
如果啟動(dòng)報(bào)錯(cuò)需要加入 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能達(dá)到效果的是 REGEX,使用正則表達(dá)式進(jìn)行匹配。需要注意的是進(jìn)行匹配的值是類的全限定名,比如:com.cxyxj.componentscan.impl.UserServiceImpl。
includeFilters 值修改如下:
includeFilters = @ComponentScan.Filter(type = FilterType.REGEX,pattern = {"[A-Za-z.]+Impl$"})
啟動(dòng)結(jié)果
CUSTOM
如果覺得上述幾種方式都不滿足需求,我們可以進(jìn)行自定義過濾規(guī)則。
創(chuàng)建 CustomTypeFilter 類,并實(shí)現(xiàn) TypeFilter接口,重寫其 match方法。
public class CustomTypeFilter implements TypeFilter { /** * * @param metadataReader:可以獲得當(dāng)前正在掃描的類的信息 * @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})
啟動(dòng)結(jié)果
通過自定義過濾規(guī)則的掃描,只有 UserServiceImpl符合。
excludeFilters 的使用方式與 includeFilters一致。只不過 excludeFilters是排除而已。
到此這篇關(guān)于Java中的@ComponentScan注解使用詳解的文章就介紹到這了,更多相關(guān)@ComponentScan注解使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Java中Druid連接池連接超時(shí)獲取不到連接的解決
這篇文章主要介紹了Java中Druid連接池連接超時(shí)獲取不到連接的解決,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2020-11-11Java實(shí)現(xiàn)的計(jì)時(shí)器【秒表】功能示例
這篇文章主要介紹了Java實(shí)現(xiàn)的計(jì)時(shí)器【秒表】功能,結(jié)合實(shí)例形式分析了Java結(jié)合JFrame框架的計(jì)時(shí)器功能相關(guān)操作技巧,需要的朋友可以參考下2019-02-02java實(shí)現(xiàn)微信掃碼登錄第三方網(wǎng)站功能(原理和代碼)
為避免繁瑣的注冊(cè)登陸,很多平臺(tái)和網(wǎng)站都會(huì)實(shí)現(xiàn)三方登陸的功能,增強(qiáng)用戶的粘性。這篇文章主要介紹了java實(shí)現(xiàn)微信掃碼登錄第三方網(wǎng)站功能(原理和代碼),避免做微信登錄開發(fā)的朋友們少走彎路2022-12-12MyBatis實(shí)現(xiàn)插入大量數(shù)據(jù)方法詳解
最近在公司項(xiàng)目開發(fā)中遇到批量數(shù)據(jù)插入或者更新,下面這篇文章主要給大家介紹了關(guān)于MyBatis實(shí)現(xiàn)批量插入的相關(guān)資料,需要的朋友可以參考下2022-11-11Java中import java.util.Scanner的用處詳解
文章主要介紹Java中的Scanner類及其常用方法next()和nextLine()的區(qū)別,next()方法在遇到空格、Tab鍵、回車鍵等分隔符時(shí)結(jié)束輸入,而nextLine()方法則接收所有輸入,直到遇到回車鍵2024-11-11JDK1.6“新“特性Instrumentation之JavaAgent(推薦)
這篇文章主要介紹了JDK1.6“新“特性Instrumentation之JavaAgent,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-08-08SpringMVC中使用bean來接收form表單提交的參數(shù)時(shí)的注意點(diǎn)
本篇文章主要介紹了SpringMVC中使用bean來接收form表單提交的參數(shù)時(shí)的注意點(diǎn),具有很好的參考價(jià)值。下面跟著小編一起來看下吧2017-05-05SpringBoot3 Spring WebFlux簡(jiǎn)介(推薦)
SpringWebFlux是Spring Framework 5中引入的響應(yīng)式Web框架,用于支持非阻塞異步通信和響應(yīng)式流處理,與傳統(tǒng)的SpringMVC相比,WebFlux提供了完全異步非阻塞的編程模型,適用高并發(fā)、微服務(wù)架構(gòu)和實(shí)時(shí)數(shù)據(jù)流,本文介紹SpringBoot3 Spring WebFlux簡(jiǎn)介,感興趣的朋友一起看看吧2024-10-10