詳解Spring系列之@ComponentScan自動掃描元件

2022-06-14 14:01:28

無註解方式component-scan使用

之前，我們需要掃描工程下一些類上所標註的註解，這些常用註解有：

@Controller,@Service,@Component,@Repository

通過在Spring的組態檔中設定<context:component-scan>掃描對應包下掃描這些註解的方式：

<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:p="http://www.springframework.org/schema/p"
	xmlns:context="http://www.springframework.org/schema/context"
	xsi:schemaLocation="http://www.springframework.org/schema/beans
         http://www.springframework.org/schema/beans/spring-beans.xsd
         http://www.springframework.org/schema/context  
         http://www.springframework.org/schema/context/spring-context-2.5.xsd">
    <!--@Controller,@Service,@Component,@Repository-->
	<context:component-scan base-package="com.jektong.spring"/>
</beans>

註解方式@ComponentScan使用

建三個類，依次將

@Controller，@Repository，@Service,標註這些類：

圖1

現在通過使用註解@ComponentScan的方式來掃描所在包下面的這些類：之前定義的PersonConfig修改：

package com.jektong.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import com.jektong.spring.Person;
@Configuration
@ComponentScan("com.jektong")
public class PersonConfig {
	@Bean("person01")
	public Person person() {
		return new Person("李四",21);
	}
}

測試，看是否掃描到這些註解所標註的類：PersonTest.java

@Test
public  void test02() {
	ApplicationContext ac = new AnnotationConfigApplicationContext(PersonConfig.class);
	Person bean = ac.getBean(Person.class);
	System.out.println(bean);
	String[] beanDefinitionNames = ac.getBeanDefinitionNames();
	for (String string : beanDefinitionNames) {
		System.out.println(string);
	}
}

測試效果：除了Spring要自動載入的設定類以外也顯示了剛才新增的設定類：

圖2

為何會出現PersonConfig,因為@Configuration本身就是@Component註解的：

圖3

@ComponentScan的掃描規則

如果需要指定設定類的掃描規則,@ComponentScan提供對應的掃描方式@Filter進行設定類的過濾：

// 掃描包的時候只規定掃描一些註解設定類。
Filter[] includeFilters() default {};
// 掃描包的時候可以排除一些註解設定類。 
Filter[] excludeFilters() default {};

Filter其實也是一個註解，相當於@ComponentScan的子註解，可以看圖4：

圖4

Filter對應的過濾規則如下:

第一種：掃描包的時候只規定掃描一些註解設定類【includeFilters】。

使用這個includeFilters過濾規則，必須解除預設的過濾規則，

使用【useDefaultFilters = false】：

package com.jektong.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import com.jektong.spring.Person;
@Configuration
@ComponentScan(value = "com.jektong",includeFilters  = {
		@Filter(type = FilterType.ANNOTATION,value= {Controller.class})
},useDefaultFilters = false )
public class PersonConfig {
	@Bean("person01")
	public Person person() {
		return new Person("李四",21);
	}
}

這樣就只會掃描用@Controller,標註的設定類交給Spring容器中了：

圖5

第二種：掃描包的時候可以排除一些註解設定類【excludeFilters】。

圖6

@Filter看上圖，有5種不同型別的過濾策略。拿第一種舉例，我們需要過濾使用@Controller註解的設定類：

package com.jektong.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import com.jektong.spring.Person;
@Configuration
@ComponentScan(value = "com.jektong",excludeFilters = {
		@Filter(type = FilterType.ANNOTATION,value= {Controller.class})
} )
public class PersonConfig {
	@Bean("person01")
	public Person person() {
		return new Person("李四",21);
	}
}

測試看一下發現圖2中的personController不會交給Spring容器去管理了：

圖7

上面的圖6展示出5種不同型別的過濾策略，上面介紹了註解型別（FilterType.ANNOTATION），還有四種：

重點看一下CUSTOM自定義掃描策略。

從原始碼看，自定義掃描註解型別需要實現TypeFilter介面,下面就寫一個實現類MyFilter.java:在實現類中可以自定義設定規則：

package com.jektong.config;
import java.io.IOException;
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;
public class MyFilter implements TypeFilter {
	@Override
	public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
			throws IOException {
		// 檢視當前類的註解。
		AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
		// 檢視當前掃描類的資訊
		ClassMetadata classMetadata = metadataReader.getClassMetadata();
		// 獲取當前類資源
		Resource resource = metadataReader.getResource();
		String className = classMetadata.getClassName();
		System.out.println("className===>" + className);
		// 只要類名包含er則註冊Spring容器
		if(className.contains("er")) {
			return true;
		}
		return false;
	}
}

測試：

PersonConfig 中進行掃描：

package com.jektong.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import com.jektong.service.PersonService;
import com.jektong.spring.Person;
@Configuration
@ComponentScan(value = "com.jektong",includeFilters  = {
		@Filter(type = FilterType.CUSTOM,value= {MyFilter.class})
},useDefaultFilters = false )
public class PersonConfig {
	@Bean("person01")
	public Person person() {
		return new Person("李四",21);
	}
}

可以看出掃描出包下面的類只要帶“er”的全部掃描出來，並設定給Spring容器：

ASSIGNABLE_TYPE：按照指定的型別去載入對應設定類：

package com.jektong.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.ComponentScan.Filter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.FilterType;
import org.springframework.stereotype.Controller;
import com.jektong.service.PersonService;
import com.jektong.spring.Person;
@Configuration
@ComponentScan(value = "com.jektong",includeFilters  = {
		@Filter(type = FilterType.ASSIGNABLE_TYPE,value= {PersonService.class})
},useDefaultFilters = false )
public class PersonConfig {
	@Bean("person01")
	public Person person() {
		return new Person("李四",21);
	}
}

儘管我們將PersonService.java上的註解去掉，使用ASSIGNABLE_TYPE依然會載入出來（自行測試）。

ASPECTJ與REGEX基本不用，不用瞭解。

以上就是@ComponentScan的具體用法，該興趣的話可以看一下原始碼。

到此這篇關於詳解Spring系列之@ComponentScan自動掃描元件的文章就介紹到這了,更多相關Spring @ComponentScan內容請搜尋it145.com以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援it145.com！

詳解Spring系列之@ComponentScan自動掃描元件

目錄

無註解方式component-scan使用

註解方式@ComponentScan使用

@ComponentScan的掃描規則

熱門文章