前言

先不废话了，直接干吧。

一、Spring扫描-@ComponentScan注解介绍

@ComponentScan作用

@ComponentScan注解的作用可以简述为：将项目中所有被@Component注解直接或者间接标记的类---->组装成BeanDefinition---->然后以key=beanName， value=BeanDefinition的形式存储，为后续生成bean对象做准备。

提示：被@Component注解标记的类分为两种情况，这两种情况的类都会被Spring成功扫描。1、该类直接被@Component注解标记
@Component
public class UserService {}2、该类间接被@Component注解标记（@Configuration组成注解包含@Component注解）
@Configuration
public class ProConfig {}
--
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface Configuration {@AliasFor(annotation = Component.class)String value() default "";boolean proxyBeanMethods() default true;
}

上面是说的通过扫描得到BeanDefinition对象，我们还可以通过直接定义BeanDefinition，或解析spring.xml文件的<bean/ >，或者 @Bean注解得到BeanDefinition对象。（后续章节会分析@Bean注解是怎么生成BeanDefinition的）。IOC容器创建BeanDefinition的一些常见方式

@ComponentScan重要参数

@ComponentScan中有多个参数，其中尤为重要的几个参数如下：

value：用来指定basePackage的路径；
excludeFilters：可以把被@Component标识的类排除扫描；
includeFilters：可以把不被@Component标识的类加入到扫描；

示例：

@ComponentScan(value = "com.zhouyu",excludeFilters = {@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,classes = UserService.class)},includeFilters = {@ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE,classes = User.class)})

二、Spring扫描-源码分析

声明关键点

在讲源码之前呢，我们可以先增强几个知识点的概念。这些知识点在阅读Spring扫描源码中起着关键作用。

1、@ComponentScan只会扫描被 @Component标识的类。诸如@Bean、spring.xml文件的< bean/>标签、编程式声明BeanDefinition等，都不会被@ComponentScan扫描；

2、@ComponentScan的excludeFilters和includeFilters参数影响着类是否成功被扫描。excludeFilters中指定了一个带有@Component注解的类，该类也不会被扫描；includeFilters中指定了一个不带有@Component注解的类，该类也会被扫描；

3、被@ComponentScan扫描注入到IOC容器中的BeanDefinition，其具体实现类是：ScannedGenericBeanDefinition。

4、@ComponentScan扫描涉及到的相关注解：@Conditional和@Scope和@Lookup和@Lazy、@Primary、@DependsOn、@Role、@Description。

@Conditional的作用是：即使该类被@Component修饰，但是Conditional返回false，该类也不会被成功扫描；
@Scope的作用是：仅仅作为一个标识，赋值给BeanDefinition的scope属性；
@Lookup：抽象类本身不能被扫描进容器，但是被@Lookup注解修饰则可以；
@Lazy、@Primary、@DependsOn、@Role：这几个类是一起被处理的，也只是用来给BeanDefinition赋值，分别对应着：setLazyInit(boolean)、setPrimary(boolean)、setDependsOn(value)、setRole(value)、setDescription(value)；

5、须知Resource类和MetadataReader类。

Resource[]数组对象会存储basePackage包路径下所有的class的文件对象（注意：是所有的class的文件对象都会存储，无论有没有被@Component修饰）；
MetadataReader类是Spring用来解析类的信息（比如类名、类中的方法、类上的注解、是否是抽象类…，这些都可以称之为类的元数据）的一个工具类。MetadataReader、ClassMetadata、AnnotationMetadata都可以用来解析类信息；

6、@ComponentScan扫描最终生成两个map：Map<String, BeanDefinition> beanDefinitionMap与Map<String, String> aliasMap。

beanDefinitionMap用于存储BeanDefinition，key是beanName，value是BeanDefinition；
aliasMap用于存储bean的别名，key是别名，value是beanName。@Component没有设置bean别名功能，@Bean可以设置别名。

@ComponentScan("org.example")
public class AppConfig {/*** 声明：*  如果@Bean没有设置value参数，那么beanName = "createBookService"；*  如果@Bean设置了多个value参数，那么beanName = array[0]*/@Bean({"bookService","bookService2"})public BookService createBookService(){return new BookService();}
}

7、其他：

