自定义TypeFilter 指定@ComponentScan注解的过滤规则

这篇具有很好参考价值的文章主要介绍了自定义TypeFilter 指定@ComponentScan注解的过滤规则。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

1.FilterType中常用的规则

在使用@ComponentScan注解实现包扫描时,可以使用@Filter指定过滤规则,在@Filter中,通过type来指定过滤的类型。而@Filter注解中的type属性是一个FilterType枚举,其源码如下。

public enum FilterType {

	/**
	 * Filter candidates marked with a given annotation.
	 * @see org.springframework.core.type.filter.AnnotationTypeFilter
	 */
	ANNOTATION,

	/**
	 * Filter candidates assignable to a given type.
	 * @see org.springframework.core.type.filter.AssignableTypeFilter
	 */
	ASSIGNABLE_TYPE,

	/**
	 * Filter candidates matching a given AspectJ type pattern expression.
	 * @see org.springframework.core.type.filter.AspectJTypeFilter
	 */
	ASPECTJ,

	/**
	 * Filter candidates matching a given regex pattern.
	 * @see org.springframework.core.type.filter.RegexPatternTypeFilter
	 */
	REGEX,

	/** Filter candidates using a given custom
	 * {@link org.springframework.core.type.filter.TypeFilter} implementation.
	 */
	CUSTOM
}

1.1.FilterType.ANNOTATION:按照注解进行包含或者排除

例如,使用@ComponentScan注解进行包扫描时,如果要想按照注解只包含标注了@Controller注解的组件,那么就需要像下面这样写。

@ComponentScan(value="com.tianxia.springannotation", includeFilters={
		/*
		 * type:指定你要排除的规则,是按照注解进行排除,还是按照给定的类型进行排除,还是按照正则表达式进行排除,等等
		 * classes:我们需要Spring在扫描时,只包含@Controller注解标注的类
		 */
		@ComponentScan.Filter(type=FilterType.ANNOTATION, classes={Controller.class})
}, useDefaultFilters=false)

1.2.FilterType.ASSIGNABLE_TYPE:按照给定的类型进行包含或者排除

使用@ComponentScan注解进行包扫描时,如果要想按照给定的类型只包含BookService类(接口)或其子类(实现类或子接口)的组件,那么就需要像下面这样写。

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

1.3.FilterType.ASPECTJ:按照ASPECTJ表达式进行包含或者排除

@ComponentScan(value="com.tianxia.springannotation", includeFilters={
		@Filter(type=FilterType.ASPECTJ, classes={AspectJTypeFilter.class})
}, useDefaultFilters=false)

这种过滤规则基本上不怎么用!

1.4.FilterType.REGEX:按照正则表达式进行包含或者排除

@ComponentScan(value="com.tianxia.springannotation", includeFilters={
		@ComponentScan.Filter(type=FilterType.REGEX, classes={RegexPatternTypeFilter.class})
}, useDefaultFilters=false)

1.5.FilterType.CUSTOM:按照自定义规则进行包含或者排除

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

该实现类的代码一开始如下所示。

package com.tianxia.springannotation.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;

/**
 * @ComponentScan自定义规则过滤器
 * @author liqb
 * @date 2023-04-23 9:10
 **/
public class MyTypeFilter implements TypeFilter {

    /**
     * @ComponentScan的规则匹配
     * @author liqb
     * @date 2023-04-23 09:13
     * @param metadataReader 读取到的当前正在扫描的类的信息
     * @param metadataReaderFactory 可以获取到其他任何类的信息的(工厂)
     * @return 当返回true时,表示符合规则,会包含在Spring容器中;当返回false时,表示不符合规则
     * @throws IOException
     */
    @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);

        // 现在来指定一个规则
        if (className.contains("er")) {
            return true; // 匹配成功,就会被包含在容器中
        }
        return false;
    }
}

实现TypeFilter接口时,需要实现该接口中的match()方法,match()方法的返回值为boolean类型。当返回true时,表示符合规则,会包含在Spring容器中;当返回false时,表示不符合规则,那就是一个都不匹配,自然就都不会被包含在Spring容器中。

然后,使用@ComponentScan注解进行如下配置。文章来源地址https://www.toymoban.com/news/detail-423231.html

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

