本文主要是介绍@ComponentScan注解，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！
作用与功能：
-自动扫描组件：@ComponentScan注解用于指定Spring在初始化时应该扫描哪些包来寻找带有@Component、@Service、@Repository、@Controller等注解的类，并把这些类注册为Bean。
-重要属性：
-basePackages：指定需要扫描的包名或类，Spring会扫描这些包及其子包下的注解。
-basePackageClasses：指定需要扫描的类的数组，Spring会扫描这些类所在的包及其子包下的注解。
-excludeFilters：指定排除的过滤器，可用于排除某些不需要扫描的类或包。
-includeFilters：指定包含的过滤器，只扫描符合条件的类或包。
excludeFilters支持多种类型的过滤器，主要包括以下几种：
- ANNOTATION：根据注解来排除组件，即排除所有带有指定注解的类。
- ASSIGNABLE_TYPE：根据类类型来排除组件，即排除指定类或其子类。
- ASPECTJ：使用AspectJ表达式来排除组件，这种方式较为高级，允许基于复杂的逻辑来排除组件。
- REGEX：利用正则表达式进行排除，可以匹配类名的模式来排除组件。
- CUSTOM：自定义过滤器，通过实现TypeFilter接口来定义自己的过滤逻辑，这种方式提供了最大的灵活性。
在使用@ComponentScan注解实现包扫描时，可以使用@Filter指定过滤规则，在@Filter中，通过type来指定过滤的类型。而@Filter注解中的type属性是一个FilterType枚举
package org.springframework.context.annotation;public enum FilterType {ANNOTATION,ASSIGNABLE_TYPE,ASPECTJ,REGEX,CUSTOM
}每个枚举值的含义如下所示。
（1）ANNOTATION：按照注解进行包含或者排除。
例如，使用@ComponentScan注解进行包扫描时，按照注解只包含标注了@Controller注解的组件，如下所示。
@ComponentScan(value = "com.dmsp.spring", includeFilters = {@Filter(type = FilterType.ANNOTATION, classes = {Controller.class})
}, useDefaultFilters = false)
（2）ASSIGNABLE_TYPE：按照给定的类型进行包含或者排除。
例如，使用@ComponentScan注解进行包扫描时，按照给定的类型只包含PersonService类（接口）或其子类（实现类或子接口）的组件，如下所示。
@ComponentScan(value = "com.dmsp.spring", includeFilters = {@Filter(type = FilterType.ASSIGNABLE_TYPE, classes = {PersonService.class})
}, useDefaultFilters = false)
此时，只要是PersonService类型的组件，都会被加载到容器中。也就是说：当PersonService是一个Java类时，Person类及其子类都会被加载到Spring容器中；当PersonService是一个接口时，其子接口或实现类都会被加载到Spring容器中。
（3）ASPECTJ：按照ASPECTJ表达式进行过滤 这种过滤规则基本上不用
例如，使用@ComponentScan注解进行包扫描时，按照ASPECTJ表达式进行过滤，如下所示。
@ComponentScan(value = "com.dmsp.spring", includeFilters = {@Filter(type = FilterType.ASPECTJ, classes = {AspectJTypeFilter.class})
}, useDefaultFilters = false)
（4）REGEX：按照正则表达式进行过滤
例如，使用@ComponentScan注解进行包扫描时，按照正则表达式进行过滤，如下所示。
@ComponentScan(value = "com.dmsp.spring", includeFilters = {@Filter(type = FilterType.REGEX, classes = {RegexPatternTypeFilter.class})
}, useDefaultFilters = false)
（5）CUSTOM：按照自定义规则进行过滤。
如果实现自定义规则进行过滤时，自定义规则的类必须是org.springframework.core.type.filter.TypeFilter接口的实现类。
例如，按照自定义规则进行过滤，首先，我们需要创建一个org.springframework.core.type.filter.TypeFilter接口的实现类MyTypeFilter，如下所示。
public class MyTypeFilter implements TypeFilter {@Overridepublic 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 = "com.dmsp.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 com.dmsp.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 * @version 1.0.0* @description 自定义过滤规则*/
public class MyTypeFilter implements TypeFilter {/*** metadataReader：读取到的当前正在扫描的类的信息* metadataReaderFactory：可以获取到其他任务类的信息*/@Overridepublic 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;}
}
注意事项
@ComponentScan注解本身不直接扫描@Bean注解。@ComponentScan主要用于扫描带有@Component、@Service、@Repository、@Controller等注解的类，并将它们注册为Spring容器中的Bean。而@Bean注解通常与@Configuration注解一起使用，用于在配置类中声明Bean，这些Bean会被Spring容器管理。
然而，在Spring Boot应用中，当使用@SpringBootApplication注解时，它实际上包含了@ComponentScan注解，并且默认会扫描启动类所在的包及其子包中的所有组件。如果配置类（带有@Configuration注解的类）位于这些包中，并且其中使用了@Bean注解来声明Bean，那么这些Bean也会被Spring容器扫描并注册。因此，虽然@ComponentScan不直接扫描@Bean注解，但在Spring Boot的上下文中，通过@SpringBootApplication的默认行为，@Bean注解声明的Bean仍然会被扫描和注册
在Spring中，@ComponentScan注解的includeFilters和excludeFilters共同作用于组件扫描过程，但excludeFilters具有更高的优先级。
-
功能与作用：
- includeFilters：指定扫描时需要包含的组件，即满足条件的类会被注册为Bean。
- excludeFilters：指定扫描时需要排除的组件，即满足条件的类不会被注册为Bean。
-
优先级解析：
- 当一个类同时满足includeFilters和excludeFilters的条件时，excludeFilters的规则会生效，该类不会被注册为Bean。这表明excludeFilters在组件扫描过程中具有更高的优先级。
-
配置建议：
- 在使用includeFilters和excludeFilters时，需要谨慎考虑其优先级，以确保组件扫描的结果符合预期。
这篇关于@ComponentScan注解的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！
