Spring注解——使用@ComponentScan自動(dòng)掃描組件

1.創(chuàng)建一個(gè)配置類,在配置類上添加 @ComponentScan 注解吭敢。該注解默認(rèn)會(huì)掃描該類所在的包下所有的配置類,相當(dāng)于之前的 <context:component-scan>。

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;

@ComponentScan
public class BeanConfig {

}

2.使用 ApplicationContext 的 getBeanDefinitionNames() 方法獲取已經(jīng)注冊(cè)到容器中的 bean 的名稱质帅。

import io.mieux.config.BeanConfig;
import org.springframework.context.ApplicationContext;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class App02 {
    public static void main(String[] args) {
        ApplicationContext applicationContext =
                new AnnotationConfigApplicationContext(BeanConfig.class);

        String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames();
        for (String beanName : beanDefinitionNames) {
            System.out.println("beanName: " + beanName);
        }
    }
}

運(yùn)行效果:

beanName: org.springframework.context.annotation.internalConfigurationAnnotationProcessor
beanName: org.springframework.context.annotation.internalAutowiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalRequiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalCommonAnnotationProcessor
beanName: org.springframework.context.event.internalEventListenerProcessor
beanName: org.springframework.context.event.internalEventListenerFactory
beanName: beanConfig

除了 spring 本身注冊(cè)的一些 bean 之外,可以看到最后一行留攒,已經(jīng)將 BeanConfig 這個(gè)類注冊(cè)進(jìn)容器中了煤惩。

3.指定要掃描的包(使用@ComponentScan 的 valule 屬性來(lái)配置),創(chuàng)建一個(gè)controller 包炼邀,并在該包下新建一個(gè) AppController 類魄揉。

package io.mieux.controller;

import org.springframework.stereotype.Controller;

@Controller
public class AppController {
}

在類上加了@Controller注解,說(shuō)明該類是一個(gè) Component拭宁。在 BeanConfig 類中修改:

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;

@ComponentScan(value = "io.mieux.controller")
public class BeanConfig {

}

在 @ComponentScan 注解中指定了要掃描的包洛退。

運(yùn)行效果:

beanName: org.springframework.context.annotation.internalConfigurationAnnotationProcessor
beanName: org.springframework.context.annotation.internalAutowiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalRequiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalCommonAnnotationProcessor
beanName: org.springframework.context.event.internalEventListenerProcessor
beanName: org.springframework.context.event.internalEventListenerFactory
beanName: beanConfig
beanName: appController

AppController 已經(jīng)被注冊(cè)進(jìn)容器了。

4.excludeFilters 和 includeFilters 的使用

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

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;

@ComponentScan(value = "io.mieux",
        excludeFilters = {@Filter(type = FilterType.ANNOTATION,
        value = {Controller.class})})
public class BeanConfig {

}

excludeFilters 的參數(shù)是一個(gè) Filter[] 數(shù)組兵怯,然后指定 FilterType 的類型為 ANNOTATION,也就是通過(guò)注解來(lái)過(guò)濾腔剂,最后的 value 則是Controller 注解類媒区。配置之后,在 spring 掃描的時(shí)候掸犬,就會(huì)跳過(guò) io.mieux 包下袜漩,所有被 @Controller 注解標(biāo)注的類。

使用 includeFilters 來(lái)按照規(guī)則只包含某些包的掃描湾碎。

在創(chuàng)建一個(gè) service 的包宙攻,并創(chuàng)建一個(gè) AppService 類,再加上一個(gè) @Service 注解介褥。

package io.mieux.service;

import org.springframework.stereotype.Service;

@Service
public class AppService {
}

修改 BeanCofig 類:

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;

@ComponentScan(value = "io.mieux", includeFilters = {@Filter(type = FilterType.ANNOTATION, classes = {Controller.class})})
public class BeanConfig {

}

運(yùn)行效果:

