【Spring注解驱动开发】自定义TypeFilter指定@ComponentScan注解的过滤规则(1)

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

例如，按照自定义规则进行过滤，首先，我们需要创建一个org.springframework.core.type.filter.TypeFilter接口的实现类MyTypeFilter，如下所示。

public class MyTypeFilter implements TypeFilter {

@Override

public boolean match(MetadataReader metadataReader, MetadataReaderFactory metadataReaderFactory) throws IOException {

return false;

}

}

当我们实现TypeFilter接口时，需要实现TypeFilter接口中的match()方法，match()方法的返回值为boolean类型。当返回true时，表示符合规则，会包含在Spring容器中；当返回false时，表示不符合规则，不会包含在Spring容器中。另外，在match()方法中存在两个参数，分别为MetadataReader类型的参数和MetadataReaderFactory类型的参数，含义分别如下所示。

• metadataReader：读取到的当前正在扫描的类的信息。

• metadataReaderFactory：可以获取到其他任务类的信息。

接下来，使用@ComponentScan注解进行如下配置。

@ComponentScan(value = “io.mykit.spring”, includeFilters = {

@Filter(type = FilterType.CUSTOM, classes = {MyTypeFilter.class})

}, useDefaultFilters = false)

在FilterType枚举中，ANNOTATION和ASSIGNABLE_TYPE是比较常用的，ASPECTJ和REGEX不太常用，如果FilterType枚举中的类型无法满足我们的需求时，我们也可以通过实现org.springframework.core.type.filter.TypeFilter接口来自定义过滤规则，此时，将@Filter中的type属性设置为FilterType.CUSTOM，classes属性设置为自定义规则的类对应的Class对象。

实现自定义过滤规则

---

在项目的io.mykit.spring.plugins.register.filter包下新建MyTypeFilter，并实现org.springframework.core.type.filter.TypeFilter接口。此时，我们先在MyTypeFilter类中打印出当前正在扫描的类名，如下所示。

package io.mykit.spring.plugins.register.filter;

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;

/**

• @author binghe

• @version 1.0.0

• @description 自定义过滤规则

*/

public class MyTypeFilter implements TypeFilter {

/**

• metadataReader：读取到的当前正在扫描的类的信息

• metadataReaderFactory：可以获取到其他任务类的信息

*/

@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);

return false;

}

}

接下来，我们在PersonConfig类中配置自定义过滤规则，如下所示。

@Configuration

@ComponentScans(value = {

@ComponentScan(value = “io.mykit.spring”, includeFilters = {

@Filter(type = FilterType.CUSTOM, classes = {MyTypeFilter.class})

}, useDefaultFilters = false)

})

public class PersonConfig {

@Bean(“person”)

public Person person01(){

return new Person(“binghe001”, 18);

}

}

接下来，我们运行SpringBeanTest类中的testComponentScanByAnnotation()方法进行测试，输出的结果信息如下所示。

-----> io.mykit.spring.test.SpringBeanTest

-----> io.mykit.spring.bean.Person

-----> io.mykit.spring.plugins.register.controller.PersonController

-----> io.mykit.spring.plugins.register.dao.PersonDao

-----> io.mykit.spring.plugins.register.filter.MyTypeFilter

-----> io.mykit.spring.plugins.register.service.PersonService

org.springframework.context.annotation.internalConfigurationAnnotationProcessor

org.springframework.context.annotation.internalAutowiredAnnotationProcessor

org.springframework.context.annotation.internalCommonAnnotationProcessor

org.springframework.context.event.internalEventListenerProcessor

org.springframework.context.event.internalEventListenerFactory

personConfig

person

可以看到，已经输出了当前正在扫描的类的名称，同时，除了Spring内置的bean名称外，只输出了personConfig和person，没有输出使用@Repository、@Service、@Controller注解标注的组件名称。这是因为当前PersonConfig上标注的@ComponentScan注解是使用自定义的规则，而在MyTypeFilter自定义规则的实现类中，直接返回了false值，将所有的bean都排除了。

我们可以在MyTypeFilter类中简单的实现一个规则，例如，当前扫描的类名称中包含有字符串Person，就返回true，否则返回false。此时，MyTypeFilter类中match()方法的实现如下所示。

@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);

return className.contains(“Person”);

}

此时，在io.mykit.spring包下的所有类都会通过MyTypeFilter类的match()方法，来验证类名是否包含Person，如果包含则返回true，否则返回false。

我们再次运行SpringBeanTest类中的testComponentScanByAnnotation()方法进行测试，输出的结果信息如下所示。

-----> io.mykit.spring.test.SpringBeanTest

-----> io.mykit.spring.bean.Person

-----> io.mykit.spring.plugins.register.controller.PersonController

-----> io.mykit.spring.plugins.register.dao.PersonDao

-----> io.mykit.spring.plugins.register.filter.MyTypeFilter

-----> io.mykit.spring.plugins.register.service.PersonService

org.springframework.context.annotation.internalConfigurationAnnotationProcessor

org.springframework.context.annotation.internalAutowiredAnnotationProcessor

org.springframework.context.annotation.internalCommonAnnotationProcessor

org.springframework.context.event.internalEventListenerProcessor

org.springframework.context.event.internalEventListenerFactory

personConfig

person

personController

personDao

personService

此时，结果信息中输出了使用@Repository、@Service、@Controller注解标注的组件名称，分别为：personDao、personService和personController。

好了，咱们今天就聊到这儿吧！别忘了给个在看和转发，让更多的人看到，一起学习一起进步！！

项目工程源码已经提交到GitHub：https://github.com/sunshinelyz/spring-annotation

写在最后
自我介绍一下，小编13年上海交大毕业，曾经在小公司待过，也去过华为、OPPO等大厂，18年进入阿里一直到现在。

深知大多数Java工程师，想要提升技能，往往是自己摸索成长或者是报班学习，但对于培训机构动则几千的学费，着实压力不小。自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年Java开发全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友，同时减轻大家的负担。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，基本涵盖了95%以上Java开发知识点，真正体系化！

由于文件比较大，这里只是将部分目录截图出来，每个节点里面都包含大厂面经、学习笔记、源码讲义、实战项目、讲解视频，并且会持续更新！

如果你觉得这些内容对你有帮助，可以扫码获取！！（备注Java获取）

笔者福利

以下是小编自己针对马上即将到来的金九银十准备的一套“面试宝典”，不管是技术还是HR的问题都有针对性的回答。

有了这个，面试踩雷？不存在的！

回馈粉丝，诚意满满！！！

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！
试宝典”，不管是技术还是HR的问题都有针对性的回答。

有了这个，面试踩雷？不存在的！

回馈粉丝，诚意满满！！！

[外链图片转存中…(img-9zLeyT2H-1713543553592)]
[外链图片转存中…(img-2cIziTgS-1713543553593)]
[外链图片转存中…(img-SfaQtJfB-1713543553594)]
[外链图片转存中…(img-ouFb72AS-1713543553595)]

《互联网大厂面试真题解析、进阶开发核心学习笔记、全套讲解视频、实战项目源码讲义》点击传送门即可获取！