一篇了解@ComponentScan注解

想成为秃顶的资深工程师，关于@ComponentScans注解与@ComponentScan注解，不能只停留在表面！,翻开Spring的源码找到@ComponentScan注解的源码，发现注解类上赫然标注着Since: 3.1​字样。也就是说，@ComponentScan注解是从Spring的3.1版本开始提供的。在@ComponentScan注解上，标注了一个@Repeatable注解，@Repeatable注解的属性值为ComponentScans.class。再次翻看下@ComponentScans注解的源码，类上标注着Since: 4.3字样。也就是说，@ComponentScans注解是从Spring4.3版本开始提供的。@ComponentScans注解就相当于是@ComponentScan注解的一个数组，在@ComponentScans注解中可以多次使用@ComponentScan注解来扫描不同的包路径。,如果你只想做一个天天加班的CRUD的程序员，掌握上述的基本知识就够了。CRUD操作不需要你对@ComponentScans注解与@ComponentScan注解有多么深入的了解。但是，如果你想对Spring的源码有进一步的了解和认识，想熟悉Spring核心源码的执行流程，想成为一名合格的架构师或技术专家，只了解上述@ComponentScans注解与@ComponentScan注解最基本的知识点是远远不够的。,@ComponentScans注解与@ComponentScan注解的一点点说明！,@ComponentScans注解可以看作是@ComponentScan注解的一个数组，在@ComponentScans注解中可以多次标注@ComponentScan注解。,@ComponentScan注解最核心的功能就是Spring IOC容器在刷新的时候会扫描对应包下标注了@Component注解、@Configuration注解、@Repository注解、@Service注解和@Controller等等注解的类，生成扫描到的类的Bean定义信息，整体流程与注册ConfigurationClassPostProcessor类的Bean定义信息的流程基本一致，最终都会将其保存到BeanFactory中的beanDefinitionMap中。,本节，主要是对@ComponentScans注解和@ComponentScan注解的源码进行简单的剖析。,源码详见：org.springframework.context.annotation.ComponentScans，如下所示。,可以看到，@ComponentScans注解的源码还是比较简单的，在@ComponentScans注解中存在一个ComponentScan[]数组类型的value属性，说明@ComponentScans注解的属性可以存放一个@ComponentScan注解类型的数组，可以在ComponentScans注解中多次添加@ComponentScan注解。从@ComponentScans注解的源码还可以看出，@ComponentScans注解从Spring 4.3版本开始提供。,@ComponentScan注解的源码是本章分析的重点内容，@ComponentScan注解的源码详见：org.springframework.context.annotation.ComponentScan，如下所示。,可以看到，Spring从3.1版本开始提供@ComponentScan注解，@ComponentScan注解中还有一个内部注解@Filter。,@ComponentScan注解中的每个属性的含义如下所示。,ScopedProxyMode枚举类表示Spring指定生成Bean对象时的代理方式，源码详见：org.springframework.context.annotation.ScopedProxyMode。,ScopedProxyMode类是从Spring 2.5版本开始提供的枚举类，每个属性的含义如下所示。,FilterType枚举类表示Spring扫描类时的过滤类型，源码详见：org.springframework.context.annotation.FilterType，如下所示。,FilterType类是Spring2.5版本开始提供的枚举类，每个属性的含义如下所示。,在FilterType枚举类中，ANNOTATION和ASSIGNABLE_TYPE是比较常用的，ASPECTJ和REGEX不太常用，如果FilterType枚举类中的类型无法满足日常开发需求时，可以通过实现org.springframework.core.type.filter.TypeFilter接口来自定义过滤规则，此时，将@Filter中的type属性设置为FilterType.CUSTOM，classes属性设置为自定义规则的类对应的Class对象。,2.2 注解使用场景,使用Spring的注解开发应用程序时，如果需要将标注了Spring注解的类注入到IOC容器中，就需要使用@ComponentScan注解来扫描指定包下的类。同时，在Spring4.3版本开始，提供了@ComponentScans注解，在@ComponentScans注解中，支持配置多个@ComponentScan注解来扫描不同的包，配置不同的过滤规则。,整个案例来玩玩儿吧！,使用自定义过滤规则实现Spring扫描指定包下的类时，使得名称中含有 componentScanConfig 字符串的类符合过滤规则。,整个案例实现的步骤总体如下所示。,（1）新建自定义过滤规则类ComponentScanFilter,ComponentScanFilter类的源码详见：spring-annotation-chapter-02工程下的io.binghe.spring.annotation.chapter02.componentscan.filter.ComponentScanFilter，如下所示。,可以看到，自定义过滤规则ComponentScanFilter类实现了TypeFilter接口，并覆写了match()方法，match()方法中的核心逻辑就是：如果类的名称中含有componentScanConfig字符串，符合过滤规则，返回true，否则，返回false。,（2）新建配置类ComponentScanConfig,ComponentScanConfig类的源码详见：spring-annotation-chapter-02工程下的io.binghe.spring.annotation.chapter02.componentscan.config.ComponentScanConfig，如下所示。,可以看到，在ComponentScanConfig类上标注了@Configuration注解，说明ComponentScanConfig类是Spring的配置类。在标注的@ComponentScan注解中指定了要扫描的包名，使用只包含的过滤规则，并采用自定义过滤规则。,此时，需要注意的是，需要将是否使用默认的过滤规则设置为false。,（3）新建测试类ComponentScanTest,ComponentScanTest类的源码详见：spring-annotation-chapter-02工程下的io.binghe.spring.annotation.chapter02.componentscan.ComponentScanTest，如下所示。,可以看到，在ComponentScanTest类中，在AnnotationConfigApplicationContext类的构造方法中传入ComponentScanConfig类的Class对象创建IOC容器，并将其赋值给context局部变量。通过context局部变量的getBeanDefinitionNames()方法获取所有的Bean定义名称，随后遍历这些Bean定义名称进行打印。,本案例中，在@ComponentScan注解中使用了includeFilters过滤规则，并且使用的是自定义过滤规则，符合过滤规则的是名称中含有 componentScanConfig 字符串的类。另外，Spring中内置的Processor类和Factory类的Bean定义信息注册到IOC容器时，不受过滤规则限制。,运行ComponentScanTest类输出的结果信息如下所示。,可以看到，从IOC容器中获取的Bean的类定义信息的名称中可以看出，除了名称中包含componentScanConfig字符串的类符合过滤规则外，Spring内置的Processor类和Factory类不受过滤规则限制，其类的Bean定义信息都注册到了IOC容器中。,1.扫描时排除注解标注的类,排除@Controller、@Service和@Repository注解，可以在配置类上通过@ComponentScan注解的excludeFilters()属性实现，如下所示。,2.扫描时只包含注解标注的类,可以使用ComponentScan注解类的includeFilters()属性来指定Spring在进行包扫描时，只包含哪些注解标注的类。如果使用includeFilters()属性来指定只包含哪些注解标注的类时，需要禁用默认的过滤规则。,例如，只包含@Controller注解标注的类，可以在配置类上添加@ComponentScan注解，设置只包含@Controller注解标注的类，并禁用默认的过滤规则，如下所示。,3.重复注解,在Java8中@ComponentScan注解是一个重复注解，可以在一个配置类上重复使用这个注解，如下所示。,如果使用的是Java8之前的版本，就不能直接在配置类上写多个@ComponentScan注解了。此时，可以在配置类上使用@ComponentScans注解，如下所示。,总结：可以使用@ComponentScan注解来指定Spring扫描哪些包，可以使用excludeFilters()指定扫描时排除哪些组件，也可以使用includeFilters()指定扫描时只包含哪些组件。当使用includeFilters()指定只包含哪些组件时，需要禁用默认的过滤规则。,4.扫描时按照注解进行过滤,使用@ComponentScan注解进行包扫描时，按照注解只包含标注了@Controller注解的组件，如下所示。,5.扫描时按照指定的类型进行过滤,使用@ComponentScan注解进行包扫描时，按照给定的类型只包含DemoService类（接口）或其子类（实现类或子接口）的组件，如下所示。,此时，只要是DemoService类型的组件，都会被加载到容器中。也就是说：当DemoService是一个Java类时，DemoService类及其子类都会被加载到Spring容器中；当DemoService是一个接口时，其子接口或实现类都会被加载到Spring容器中。,6.扫描时按照ASPECTJ表达式进行过滤,使用@ComponentScan注解进行包扫描时，按照ASPECTJ表达式进行过滤，如下所示。,其中，AspectJTypeFilter类就是自定义的ASPECTJ表达式的过滤器类。,7.扫描时按照正则表达式进行过滤,使用@ComponentScan注解进行包扫描时，按照正则表达式进行过滤，如下所示。,其中，RegexPatternTypeFilter类就是自定义的正则表达式的过滤器类。,8.扫描时按照自定义规则进行过滤,如果实现自定义规则进行过滤时，自定义规则的类必须是org.springframework.core.type.filter.TypeFilter接口的实现类。,例如，按照自定义规则进行过滤，首先，需要创建一个org.springframework.core.type.filter.TypeFilter接口的实现类BingheTypeFilter，如下所示。,当实现TypeFilter接口时，需要实现TypeFilter接口中的match()方法，match()方法的返回值为boolean类型。当返回true时，表示符合过滤规则，会将类的Bean定义信息注册到IOC容器中；当返回false时，表示不符合过滤规则，对应的类的Bean定义信息不会注册到IOC容器中。,接下来，使用@ComponentScan注解进行如下配置。,结合时序图理解源码会事半功倍，你觉得呢？,本节，就以源码时序图的方式，直观的感受下@ComponentScans注解与@ComponentScan注解在Spring源码层面的执行流程。@ComponentScans注解与@ComponentScan注解在Spring源码层面的执行流程如图2-1~2-3所示。,,图2-1,,图2-2,
,,图2-3,由图2-1~2-3可以看出，解析@ComponentScans注解与@ComponentScan注解在Spring源码中的执行流程，会涉及到ComponentScanTest类、AnnotationConfigApplicationContext类、AbstractApplicationContext类、PostProcessorRegistrationDelegate类、ConfigurationClassPostProcessor类、ConfigurationClassParser类、ComponentScanAnnotationParser类、ClassPathBeanDefinitionScanner类、ClassPathScanningCandidateComponentProvider类、BeanDefinitionReaderUtils类和DefaultListableBeanFactory类等。具体的源码执行细节参见源码解析部分。,源码时序图整清楚了，那就整源码解析呗！,@ComponentScans注解与@ComponentScan注解在Spring源码中的执行流程，结合源码执行的时序图，会理解的更加深刻。,（1）运行案例程序启动类,案例程序启动类源码详见：spring-annotation-chapter-02工程下的io.binghe.spring.annotation.chapter02.componentscan.ComponentScanTest，运行ComponentScanTest类的main()方法。,可以看到，在ComponentScanTest类的main()方法中调用了AnnotationConfigApplicationContext类的构造方法，并传入了ComponentScanConfig类的Class对象来创建IOC容器。接下来，会进入AnnotationConfigApplicationContext类的构造方法。,（2）解析AnnotationConfigApplicationContext类的AnnotationConfigApplicationContext(Class<?>... componentClasses)构造方法,源码详见：org.springframework.context.annotation.AnnotationConfigApplicationContext#AnnotationConfigApplicationContext(Class<?>... componentClasses)。,可以看到，在上述构造方法中，调用了refresh()方法来刷新IOC容器。,（3）解析AbstractApplicationContext类的refresh()方法,源码详见：org.springframework.context.support.AbstractApplicationContext#refresh()。,refresh()方法是Spring中一个非常重要的方法，很多重要的功能和特性都是通过refresh()方法进行注入的。可以看到，在refresh()方法中，调用了invokeBeanFactoryPostProcessors()方法。,（4）解析AbstractApplicationContext类的invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory)方法,源码详见：org.springframework.context.support.AbstractApplicationContext#invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory)。,可以看到，在AbstractApplicationContext类的invokeBeanFactoryPostProcessors()方法中调用了PostProcessorRegistrationDelegate类的invokeBeanFactoryPostProcessors()方法。,（5）解析PostProcessorRegistrationDelegate类的invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory, ListbeanFactoryPostProcessors)方法,源码详见：org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory, ListbeanFactoryPostProcessors)。,由于方法的源码比较长，这里，只关注当前最核心的逻辑，如下所示。,可以看到，在PostProcessorRegistrationDelegate类的invokeBeanFactoryPostProcessors(ConfigurableListableBeanFactory beanFactory, ListbeanFactoryPostProcessors)方法中，BeanDefinitionRegistryPostProcessor的实现类在执行逻辑上会有先后顺序，并且最终都会调用invokeBeanDefinitionRegistryPostProcessors()方法。,（6）解析PostProcessorRegistrationDelegate类的invokeBeanDefinitionRegistryPostProcessors(Collection<? extends BeanDefinitionRegistryPostProcessor> postProcessors, BeanDefinitionRegistry registry, ApplicationStartup applicationStartup)方法,源码详见：org.springframework.context.support.PostProcessorRegistrationDelegate#invokeBeanDefinitionRegistryPostProcessors(Collection<? extends BeanDefinitionRegistryPostProcessor> postProcessors, BeanDefinitionRegistry registry, ApplicationStartup applicationStartup)。,可以看到，在invokeBeanDefinitionRegistryPostProcessors()方法中，会循环遍历postProcessors集合中的每个元素，调用postProcessBeanDefinitionRegistry()方法注册Bean的定义信息。,（7）解析ConfigurationClassPostProcessor类的postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)方法,源码详见：org.springframework.context.annotation.ConfigurationClassPostProcessor#postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry)。,可以看到，在postProcessBeanDefinitionRegistry()方法中，会调用processConfigBeanDefinitions()方法。,（8）解析ConfigurationClassPostProcessor类的processConfigBeanDefinitions(BeanDefinitionRegistry registry)方法,源码详见：org.springframework.context.annotation.ConfigurationClassPostProcessor#processConfigBeanDefinitions(BeanDefinitionRegistry registry)。,这里，重点关注方法中的如下逻辑。,可以看到，在processConfigBeanDefinitions()方法中，创建了一个ConfigurationClassParser类型的对象parser，并且调用了parser的parse()方法来解析类的配置信息。,（9）解析ConfigurationClassParser类的parse(SetconfigCandidates)方法,源码详见：org.springframework.context.annotation.ConfigurationClassParser#parse(SetconfigCandidates)。,可以看到，在ConfigurationClassParser类的parse(SetconfigCandidates)方法中，调用了类中的另一个parse()方法。,（10）解析ConfigurationClassParser类的parse(AnnotationMetadata metadata, String beanName)方法,源码详见：org.springframework.context.annotation.ConfigurationClassParser#parse(AnnotationMetadata metadata, String beanName),可以看到，上述parse()方法的实现比较简单，直接调用了processConfigurationClass()方法。,（11）解析ConfigurationClassParser类的processConfigurationClass(ConfigurationClass configClass, Predicatefilter)方法,源码详见：org.springframework.context.annotation.ConfigurationClassParser#processConfigurationClass(ConfigurationClass configClass, Predicatefilter)。,可以看到，在processConfigurationClass()方法中，会通过do-while()循环获取配置类和其父类的注解信息，SourceClass类中会封装配置类上注解的详细信息。在在processConfigurationClass()方法中，调用了doProcessConfigurationClass()方法。,（12）解析ConfigurationClassParser类的doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass, Predicatefilter)方法,源码详见：org.springframework.context.annotation.ConfigurationClassParser#doProcessConfigurationClass(ConfigurationClass configClass, SourceClass sourceClass, Predicatefilter)。,这里，只关注与@ComponentScan注解相关的逻辑，可以看到，在上述处理@ComponentScan注解的逻辑中，通过componentScanParser的parse()方法对@ComponentScan注解进行解析。,（13）解析ComponentScanAnnotationParser类的parse(AnnotationAttributes componentScan, String declaringClass)方法,源码详见：org.springframework.context.annotation.ComponentScanAnnotationParser#parse(AnnotationAttributes componentScan, String declaringClass)。,看到这里，大家是不是有一种豁然开朗的感觉，原来@ComponentScan注解是在这里解析的！！！！,可以看到，在parse()方法中，会创建一个ClassPathBeanDefinitionScanner类型的扫描器scanner，将@ComponentScan注解上配置的信息都设置到扫描器scanner中，最后调用扫描器scanner的doScan()方法进行扫描。,（14）解析ClassPathBeanDefinitionScanner类的doScan(String... basePackages)方法,源码详见：org.springframework.context.annotation.ClassPathBeanDefinitionScanner#doScan(String... basePackages)。,在doScan()方法中，会遍历传入的每个包路径，调用findCandidateComponents()方法来扫描带有注解（例如@Component注解）的类。,（15）解析ClassPathScanningCandidateComponentProvider类的findCandidateComponents(String basePackage)方法,源码详见：org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider#findCandidateComponents(String basePackage)。,可以看到，Spring在扫描类时，会调用scanCandidateComponents()方法。,（16）解析ClassPathScanningCandidateComponentProvider类的scanCandidateComponents(String basePackage)方法,源码详见：org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider#scanCandidateComponents(String basePackage)。,可以看到，在scanCandidateComponents()方法中，会调用isCandidateComponent()方法来判断当前注解是不是要扫描的注解。,（17）解析ClassPathScanningCandidateComponentProvider类的isCandidateComponent(MetadataReader metadataReader)方法,源码详见：org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider#isCandidateComponent(MetadataReader metadataReader)。,可以看到，isCandidateComponent()方法的逻辑还是比较简单的，就是遍历匹配excludeFilters和includeFilters指定的规则。,优先匹配excludeFilters指定的规则，如果匹配excludeFilters指定的规则，直接返回false。接下来，匹配includeFilters指定的规则，匹配成功，则调用isConditionMatch()方法进行条件匹配。,其中，对于includeFilters而言，默认的过滤规则如下所示。,可以看到，对于includeFilters而言，默认的过滤规则会匹配@Component注解，JSR-250中的注解和JSR-330中的注解。,（18）回到ClassPathScanningCandidateComponentProvider类的scanCandidateComponents(String basePackage)方法,在ClassPathScanningCandidateComponentProvider类的scanCandidateComponents(String basePackage)方法中，会将标注了@Component注解，JSR-250中的注解和JSR-330中的注解的类信息封装成ScannedGenericBeanDefinition类对象，也就是类的Bean定义信息。,ScannedGenericBeanDefinition类的构造方法如下所示。,（19）回到ClassPathBeanDefinitionScanner类的doScan(String... basePackages)方法,在ClassPathBeanDefinitionScanner类的doScan(String... basePackages)方法中，会将扫描到的类的Bean定义信息注册到IOC容器中，如下代码片段所示。,可以看到，在doScan()方法中，会调用registerBeanDefinition()注册Bean定义信息。,（20）解析ClassPathBeanDefinitionScanner类的registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)方法,源码详见：org.springframework.context.annotation.ClassPathBeanDefinitionScanner#registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)。,可以看到，在方法中直接调用了BeanDefinitionReaderUtils类的registerBeanDefinition()方法。,（21）解析BeanDefinitionReaderUtils类的registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)方法。,源码详见：org.springframework.beans.factory.support.BeanDefinitionReaderUtils#registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)。,可以看到，在上述代码中，会继续调用BeanDefinitionRegistry类型的对象registry的registerBeanDefinition()方法，将类的Bean定义信息注册到IOC容器。,（22）解析DefaultListableBeanFactory类的registerBeanDefinition(String beanName, BeanDefinition beanDefinition)方法,源码详见：org.springframework.beans.factory.support.DefaultListableBeanFactory#registerBeanDefinition(String beanName, BeanDefinition beanDefinition)。,可以看到，Spring会将扫描到的标注了符合过滤规则的注解的类封装成对应的Bean定义信息，最终会将这些Bean定义信息注册到beanDefinitionMap中。这一点和第1章中，注册ConfigurationClassPostProcessor类的Bean定义信息有点类似。,好了，至此，@ComponentScans注解与@ComponentScan注解在Spring源码中的执行流程分析完毕。,@ComponentScans注解与@ComponentScan注解讲完了，一起来总结下吧！,本章，主要对@ComponentScans注解与@ComponentScan注解进行了系统性的介绍。,首先，对@ComponentScans注解与@ComponentScan注解的源码和使用场景进行了简单的介绍。,随后，给出了使用@ComponentScan注解自定义过滤规则的案例，并简单列举了其他应用案例。,接下来，重点分析了@ComponentScans注解与@ComponentScan注解的源码时序图和源码执行流程。,既然学完了，就开始思考几个问题吧？,Spring扫描指定包的逻辑看起来挺复杂的，Spring为何会这样设计？,如果使用Spring的注解开发应用程序，配置类上不标注@ComponentScans注解与@ComponentScan注解，能扫描到哪些包下的类？能将标注了@Component注解的类注入的IOC容器吗？,@ComponentScan注解中的basePackages属性或者value属性可以设置任意包名吗（前提是包存在）？,