beanName: org.springframework.context.annotation.internalConfigurationAnnotationProcessor
beanName: org.springframework.context.annotation.internalAutowiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalRequiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalCommonAnnotationProcessor
beanName: org.springframework.context.event.internalEventListenerProcessor
beanName: org.springframework.context.event.internalEventListenerFactory
beanName: beanConfig
beanName: appController
beanName: appService

配置里面座掘,應(yīng)該是只包含 @Controller 注解的類才會(huì)被注冊(cè)到容器中,為什么 @Service 注解的類也被注冊(cè)了呢呻顽?這里涉及到 @ComponentScan 的一個(gè) useDefaultFilters 屬性的用法雹顺,該屬性默認(rèn)值為 true,也就是說(shuō) spring 默認(rèn)會(huì)自動(dòng)發(fā)現(xiàn)被 @Component廊遍、@Repository嬉愧、@Service 和 @Controller 標(biāo)注的類,并注冊(cè)進(jìn)容器中喉前。要達(dá)到只包含某些包的掃描效果没酣,就必須將這個(gè)默認(rèn)行為給禁用掉(在 @ComponentScan 中將 useDefaultFilters 設(shè)為 false 即可)王财。

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;

@ComponentScan(value = "io.mieux", 
        includeFilters = {@Filter(type = FilterType.ANNOTATION, classes = {Controller.class})},
        useDefaultFilters = false)
public class BeanConfig {

}

運(yùn)行效果:

beanName: org.springframework.context.annotation.internalConfigurationAnnotationProcessor
beanName: org.springframework.context.annotation.internalAutowiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalRequiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalCommonAnnotationProcessor
beanName: org.springframework.context.event.internalEventListenerProcessor
beanName: org.springframework.context.event.internalEventListenerFactory
beanName: beanConfig
beanName: appController

5.添加多種掃描規(guī)則

1、如果使用的 jdk8裕便,則可以直接添加多個(gè) @ComponentScan 來(lái)添加多個(gè)掃描規(guī)則绒净,但是在配置類中要加上 @Configuration 注解,否則無(wú)效偿衰。

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;

@ComponentScan(value = "io.mieux.controller")
@ComponentScan(value = "io.mieux.service")
@Configuration
public class BeanConfig {

}

2挂疆、也可以使用 @ComponentScans 來(lái)添加多個(gè) @ComponentScan,從而實(shí)現(xiàn)添加多個(gè)掃描規(guī)則下翎。同樣缤言,也需要加上 @Configuration 注解,否則無(wú)效视事。

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScans;
import org.springframework.context.annotation.Configuration;

@ComponentScans(value = 
        {@ComponentScan(value = "io.mieux.controller"),
        @ComponentScan(value = "io.mieux.service")})
@Configuration
public class BeanConfig {

}

6.添加自定義過(guò)濾規(guī)則

在前面使用過(guò) @Filter 注解胆萧,里面的 type 屬性是一個(gè) FilterType 的枚舉類型:

public enum FilterType {

    ANNOTATION,
    ASSIGNABLE_TYPE,
    ASPECTJ,
    REGEX,
    CUSTOM

}

使用 CUSTOM 類型,就可以實(shí)現(xiàn)自定義過(guò)濾規(guī)則俐东。

1跌穗、 首先創(chuàng)建一個(gè)實(shí)現(xiàn) TypeFilter 接口的 CustomTypeFilter 類,并實(shí)現(xiàn)其 match 方法虏辫。

package io.mieux.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;

public class CustomTypeFilter implements TypeFilter {
    @Override
    public boolean match(MetadataReader metadataReader,
                         MetadataReaderFactory metadataReaderFactory) throws IOException {

        // 獲取當(dāng)前掃描到的類的注解元數(shù)據(jù)
        AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
        // 獲取當(dāng)前掃描到的類的元數(shù)據(jù)
        ClassMetadata classMetadata = metadataReader.getClassMetadata();
        // 獲取當(dāng)前掃描到的類的資源信息
        Resource resource = metadataReader.getResource();

        if (classMetadata.getClassName().contains("Co")) {
            return true;
        }

        return false;
    }
}

