Spring注解@ComponentScan注解的过滤规则

阅读数:214 评论数:0

跳转到新版页面

分类

python/Java

正文

一、@ComponentScan注解

@Component只写入value，可扫描路径下装配的@Controller、@Service、@Repository。

1、常用属性

basePackages和value	指定要扫描的路径(`package`)，如果为空则以`@ComponentScan`注解的类所在的包为基本的扫描路径。
basePackageClasses	指定具体扫描的类指定具体扫描的类指定具体扫描的类女
includeFilters	指定满足`Filter`条件的类
excludeFilters	指定排除`Filter`条件的类
useDefaultFilters=true/false	指定是否需要使用`Spring`默认的扫描规则：被`@Component, @Repository, @Service, @Controller`或者已经声明过`@Component`自定义注解标记的组件

2、过滤规则 filter

（1）FilterTye.ANNOTATION

按照注解进行包含或者排除，例如使用@ComponentScan注解进行包扫描时，如果扫描包含了注解@Controller注解的组件。

@ComponentScan(value="com.meimeixia", includeFilters={
		/*
		 * type：指定扫描的规则，这里按照注解进行扫描
		 * classes：我们需要Spring在扫描时，只处理@Controller注解标注的类
		 */
		@Filter(type=FilterType.ANNOTATION, classes={Controller.class})
}, useDefaultFilters=false) // value指定要扫描的包

（2）FilterType.ASSIGNABLE_TYPE

按照给定的类型进行包含或排除，例如保处理BookService类或子类

@ComponentScan(value="com.meimeixia", includeFilters={
		// 只要是BookService这种类型的组件都会被加载到容器中，不管是它的子类还是什么它的实现类。记住，只要是BookService这种类型的
		@Filter(type=FilterType.ASSIGNABLE_TYPE, classes={BookService.class})
}, useDefaultFilters=false) // value指定要扫描的包

（3）FilterType.ASPECT

按照ASPECT表达式进行包含或者排除，这种过滤规则基本上不怎么用！

@ComponentScan(value="com.meimeixia", includeFilters={
		@Filter(type=FilterType.ASPECTJ, classes={AspectJTypeFilter.class})
}, useDefaultFilters=false) // value指定要扫描的包

（4）FilterType.REGEX

按照正则表达式进行包含或者排除。

@ComponentScan(value="com.meimeixia", includeFilters={
		@Filter(type=FilterType.REGEX, classes={RegexPatternTypeFilter.class})
}, useDefaultFilters=false) // value指定要扫描的包

（5）FilterType.CUSTOM

如果实现自定义规则进行过滤时，自定义规则的类必须是org.springframework.core.type.filter.TypeFilter接口的实现类。

package com.meimeixia.config;

import java.io.IOException;

import org.springframework.core.type.classreading.MetadataReader;
import org.springframework.core.type.classreading.MetadataReaderFactory;
import org.springframework.core.type.filter.TypeFilter;

public class MyTypeFilter implements TypeFilter {

	/**
	 * 参数：
	 * metadataReader：读取到的当前正在扫描的类的信息
	 * metadataReaderFactory：可以获取到其他任何类的信息的（工厂）
	 */
	@Override
	public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {
	
		return false; // 这儿我们先让其返回false

	}

}

当返回true时，表示符合规则，会包含在Spring容器中；当返回false时，表示不符合规则，那就是一个都不匹配，自然就都不会被包含在Spring容器中。

@ComponentScan(value="com.meimeixia", includeFilters={
		// 指定新的过滤规则，这个过滤规则是我们自个自定义的，过滤规则就是由我们这个自定义的MyTypeFilter类返回true或者false来代表匹配还是没匹配
		@Filter(type=FilterType.CUSTOM, classes={MyTypeFilter.class})
}, useDefaultFilters=false) // value指定要扫描的包

二、@ComponentScans

可以一次声明多个@ComponentScan.

@ComponentScans(value = { @ComponentScan(value = "com.example.test"),
		@ComponentScan(value = "com.example.test", includeFilters = {
				@Filter(type = FilterType.CUSTOM, value = MtyTypeFilter.class) }) })
public class MainConfig {
 
	@Bean(name = "pers", initMethod = "init", destroyMethod = "destory")
	public Person person() {
		return new Person();
	}
 
}