ASM技术：为什么要使用ASM技术，Spring启动的时候需要去扫描，如果指定的包路径比较宽泛，那么扫描的类是非常多的，那如果在Spring启动时就把这些类全部加载进JVM了，这样不太好，所以使用了ASM技术；

源代码解读

源码具体位置：org.springframework.context.annotation.ClassPathBeanDefinitionScanner#doScan

protected Set<BeanDefinitionHolder> doScan(String... basePackages) {Assert.notEmpty(basePackages, "At least one base package must be specified");Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>();// 遍历basePackagesfor (String basePackage : basePackages) {// 扫描basePackages下所有的文件，进行include、exclude、@Conditional判断后返回BeanDefinitionSet<BeanDefinition> candidates = findCandidateComponents(basePackage);for (BeanDefinition candidate : candidates) {ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate); // scope解析：单例与多例candidate.setScope(scopeMetadata.getScopeName());String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry); // 生成beanName：默认是类名首字母小写，如果@Component中指定了name则使用指定的name/* ScannedGenericBeanDefinition extends GenericBeanDefinition(AbstractBeanDefinition) implements AnnotatedBeanDefinition  */// 设置BeanDefinition的默认值if (candidate instanceof AbstractBeanDefinition) {postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);}if (candidate instanceof AnnotatedBeanDefinition) {// 解析@Lazy、@Primary、@DependsOn、@Role、@DescriptionAnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);}// 检查Spring容器中是否已经存在该beanName(如果存在则抛出异常)if (checkCandidate(beanName, candidate)) {BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);definitionHolder =AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);beanDefinitions.add(definitionHolder);// 注册： beanDefinitionMap.put(beanName, beanDefinition)registerBeanDefinition(definitionHolder, this.registry);}}}return beanDefinitions;}

Spring扫描流程图

【Spring源码系列】Spring注解扫描-@ComponentScan底层原理解读相关推荐

Spring源码系列- Spring Beans - 核心类的基本介绍
Spring源码系列- Spring Beans - 核心类的基本介绍读过上一篇文章的读者应该都能对Spring的体系结构有一个大致的了解,在结尾处,我也说过会从spring-beans包开始分析, ...
【spring源码系列-05】refresh中prepareRefresh方法的执行流程
Spring源码系列整体栏目内容链接地址 [一]spring源码整体概述 https://blog.csdn.net/zhenghuishengq/article/details/13094088 ...
Spring源码系列：依赖注入（二）createBean
在Spring源码系列:依赖注入(一)(AbstractBeanFactory-getBean)最后说道getBean是依赖注入的起点,bean的创建都是通过createBean来完成具体的创建的.c ...
Ioc容器beanDefinition－Spring 源码系列（1）
Ioc容器beanDefinition-Spring 源码系列(1) 目录: Ioc容器beanDefinition-Spring 源码(1) Ioc容器依赖注入-Spring 源码(2) Ioc容器 ...
Spring源码系列(十二)Spring创建Bean的过程(二)
1.写在前面上篇博客主要Spring在创建Bean的时候,第一次调用的Bean的后置处理器的过程,同时笔者也打算将整个Spring创建的Bean的过程,通过这个系列,将Bean的创建过程给讲清楚,废 ...
Spring源码系列：BeanDefinition载入(下)
在Spring源码系列:BeanDefinition载入(上)中已经大概捋了一下解析过程,本篇将记录一下bean的注册过程. bean的注册就是DefaultListableBeanFactory中r ...
【Spring源码】Spring Transactional事务：传播机制(Propagation) 介绍和源码剖析
[Spring源码]Spring Transactional事务:传播机制(Propagation) 源码剖析关键词 AMethod调用BMethod,转载BMethod的角度来考虑:站在被调用者的 ...
spring源码分析第五天------springAOP核心原理及源码分析
spring源码分析第五天------springAOP核心原理及源码分析 1. 面向切面编程.可以通过预编译方式和运行期动态代理实现在不修改源代码的情况下给程序动态统一添加功能的一种技术切面(A ...
spring源码分析第四天------springmvc核心原理及源码分析
spring源码分析第四天------springmvc核心原理及源码分析 1.基础知识普及 2. SpringMVC请求流程 3.SpringMVC代码流程 4.springMVC源码分析 4.1 ...

【Spring源码系列】Spring注解扫描-@ComponentScan底层原理解读

这里写目录标题

前言