這里簡(jiǎn)單對(duì)掃描到的類名進(jìn)行判斷蚌吸,如果類名包含”Co“的就符合條件,也就會(huì)注入到容器中乒裆。

2套利、對(duì) BeanConfig 進(jìn)行修改,指定過(guò)濾類型為 Custom 類型鹤耍,并指定 value 為 CustomTypeFilter.class。

package io.mieux.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.FilterType;

@ComponentScan(value = "io.mieux",
        includeFilters = {@ComponentScan.Filter(type = FilterType.CUSTOM, value = {CustomTypeFilter.class})},
        useDefaultFilters = false)
public class BeanConfig {

}

運(yùn)行效果:

beanName: org.springframework.context.annotation.internalConfigurationAnnotationProcessor
beanName: org.springframework.context.annotation.internalAutowiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalRequiredAnnotationProcessor
beanName: org.springframework.context.annotation.internalCommonAnnotationProcessor
beanName: org.springframework.context.event.internalEventListenerProcessor
beanName: org.springframework.context.event.internalEventListenerFactory
beanName: beanConfig
beanName: appController
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末验辞,一起剝皮案震驚了整個(gè)濱河市稿黄,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌跌造,老刑警劉巖杆怕,帶你破解...
    沈念sama閱讀 218,755評(píng)論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異壳贪,居然都是意外死亡陵珍,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門违施,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)互纯,“玉大人,你說(shuō)我怎么就攤上這事磕蒲×袅剩” “怎么了只盹?”我有些...
    開封第一講書人閱讀 165,138評(píng)論 0 355
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)兔院。 經(jīng)常有香客問(wèn)我殖卑,道長(zhǎng),這世上最難降的妖魔是什么坊萝? 我笑而不...
    開封第一講書人閱讀 58,791評(píng)論 1 295
  • 正文 為了忘掉前任孵稽,我火速辦了婚禮,結(jié)果婚禮上十偶,老公的妹妹穿的比我還像新娘菩鲜。我一直安慰自己,他們只是感情好扯键,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,794評(píng)論 6 392
  • 文/花漫 我一把揭開白布睦袖。 她就那樣靜靜地躺著,像睡著了一般荣刑。 火紅的嫁衣襯著肌膚如雪馅笙。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,631評(píng)論 1 305
  • 那天厉亏,我揣著相機(jī)與錄音董习,去河邊找鬼。 笑死爱只,一個(gè)胖子當(dāng)著我的面吹牛皿淋,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播恬试,決...
    沈念sama閱讀 40,362評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼窝趣,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了训柴?” 一聲冷哼從身側(cè)響起哑舒,我...
    開封第一講書人閱讀 39,264評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎幻馁,沒想到半個(gè)月后洗鸵,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,724評(píng)論 1 315
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡仗嗦,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,900評(píng)論 3 336
  • 正文 我和宋清朗相戀三年膘滨,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片稀拐。...
    茶點(diǎn)故事閱讀 40,040評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡火邓,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情贡翘,我是刑警寧澤蹈矮,帶...
    沈念sama閱讀 35,742評(píng)論 5 346
  • 正文 年R本政府宣布,位于F島的核電站鸣驱,受9級(jí)特大地震影響泛鸟,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜踊东,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,364評(píng)論 3 330
  • 文/蒙蒙 一北滥、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧闸翅,春花似錦再芋、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至记某,卻和暖如春司训,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背液南。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評(píng)論 1 270
  • 我被黑心中介騙來(lái)泰國(guó)打工壳猜, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人滑凉。 一個(gè)月前我還...
    沈念sama閱讀 48,247評(píng)論 3 371
  • 正文 我出身青樓统扳,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親畅姊。 傳聞我的和親對(duì)象是個(gè)殘疾皇子咒钟,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,979評(píng)論 2 355