springboot项目启动时如何排除一个bean？

大家好，我是G探险者。

使用springboot开发项目，我们有时候会排除一些项目里面用不到的bean，不然的话项目启动会报错，这种情况通常是发生在什么场景里呢，以及如何解决呢？今天咱们就聊一聊。

springboot默认封装了很多的组件，并且把这些组件都进行了自动化配置封装。也就是说，只要是springboot项目，启动类在@SpringBootApplication注解下，在不需要单独配置bean的情况下，本项目所用到的bean在容器启动的时候都会被自动扫描并注入到IOC容器里。这里我所说的bean主要指的是pom文件里面配置的那些starter,以及还有一些springboot默认封装的一些组件，比如数据源，redis等一些组件。

拿数据源来说，有时候我们可能并不想使用springboot默认的数据源，该怎么办？就需要在容器启动的时候进行排除掉。

在这方面，@ComponentScan 和 @SpringBootApplication 注解提供了两种不同的方式来实现这个目标。

1. @ComponentScan 的 excludeFilters 属性

@ComponentScan 注解是用于配置包扫描的注解，其中的 excludeFilters 属性允许你排除特定类型的组件。这在你想要细粒度地控制哪些组件被扫描时非常有用。

@Configuration
@ComponentScan(basePackages = "com.example",
        excludeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = ExcludedClass.class))
public class YourConfigurationClass {
    // Your configuration code here
}

在这个例子中，ExcludedClass 类及其子类将被排除在组件扫描之外。

2. @SpringBootApplication 的 exclude 属性

@SpringBootApplication 是一个复合注解，它包含了 @ComponentScan 注解，同时还包含了其他元数据，比如 @EnableAutoConfiguration，用于自动配置。通过 exclude 属性，你可以在项目的启动类上直接排除自动配置类。

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class)
public class YourSpringBootApplication {
    public static void main(String[] args) {
        SpringApplication.run(YourSpringBootApplication.class, args);
    }
}

在这个例子中，DataSourceAutoConfiguration 自动配置类将被排除在Spring Boot应用程序的启动过程中。

3、两者的对比矩阵

特性	@ComponentScan 的 excludeFilters	@SpringBootApplication 的 exclude
作用范围	指定要扫描的包，可选择性排除特定类型的组件	在Spring Boot应用程序的启动类上使用，通常用于排除自动配置类
排除方式	使用 FilterType 指定排除的类型，如 ASSIGNABLE_TYPE	直接指定要排除的自动配置类的 Class 对象
适用场景	主要用于排除特定类型的组件，不仅限于自动配置类	主要用于排除自动配置类，更符合Spring Boot的整体结构
示例	java @ComponentScan(basePackages = "com.example", excludeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = ExcludedClass.class))	java @SpringBootApplication(exclude = DataSourceAutoConfiguration.class) public class YourSpringBootApplication { public static void main(String[] args) { SpringApplication.run(YourSpringBootApplication.class, args); } }

使用这两种方式，你可以根据具体需求灵活地排除不需要的组件或自动配置类，以定制化你的Spring Boot应用程序。

4、小结

1. 通常情况下，springboot项目启动时，如果不配置扫描包路径，那么它默认是扫描和启动类同级目录下及其子目录下的@Component。

2. 如果配置了扫描包路径，那么它就会在此基础上额外再去扫描配置的包路径下的@Component

3. 所有遵循stater规范的依赖包starter本身并不会受制于启动类@SpringBootApplication启动类的扫描包路径的影响，因为@EnableAutoConfiguration注解（全名org.springframework.boot.autoconfigure.EnableAutoConfiguration） 自动就会扫描

4. 需要单独指定扫描包路径的通常并不是一个starter，因为这些依赖或者组件包里面的@Component是散装的，没有被一个配置类统一管理，也没有被@EnableAutoConfiguration修饰过。