在Spring注解驱动开发系列-注册组件的方式中有提到过@ComponentScan，但是只是一个简单的用法，在这篇记录文中会涉及到过滤和排除哪些组件。
一、看看@ComponentScan的定义
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
@Documented
@Repeatable(ComponentScans.class)
public @interface ComponentScan {
/**
对应的包扫描路径 可以是单个路径，也可以是扫描的路径数组
*/
@AliasFor("basePackages")
String[] value() default {};
/**
和value一样是对应的包扫描路径 可以是单个路径，也可以是扫描的路径数组
*/
@AliasFor("value")
String[] basePackages() default {};
/**
指定具体的扫描的类
*/
Class[] basePackageClasses() default {};
/**
对应的bean名称的生成器 默认的是BeanNameGenerator
*/
Class nameGenerator() default BeanNameGenerator.class;
/**
处理检测到的bean的scope范围
*/
Class scopeResolver() default AnnotationScopeMetadataResolver.class;
/**
是否为检测到的组件生成代理
*/
ScopedProxyMode scopedProxy() default ScopedProxyMode.DEFAULT;
/**
控制符合组件检测条件的类文件 默认是包扫描下的 **/*.class
*/
String resourcePattern() default ClassPathScanningCandidateComponentProvider.DEFAULT_RESOURCE_PATTERN;
/**
是否对带有@Component @Repository @Service @Controller注解的类开启检测,默认是开启的
*/
boolean useDefaultFilters() default true;
/**
指定某些定义Filter满足条件的组件 FilterType有5种类型如：
ANNOTATION, 注解类型 默认
ASSIGNABLE_TYPE,指定固定类
ASPECTJ， ASPECTJ类型
REGEX,正则表达式
CUSTOM,自定义类型
*/
Filter[] includeFilters() default {};
/**
排除某些过来器扫描到的类
*/
Filter[] excludeFilters() default {};
/**
* @since 4.1
扫描到的类是都开启懒加载 ，默认是不开启的
*/
boolean lazyInit() default false;
@Retention(RetentionPolicy.RUNTIME)
@Target({})
@interface Filter {
FilterType type() default FilterType.ANNOTATION;
@AliasFor("classes")
Class[] value() default {};
@AliasFor("value")
Class[] classes() default {};
String[] pattern() default {};
}
}
二、@ComponentScan(value="com.test")
2.1、准备工作
- 在com.test包下面，新建bean、config、controller、dao、service子包
- 在bean包下面新建一个Person 类，在类上加入@Component
- 在config包下面新建一个Config 类，在类上加入@Configurable
- 在controller包下面新建一个TenantController 类，在类上加入@Controller
- 在dao包下面新建一个TenantDao 类，在类上加入@Repository
- 在service包下面新建一个TenantService 类，在类上加入@Service
@Component
public class Person {
}
@Configurable
@ComponentScan(value = "com.test")
public class Config {
}
@Controller
public class TenantController {
}
@Repository
public class TenantDao {
}
@Service
public class TenantService {
}
image.png
2.2、在配置类中加入@ComponentScan(value = "com.test")
@Configurable
@ComponentScan(value = "com.test")
public class Config {
}
- 测试用例（获取容器中所有注册的bean）
@org.junit.Test
public void testComponentScan() {
ApplicationContext applicationContext = new AnnotationConfigApplicationContext(Config.class);
String[] definitionNames = applicationContext.getBeanDefinitionNames();
for (String name : definitionNames) {
System.out.println(name);
}
}
-
结果
image.png
三、includeFilters和excludeFilters
3.1、含义描述
Filter[] includeFilters() default {}; 指定扫描的时候只需要包含哪些组件
Filter[] excludeFilters() default {};指定扫描的时候按照什么规则排除那些组件
可以看到他们都是需要返回一个Filter[]的，所以先看看Filter的定义，需要一个FilterType 类型的type和value
@Retention(RetentionPolicy.RUNTIME)
@Target({})
@interface Filter {
FilterType type() default FilterType.ANNOTATION;
@AliasFor("classes")
Class[] value() default {};
@AliasFor("value")
Class[] classes() default {};
String[] pattern() default {};
}
public enum FilterType {
/**
按照注解
*/
ANNOTATION,
/**
按照给定的类型
*/
ASSIGNABLE_TYPE,
/**
使用ASPECTJ表达式（基本不用）
*/
ASPECTJ,
/**
使用正则指定
*/
REGEX,
/** Filter candidates using a given custom
* {@link org.springframework.core.type.filter.TypeFilter} implementation.
使用自定义规则,自定义的类需要实现TypeFilter
*/
CUSTOM
}
3.2、includeFilters的使用
主要从按照注解（ANNOTATION）、按照给定的类型（ASSIGNABLE_TYPE）和使用自定义规则（CUSTOM）三个不同过滤类型来讲解，其他两个不怎么常用的就不做记录
3.2.1、按照注解FilterType.ANNOTATION
- 在Config配置类中加上includeFilters
@ComponentScan(value = "com.test",includeFilters ={@Filter(type = FilterType.ANNOTATION,value = {Controller.class})} ) - 结果（我们可以看到明明我们只包含了@Controller注解的，为啥其他几个注解对应的组件还是被注册到容器中了呢，原因是@ComponentScan中的这个属性，
boolean useDefaultFilters() default true,可以看到默认是true，所有我们要达到只包含@Controller注解的，需要将此值设置为false）;
image.png - 修改Config配置类，增加一个useDefaultFilters = false
@ComponentScan(value = "com.test",includeFilters ={@Filter(type = FilterType.ANNOTATION,value = {Controller.class})},useDefaultFilters = false)
image.png
疑问？？这里抛一个问题，为哈config还是会被注册到容器中，只有后续看源码的时候，多注意下，有知道的童鞋欢迎赐教。
- 再次修改Config配置类，再添加一个按照@Service注解过滤
@ComponentScan(value = "com.test",includeFilters ={@Filter(type = FilterType.ANNOTATION,value = {Controller.class}), @Filter(value = Service.class)},useDefaultFilters = false) -
结果（可以看到在第二个过滤条件中没有写type = FilterType.ANNOTATION。是因为默认的就是按照注解方式）
image.png
3.2.2、按照给定的类型FilterType.ASSIGNABLE_TYPE
- 在Config配置类中加上includeFilters
@ComponentScan(value = "com.test",includeFilters ={@Filter(type = FilterType.ASSIGNABLE_TYPE,value = {TenantDao.class,Person.class})},useDefaultFilters = false) -
结果
image.png
3.2.3、使用自定义规则FilterType.CUSTOM
- 如何自定义规则类
根据FilterType中的描述可以看到,自定义规律规则类是需要实现TypeFilter接口的,此接口实现一个match方法即可
/** Filter candidates using a given custom * {@link org.springframework.core.type.filter.TypeFilter} implementation. */ CUSTOM
public interface TypeFilter {
boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
throws IOException;
}
- 自定义规则类
package com.test.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 MyTypeFilter implements TypeFilter {
/**
* metadataReader：读取到的当前正在扫描的类的信息
* metadataReaderFactory:可以获取到其他任何类信息的
*/
public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory)
throws IOException {
// TODO Auto-generated method stub
//获取当前类注解的信息
AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
//获取当前正在扫描的类的类信息
ClassMetadata classMetadata = metadataReader.getClassMetadata();
//获取当前类资源（类的路径）
Resource resource = metadataReader.getResource();
String className = classMetadata.getClassName();
System.out.println("--->"+className);
if(className.contains("er")){
return true;
}
return false;
}
}
解析
自定义类中System.out.println("--->"+className);会输出所有的注册到容器中的组件
- 配置类
@Configurable
@ComponentScan(value = "com.test",includeFilters ={@Filter(type = FilterType.CUSTOM,value = MyTypeFilter.class)},useDefaultFilters = false)
public class Config {
}
-
结果（可以看到我们最后自定义过滤是过滤掉了TenantDao）
image.png
3.3、excludeFilters的使用
其实excludeFilters和includeFilters的使用是一样的，下面就简单的给个配置类的修改和运行结果
3.3.1、按照注解FilterType.ANNOTATION
- 配置类
@Configurable
@ComponentScan(value = "com.test",excludeFilters ={@Filter(type = FilterType.ANNOTATION,value = Controller.class)})
public class Config {
}
-
结果(可以看到容器中没有@Controller注解的)
image.png
3.3.2、按照给定的类型FilterType.ASSIGNABLE_TYPE
- 配置类
@Configurable
@ComponentScan(value = "com.test",excludeFilters ={@Filter(type = FilterType.ASSIGNABLE_TYPE,value = TenantService.class)})
public class Config {
}
-
结果
image.png
3.3.3、使用自定义规则FilterType.CUSTOM
- 配置类
@Configurable
@ComponentScan(value = "com.test",excludeFilters ={@Filter(type = FilterType.CUSTOM,value = MyTypeFilter.class)})
public class Config {
}
-
结果
image.png