到了这里,关于自定义TypeFilter 指定@ComponentScan注解的过滤规则的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Spring5学习随笔-高级注解(@ComponentScan、@Configuration.....),替换XML配置文件

    学习视频:【孙哥说Spring5:从设计模式到基本应用到应用级底层分析,一次深入浅出的Spring全探索。学不会Spring?只因你未遇见孙哥】 Spring在3.x提供的新的注解,用于替换XML配置文件。 问题 : 配置Bean在应用的过程中替换了XML具体的什么内容? AnnotationConfigApplicationContext 配

    2024年02月05日
    浏览(36)
  • 【项目实战】自定义设置Sonar的规则,要求DevOps工具链SonarQube只扫描指定模块

    开发微服务项目,很多会基于网络上现成开源的微服务框架进行二开,公司有单元测试覆盖率的要求,往往会使用SonarQube 来实现扫描代码的单元测试覆盖率,但是因为网络上现成开源的微服务框架很大部分是已经现成的代码,因此补充单元测试工作会很痛苦,于是,可以自定

    2024年02月14日
    浏览(37)
  • SpringBoot缓存注解@Cacheable之自定义key策略及缓存失效时间指定

    1. 项目依赖 本项目借助 SpringBoot 2.2.1.RELEASE  +  maven 3.5.3  +  IDEA  +  redis5.0 进行开发 开一个 web 服务用于测试 1. key 生成策略 对于 @Cacheable 注解,有两个参数用于组装缓存的 key cacheNames/value: 类似于缓存前缀 key: SpEL 表达式,通常根据传参来生成最终的缓存 key 默认的 redisK

    2024年02月19日
    浏览(30)
  • JSON序列化/反序列化,指定自定义字段名key转换注解配置

    实体类案例: 正常序列化和反序列化JSON对应为: 案例: 实体类的属性上面增加@JsonProperty(“字段名”)注解(fastjson) 在springboot请求接口返回对象得到的结果:(因为springboot使用fastjson序列化对象) json字符串为: 实体类属性上增加@JSONField(name = “属性名”)注解(alibaba.fastjson) 代

    2024年02月10日
    浏览(25)
  • 【规则】Adblock Plus 广告过滤规则自用整理

    百度贴吧 tieba.baidu.com##li[data-field=\\\"{}\\\"][add-shield-track=\\\"1\\\"] tieba.baidu.com##*[data-field=\\\"{}\\\"][add-shield-track=\\\"1\\\"] AdblockPlus拦截规则简单教程_What??!的博客-CSDN博客_adblock plus 规则 元素隐藏基本规则 内容广告html如下: div class=\\\"textad\\\" Cheapest tofu, only here and now! /div  div id=\\\"sponsorad\\\" Really cheap tof

    2024年02月07日
    浏览(26)
  • [后端开发] 过滤器相关注解

    使用Springboot框架开发后端,在鉴权的时候使用到了过滤器。但是在测试的过程发现,跨域的过滤器在过滤链中出现了两次,导致前端访问后端接口时报错:The \\\'Access-Control-Allow-Origin\\\' headers contains multiple values,but only one allowed.错误 在浏览器端比较正常访问接口和报错接口的hea

    2024年04月16日
    浏览(37)
  • 删除指定的iptables规则

    首先查看当前iptables的nat表内的规则 命令解释: 如果要删除图中黄框框住的规则,命令为 如果要删除图中红框框住的规则,命令为 命令解释 参考文章:https://mp.weixin.qq.com/s/QOfORsSIcxuRXFj1xkUFcA

    2024年02月13日
    浏览(30)
  • firewalld 设置规则只允许指定ip访问指定端口 —— 筑梦之路

    需求说明: 现有三台机器,系统都是centos7 192.168.100.100 192.168.100.101  开启防火墙firewalld,上面有web服务nginx,监听80端口 192.168.100.102 需要让192.168.100.102可以访问101机器的80端口,192.168.100.100不允许访问101的80端口 如何设置防火墙规则? 1.查看101上当前防火墙规则  2.配置防火

    2024年02月12日
    浏览(24)
  • ThingsBoard教程(三九):规则节点解析 根据经纬度过滤数据 GPS geofencing filter

    这篇文章 介绍 GPS geofencing filter 节点, 根据经纬度来过滤通过规则链的数据。 通过基于GPS的地理围栏过滤传入的消息。从传入消息中提取纬度和经度参数,并根据配置的范围进行检查。 配置: 纬度键名称 (Latitude key name)- 包含位置纬度的消息字段的名称; 经度键名称( Long

    2024年02月03日
    浏览(41)
  • 【微服务笔记17】微服务组件之Gateway实现动态路由、配置路由规则、路由过滤器

    这篇文章,主要介绍微服务组件之Gateway实现动态路由、配置路由映射规则、路由过滤器。 目录 一、动态路由配置 1.1、动态URI路由配置 (1)引入eureka客户端依赖 (2)添加路由配置 1.2、服务名称转发配置 二、断言配置规则 2.1、路由断言工厂类 2.2、Path路径匹配 2.3、Query请求

    2023年04月23日
    浏览(37)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包