SpringBoot—@ComponentScan注解过滤排除某个类

技术公众号:后端技术解忧铺
关注微信公众号:CodingTechWork,一起学习进步。

问题

  在抽取公共swagger配置类时,将swagger放入com.test.common.config包内,其他模块通过@ComponentScan进行进行引用,但有的模块在引用时,会扫描到common.config包路径下的其他配置类而引发错误,如引用到RedisConfig类而报错,此时需要将该类排除掉。

解决方案

  通过@ComponentScan中的excludeFilters属性进行排除类。

@SpringBootApplication
@ComponentScan(basePackages = {"com.test.common.config"},
    excludeFilters = {@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, value = {RedisConfig.class})})
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

}

附:FilterType

package org.springframework.context.annotation;

public enum FilterType {
    ANNOTATION,
    ASSIGNABLE_TYPE,
    ASPECTJ,
    REGEX,
    CUSTOM;

    private FilterType() {
    }
}
  1. ANNOTATION:注解类型
  2. ASSIGNABLE_TYPE:指定类型
  3. ASPECTJ:按照Aspectj表达式
  4. REGEX:按照正则表达式
  5. CUSTOM:自定义规则
### Spring @ComponentScan 注解 使用说明及常见问题解决方案 #### 一、@ComponentScan 注解概述 `@ComponentScan` 是 Spring 框架中的一个重要注解,主要用于自动扫描指定包及其子包下的,并将其注册为 Spring 容器中的 Bean。默认情况下,Spring Boot 项目会基于 `@SpringBootApplication` 注解所在的包路径进行扫描,但如果需要自定义扫描范围,则可以通过 `@ComponentScan` 显式指定[^1]。 - **核心功能**:扫描带有特定注解(如 `@Component`、`@Service`、`@Repository` 和 `@Controller` 等)的,并将它们注册为 Spring 容器中的 Bean。 - **注意事项**:如果目标是接口而非具体实现,即使标注了 `@Component` 注解,也无法被实例化为 Bean,因为接口本身无法直接实例化[^2]。 --- #### 二、@ComponentScan 的常用属性 以下是 `@ComponentScan` 注解的一些重要属性及其作用: 1. **basePackages** - 型:字符串数组 (`String[]`) - 描述:指定需要扫描的包名列表。例如: ```java @ComponentScan(basePackages = {"com.example.package1", "com.example.package2"}) ``` 2. **basePackageClasses** - 型:Class 数组 (`Class<?>[]`) - 描述:通过指定某些来间接确定扫描的包路径。这些所在的包会被作为根目录进行扫描。例如: ```java @ComponentScan(basePackageClasses = {MyClass1.class, MyClass2.class}) ``` 3. **useDefaultFilters** - 型:布尔值 (`boolean`) - 描述:控制是否启用默认过滤规则,默认值为 `true`。如果设为 `false`,则需要显式定义过滤条件。 4. **includeFilters/excludeFilters** - 型:Filter 数组 (`Filter[]`) - 描述:用于定义包含或排除过滤规则。支持多种型的过滤器,如按注解型等筛选。例如: ```java @ComponentScan( includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class), useDefaultFilters = false ) ``` 5. **resourcePattern** - 型:字符串 (`String`) - 描述:定义扫描时匹配的资源模式,默认为 `/**/*.class`,即扫描所有 `.class` 文件。 --- #### 三、典型应用场景与代码示例 ##### 场景 1:覆盖默认扫描路径 当项目的包结构较为复杂,或者需要引入外部 jar 包中的组件时,可以使用 `@ComponentScan` 来扩展扫描范围。例如: ```java @ComponentScan(basePackages = {"com.external.lib", "com.myapp.service"}) public class AppConfig { } ``` ##### 场景 2:多重扫描不同包路径 有时需要同时扫描多个不相关的包路径,可通过重复使用 `@ComponentScan` 或利用 `@Repeatable` 特性完成。例如: ```java @ComponentScan("com.pwx.bean") @ComponentScan("com.pwx.bean1") public class MyConfig { public static void main(String[] args) { AnnotationConfigApplicationContext applicationContext = new AnnotationConfigApplicationContext(MyConfig.class); String[] beanDefinitionNames = applicationContext.getBeanDefinitionNames(); Arrays.stream(beanDefinitionNames).forEach(System.out::println); } } ``` 注意:上述写法在现代版本中可能更推荐使用 `@ComponentScans` 组合形式[^3]。 ##### 场景 3:定制化过滤规则 假设只希望扫描带 `@Controller` 注解,可配置如下: ```java @ComponentScan( basePackages = "com.myapp", includeFilters = @ComponentScan.Filter(type = FilterType.ANNOTATION, classes = Controller.class), useDefaultFilters = false ) public class WebAppConfig { } ``` --- #### 四、常见问题及解决方法 1. **问题**: 引入第三方库后,部分 Bean 未被扫描到。 - **原因**: 默认扫描路径仅限于启动所在包及其子包。 - **解决办法**: 使用 `@ComponentScan` 扩展扫描范围至目标包路径[^5]。 2. **问题**: 控制器未被识别,导致 HTTP 请求返回 404 错误。 - **原因**: 启动所在包之外的控制器未被纳入扫描范围。 - **解决办法**: 确保 `@ComponentScan` 正确指定了包含控制器的包路径。 3. **问题**: 接口加了 `@Component` 注解却未能成为 Bean。 - **原因**: 接口无法直接实例化。 - **解决办法**: 提供具体的实现并为其添加相应注解[^2]。 --- ### 总结 `@ComponentScan` 是一个强大的工具,可以帮助开发者灵活地管理 Spring 应用中的组件扫描行为。合理配置其属性能够显著提升开发效率,同时也需留意潜在陷阱以避免不必要的错误发生。 ---
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值