【Spring源码系列】Spring扫描注解-@ComponentScan底层原理解读
创始人
2024-03-09 14:27:11

这里写目录标题

    • 前言
  • 一、Spring扫描-@ComponentScan注解介绍
    • @ComponentScan作用
    • @ComponentScan重要参数
  • 二、Spring扫描-源码分析
    • 声明关键点
    • 源代码解读
    • Spring扫描流程图

前言

先不废话了,直接干吧。

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

@ComponentScan作用

@ComponentScan注解的作用可以简述为:将项目中所有被@Component注解标记的类---->组装成BeanDefinition---->然后以key value的形式注入到IOC容器中。

@ComponentScan重要参数

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

  1. value:用来指定basePackage的路径;
  2. excludeFilters:可以把被@Component标识的类排除注入到IOC容器;
  3. includeFilters:可以把不被@Component标识的类注入到IOC容器中;

示例:

@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的excludeFiltersincludeFilters参数影响着类是否注入IOC容器。excludeFilters中指定了一个带有@Component注解的类,该类也不会注入到容器中;includeFilters中指定了一个不带有@Component注解的类,该类也会注入到容器中;

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

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

  • @Conditional的作用是:即使该类被@Component修饰,但是Conditional返回false,该类也不会注入到IOC容器;
  • @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 beanDefinitionMapMap aliasMap

  • beanDefinitionMap用于存储BeanDefinition,key是beanName,value是BeanDefinition;
  • aliasMap用于存储bean的别名,key是别名,value是beanName。@Component没有设置bean别名功能,@Bean可以设置别名。
@ComponentScan("org.example")
public class AppConfig {/*** 声明:*  如果@Bean没有设置value参数,那么IOC中beanName = "createBookService";*  如果@Bean设置了多个value参数,那么IOC中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 doScan(String... basePackages) {Assert.notEmpty(basePackages, "At least one base package must be specified");Set beanDefinitions = new LinkedHashSet<>();// 遍历basePackagesfor (String basePackage : basePackages) {// 扫描basePackages下所有的文件,进行include、exclude、@Conditional判断后返回BeanDefinitionSet 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扫描流程图

在这里插入图片描述

相关内容

热门资讯

埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
应用未安装解决办法 平板应用未... ---IT小技术,每天Get一个小技能!一、前言描述苹果IPad2居然不能安装怎么办?与此IPad不...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...
脚上的穴位图 脚面经络图对应的... 人体穴位作用图解大全更清晰直观的标注了各个人体穴位的作用,包括头部穴位图、胸部穴位图、背部穴位图、胳...
世界上最漂亮的人 世界上最漂亮... 此前在某网上,选出了全球265万颜值姣好的女性。从这些数量庞大的女性群体中,人们投票选出了心目中最美...
猫咪吃了塑料袋怎么办 猫咪误食... 你知道吗?塑料袋放久了会长猫哦!要说猫咪对塑料袋的喜爱程度完完全全可以媲美纸箱家里只要一有塑料袋的响...
demo什么意思 demo版本... 618快到了,各位的小金库大概也在准备开闸放水了吧。没有小金库的,也该向老婆撒娇卖萌服个软了,一切只...
埃菲尔铁塔在哪 中国仿建埃菲尔... 2019年4月26日,广西南宁市,街头惊现一座巨型山寨版埃菲尔铁塔,高约20米,白色塔身,造型逼真,...
北京的名胜古迹 北京最著名的景... 北京从元代开始,逐渐走上帝国首都的道路,先是成为大辽朝五大首都之一的南京城,随着金灭辽,金代从海陵王...
苗族的传统节日 贵州苗族节日有... 【岜沙苗族芦笙节】岜沙,苗语叫“分送”,距从江县城7.5公里,是世界上最崇拜树木并以树为神的枪手部落...
长白山自助游攻略 吉林长白山游... 昨天介绍了西坡的景点详细请看链接:一个人的旅行,据说能看到长白山天池全凭运气,您的运气如何?今日介绍...