使用@ComponentScan注解自定义扫描规则

朴灿烈づ我的快乐病毒、 2023-10-08 08:37 78阅读 0赞

### 一、注解使用 ###

**1.作用**

@ComponentScan：会自动扫描包路径下面的所有标注有@Controller、@Service、@Repository、@Component 的类。

**可配置自定义扫描规则。**

**2.可配置属性：**

*  value指定扫描的包。
 *  includeFilters 哪些类需要过滤。
 *  excludeFilters 哪些类不用过滤。
 *  useDefaultFilters 默认的过滤规则是开启的，即useDefaultFilters=true。使用自定义扫描规则需要关闭默认的过滤规则。

**3.@Filter**

*  通过配置type即可指定按哪种类型过滤。type即FilterType，这是一个枚举类。可供选择的有五项。

public enum FilterType {
        //按照注解方式
    	ANNOTATION,
        
        //按照指定类型
    	ASSIGNABLE_TYPE,
        
        //使用ASPECTJ表达式指定
    	ASPECTJ,
        
        //使用正则表达式进行指定
    	REGEX,
        
        //自己实现TypeFilter接口，使用自定义规则
    	CUSTOM
    }

*  classes 为一个数组，里面填写指定过滤条件的类。

### 二、代码示例 ###

package com.evan.component.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;
    import org.springframework.stereotype.Repository;
    import org.springframework.stereotype.Service;
    
    // @ComponentScan("包路径") 会自动扫描包路径下面的所有@Controller、@Service、@Repository、@Component 的类
    // includeFilters 指定哪些类需要过滤。
    // excludeFilters 指定哪些类不需要过滤。
    // @Filter的type指定过滤的类型，classes指定的扫描的规则类。
    @ComponentScan(value = "com.evan.component",
    		includeFilters = {
    				@Filter(type = FilterType.ANNOTATION, classes = {Service.class}),
    				@Filter(type = FilterType.ANNOTATION, classes = {Controller.class}),
    				@Filter(type = FilterType.CUSTOM,classes = {EvanTypeFilter.class})
    		},
    		excludeFilters = {
    				@Filter(type = FilterType.ANNOTATION, classes = {Repository.class}),
    		},useDefaultFilters = false)
    public class MyConfig {
    
    }

package com.evan.component.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;
    
    
    public class EvanTypeFilter implements TypeFilter {
    	@Override
    	public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) {
    		//获取当前类注解的信息
    		AnnotationMetadata annotationMetadata = metadataReader.getAnnotationMetadata();
    		//获取当前正在扫描的类信息
    		ClassMetadata classMetadata = metadataReader.getClassMetadata();
    		//获取当前类资源(类的路径)
    		Resource resource = metadataReader.getResource();
    
    		String className = classMetadata.getClassName();
    		System.out.println("当前扫描的类："+className);
    		//当类的类名以EvanTest开始，则匹配成功,返回true
    		//excludeFilters返回true，会被过滤掉
    		//includeFilters返回true，会通过
    		if (className.contains("EvanTest")) {
    			return true;
    		}
    		return false;
    	}
    }

package com.evan.component.controller;
    
    import org.springframework.stereotype.Controller;
    
    @Controller
    public class EvanController {
    }

package com.evan.component.service;
    
    import org.springframework.stereotype.Service;
    
    @Service
    public class EvanService {
    
    }

package com.evan.component.service;
    
    import org.springframework.stereotype.Service;
    
    @Service
    public class PersonService {
    }

package com.evan.component.service;
    
    public class EvanTestService {
    }

package com.evan.component.repository;
    
    import org.springframework.stereotype.Repository;
    
    @Repository
    public class EvanRepository {
    }

**测试类：**

package com.evan.component.test;
    
    import com.evan.component.config.MyConfig;
    import org.springframework.context.annotation.AnnotationConfigApplicationContext;
    
    public class Test {
    	public static void main(String[] args) {
    		AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(MyConfig.class);
    	}
    
    }

#### **测试结果：** ####

**这里我们通过源码去看一下，spring扫描到了哪些类。**

**这里我们看到，扫描到了4个类，包含了我们自己定义的EvanTestService，使用自定义过滤规则扫描到。**

**后续我会写一篇，从源码角度分析@ComponentScan注解的博客，这里先记录一下。**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ldmFud2FuZy5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70][]

#### 三、useDefaultFilters = false ####

现在com.evan.component.service下，有2个带@Service注解的类，1个带@Component注解的类，如下图所示。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ldmFud2FuZy5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1][]

现在我只想扫描出带@Service注解的类。

如果要实现这个需求，需要将useDefaultFilters = false.

**原因：**

首先，默认的扫描规则是扫描所有带有@Compontent注解的类。

**有的人可能会问，那PersonService类和EvanService上没有@Component注解啊？**

其实@Component,@Controller,@Service和@Repository三者功能相同,后三个注解是为了对应后端代码的三层结构由第一个注解"复制"而来的.查看源码可以发现,后三个注解上面都有一个@Component.

也就是说@Controller,@Service和@Repository除了是它们自己,也是一个@Component  
在进行includeFilters过滤时,如果useDefaultFilters =true,它会默认把所有包含@Component注解的类都进行扫描

因此只有加上useDefaultFilters=false，告诉spring我们不使用默认的扫描规则，才能实现。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ldmFud2FuZy5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20191022004920941.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ldmFud2FuZy5ibG9nLmNzZG4ubmV0,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ldmFud2FuZy5ibG9nLmNzZG4ubmV0_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20191022015821786.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ldmFud2FuZy5ibG9nLmNzZG4ubmV0,size_16,color_FFFFFF,t_70