【Spring源码】- 01 Spring IoC容器启动之this方法-天天头条

开始案例

1、定义两个Service Bean

package org.source.ioc.basic.demo02;public class TestService01 {}
import org.springframework.stereotype.Component;@Componentpublic class TestService02 {}
package org.source.ioc.basic.demo02;public class TestService03 {}

2、定义Configuration


(资料图)

package org.source.ioc.basic.demo02;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.ComponentScan;import org.springframework.context.annotation.Configuration;import org.springframework.context.annotation.Import;@Configuration@ComponentScan(basePackageClasses = {TestConfig.class})@Import(TestService03.class)public class TestConfig { @Bean public TestService01 testService01(){  return new TestService01(); }}

3、测试代码

public class MainDemo { @Test public void test01(){  AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(TestConfig.class);  Arrays.stream(context.getBeanDefinitionNames()).forEach(System.out::println);  //Arrays.stream(context.getBeanDefinitionNames()).forEach(x -> System.out.println(x+"->"+context.getBean(x))); }}

输出结果:

org.springframework.context.annotation.internalConfigurationAnnotationProcessororg.springframework.context.annotation.internalAutowiredAnnotationProcessororg.springframework.context.annotation.internalCommonAnnotationProcessororg.springframework.context.event.internalEventListenerProcessororg.springframework.context.event.internalEventListenerFactorytestConfigtestService02org.source.ioc.basic.demo02.TestService03testService01

通过上面的输出结果可以看出,三个TestService都被纳入了Spring IoC容器中,但却是通过三种不同方式实现的,@ComponentScan@Import@Bean,从输入结果来看,IoC容器中除了自定义的类外,还有几个非我们自定义的Bean,它们又是从哪里引入的、引入进来又有什么用呢?下面我们就通过源码方式分析下IoC的启动流程,看看IoC容器启动的背后到底隐藏了哪些玄机。

Reader

new AnnotationConfigApplicationContext(TestConfig.class)这一句测试代码就可以驱动IoC启动,非常的简单,下面我们就来研究下隐藏在这一句代码的背后Spring到底做了哪些工作。

public AnnotationConfigApplicationContext(Class... componentClasses) { this(); register(componentClasses); refresh();}

这个构造方法代码非常简单,主要逻辑封装在三个方法中,首先我们来看下this()这个方法。

public AnnotationConfigApplicationContext() { this.reader = new AnnotatedBeanDefinitionReader(this); this.scanner = new ClassPathBeanDefinitionScanner(this);}

AnnotatedBeanDefinitionReaderClassPathBeanDefinitionScannerSpring中两个非常重要的类。

首先,我们来看下AnnotatedBeanDefinitionReader这个类,@Configuration@Import@Autowired@Bean等等这些Spring中常用注解可以很神奇的为我们实现各种功能,注解本身是没有任何意义的,核心在于隐藏在这些注解背后的处理逻辑,AnnotatedBeanDefinitionReader就是这个隐藏在注解背后的处理逻辑,可以实现对Spring中常用注解的解析处理。

public AnnotatedBeanDefinitionReader(BeanDefinitionRegistry registry, Environment environment) { Assert.notNull(registry, "BeanDefinitionRegistry must not be null"); Assert.notNull(environment, "Environment must not be null"); this.registry = registry; //条件比较器,用于处理@Condition注解 this.conditionEvaluator = new ConditionEvaluator(registry, environment, null); AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry);}

AnnotatedBeanDefinitionReader构造方法中最关键的是在最后一句代码,其源码核心见下:

public static Set registerAnnotationConfigProcessors(   BeanDefinitionRegistry registry, @Nullable Object source) {        ...//省略  Set beanDefs = new LinkedHashSet<>(8);  if (!registry.containsBeanDefinition(CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME)) {   RootBeanDefinition def = new RootBeanDefinition(ConfigurationClassPostProcessor.class);   def.setSource(source);   beanDefs.add(registerPostProcessor(registry, def, CONFIGURATION_ANNOTATION_PROCESSOR_BEAN_NAME));  }  if (!registry.containsBeanDefinition(AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME)) {   RootBeanDefinition def = new RootBeanDefinition(AutowiredAnnotationBeanPostProcessor.class);   def.setSource(source);   beanDefs.add(registerPostProcessor(registry, def, AUTOWIRED_ANNOTATION_PROCESSOR_BEAN_NAME));  }  if (jsr250Present && !registry.containsBeanDefinition(COMMON_ANNOTATION_PROCESSOR_BEAN_NAME)) {   RootBeanDefinition def = new RootBeanDefinition(CommonAnnotationBeanPostProcessor.class);   def.setSource(source);   beanDefs.add(registerPostProcessor(registry, def, COMMON_ANNOTATION_PROCESSOR_BEAN_NAME));  }  if (jpaPresent && !registry.containsBeanDefinition(PERSISTENCE_ANNOTATION_PROCESSOR_BEAN_NAME)) {   RootBeanDefinition def = new RootBeanDefinition();   try {    def.setBeanClass(ClassUtils.forName(PERSISTENCE_ANNOTATION_PROCESSOR_CLASS_NAME,      AnnotationConfigUtils.class.getClassLoader()));   }   catch (ClassNotFoundException ex) {    throw new IllegalStateException(      "Cannot load optional framework class: " + PERSISTENCE_ANNOTATION_PROCESSOR_CLASS_NAME, ex);   }   def.setSource(source);   beanDefs.add(registerPostProcessor(registry, def, PERSISTENCE_ANNOTATION_PROCESSOR_BEAN_NAME));  }  if (!registry.containsBeanDefinition(EVENT_LISTENER_PROCESSOR_BEAN_NAME)) {   RootBeanDefinition def = new RootBeanDefinition(EventListenerMethodProcessor.class);   def.setSource(source);   beanDefs.add(registerPostProcessor(registry, def, EVENT_LISTENER_PROCESSOR_BEAN_NAME));  }  if (!registry.containsBeanDefinition(EVENT_LISTENER_FACTORY_BEAN_NAME)) {   RootBeanDefinition def = new RootBeanDefinition(DefaultEventListenerFactory.class);   def.setSource(source);   beanDefs.add(registerPostProcessor(registry, def, EVENT_LISTENER_FACTORY_BEAN_NAME));  }  return beanDefs; }

其逻辑很简单,就是向IoC中注册一个BeanFactoryPostProcessor和5个BeanPostProcessorSpring就是通过这些PostProcessor扩展点实现对各种注解的解析、处理,让开发只需要简单的几个注解就可以实现很多复杂功能,屏蔽了注解背后处理的复杂逻辑,这也是目前Spring开发趋势:注解驱动开发。

这几个PostProcessor大致作用:

ConfigurationClassPostProcessor:完成@Configuration@Import@ComponentScan@Component@Bean等注解支持,该类主要完成完成BeanDefinition的采集工作,就是解析各种注解,把需要纳入Spring管理的Bean都采集到一起生成BeanDefinition存储起来,供后续生成对象提供所需的材料;AutowiredAnnotationBeanPostProcessor:完成@Autowired@Value注解支持,实现Spring中依赖注入的核心逻辑;CommonAnnotationBeanPostProcessor:支持JSR-250的一些注解,如:@Resource@PostConstruct@PreDestroy等;PersistenceAnnotationBeanPostProcessor:支持JPA中相关注解的支持;EventListenerMethodProcessorDefaultEventListenerFactory:这两个类主要完成对Spring4.2之后引入的@EventListener等事件注解支持;

上面六个PostProcessor中,最重要的是前两个,一个负责完成从各个地方把需要纳入IoC管理的Bean都收集到一起;另一个则完成对这些收集的Bean进行依赖注入。Spring IoC基本工作就是管理Bean以及依赖注入,所以IoC启动流程分析中,这两个类占有很大的比重。

Scanner

下面再来看下另一个非常重要的类:ClassPathBeanDefinitionScanner

Spring项目中配置@ComponentScan(basePackages="a.b.c"),这背后的工作就是靠ClassPathBeanDefinitionScanner完成,其主要就是完成对指定包路径下的Bean进行扫描,把含有特定注解的Bean生成BeanDefinition注册到IoC容器中。

下面通过一个Demo了解下ClassPathBeanDefinitionScanner基本使用:

@Testpublic void classPathBeanDefinitionScannerTest(){ String BASE_PACKAGE = "org.source.ioc.basic.demo02.scanner"; //1.创建一个IoC容器,用于装载ClassPathBeanDefinitionScanner扫描出的BeanDefinition SimpleBeanDefinitionRegistry registry= new SimpleBeanDefinitionRegistry(); /** * 2.创建一个Scanner扫描器,useDefaultFilters:是否使用默认过滤器,默认该值为true, * 即会把@Component注解的Bean都扫描出来,这里我们不需要这个功能,只需要扫描我们自定义注解的Bean */ ClassPathBeanDefinitionScanner scanner = new ClassPathBeanDefinitionScanner(registry, false); //3.这里注册一个注解类型过滤器,完成对自定义注解Bean过滤 scanner.addIncludeFilter(new AnnotationTypeFilter(MyComponent.class)); /** * 4.是否向IoC中注册用于用于处理核心注解的6个PostProcessor,默认true * AnnotationConfigUtils.registerAnnotationConfigProcessors(this.registry) */ scanner.setIncludeAnnotationConfig(false); //5.上面工作都准备完成,调用scan(String... basePackages)即可对指定的包路径下的Bean扫描过滤,返回值是扫描出的Bean数量 int beanCount = scanner.scan(BASE_PACKAGE); //6.scan()方法会把符合要求的Bean生成BeanDefinition并注册到IoC容器中,我们就可以从IoC容器中获取到这些BeanDefinition String[] beanDefinitionNames = registry.getBeanDefinitionNames(); System.out.println("bean count:"+beanCount); Arrays.stream(beanDefinitionNames).forEach(System.out::println);}

上面案例就可以完成扫描org.source.ioc.basic.demo02.scanner包下的所有Bean,将含有@MyComponent注解的Bean生成对应的BeanDefinition,并注册到IoC容器中。

ClassPathBeanDefinitionScannerSpring中非常重要的一个类,决定了哪些类需要被纳入IoC容器。我们可以继承ClassPathBeanDefinitionScanner实现框架定制化功能,比如MyBatisMapper扫描就是一个典型应用案例,MyBatisMapperScannerConfigurer的内部就使用到一个ClassPathBeanDefinitionScanner的子类,实现将Mapper接口文件注入到IoC容器中。

public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) { if (this.processPropertyPlaceHolders) {      processPropertyPlaceHolders();    }    ClassPathMapperScanner scanner = new ClassPathMapperScanner(registry);    scanner.setAddToConfig(this.addToConfig);    scanner.setAnnotationClass(this.annotationClass);    scanner.setMarkerInterface(this.markerInterface);    scanner.setSqlSessionFactory(this.sqlSessionFactory);    scanner.setSqlSessionTemplate(this.sqlSessionTemplate);    scanner.setSqlSessionFactoryBeanName(this.sqlSessionFactoryBeanName);    scanner.setSqlSessionTemplateBeanName(this.sqlSessionTemplateBeanName);    scanner.setResourceLoader(this.applicationContext);    scanner.setBeanNameGenerator(this.nameGenerator);    scanner.setMapperFactoryBeanClass(this.mapperFactoryBeanClass);    if (StringUtils.hasText(lazyInitialization)) {      scanner.setLazyInitialization(Boolean.valueOf(lazyInitialization));    }    scanner.registerFilters();    scanner.scan(        StringUtils.tokenizeToStringArray(this.basePackage, ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS));}

ClassPathMapperScanner继承ClassPathBeanDefinitionScanner,完成@MapperScan注解支持,将特定的Mapper类生成BeanDefinition注册到IoC容器中,这样我们才能通过@Autowired依赖注入Service类中。

MyBatisMapper类是一个接口,而依赖注入获取到的是一个对象,这是如何做到的?这里主要运用了动态代理功能,具体可以参见后续MyBatis Mapper实现原理分析。

注意:AnnotationConfigApplicationContext中定义的:this.scanner = new ClassPathBeanDefinitionScanner(this);,这个其实一般情况下是没有使用的,只有手工调用AnnotationConfigApplicationContext#scan()才会使用到scanner。大部分Bean的采集工作是AnnotatedBeanDefinitionReader中向IoC注册的ConfigurationClassPostProcessor这个BeanFactory后置处理器完成的,它在处理@ComponentScan注解时会重新创建一个ClassPathBeanDefinitionScanner实例,而不是使用AnnotationConfigApplicationContext.scanner这个,这里要特别注意下,避免修改却发现没有起作用的尴尬。

标签:

最近更新

【Spring源码】- 01 Spring IoC容器启动之this方法-天天头条
2023-03-29 09:22:34
【环球播资讯】公募基金积极配置,北交所公司迎来活水
2023-03-29 08:09:21
世界真美好歌词及动作_世界真美好的歌词-今日快讯
2023-03-29 06:54:42
百普赛斯(301080):3月28日北向资金减持4.28万股
2023-03-29 03:51:46
七下历史知识点整理人教版(七下历史知识点总结人教版)|环球新动态
2023-03-28 23:06:04
我发现互联网工作的性价比还在持续走低,没看到好转的迹象
2023-03-28 22:12:06
竞争激烈!常规赛还有最后12个比赛日 仅6队获季后赛席位&4队出局-全球报道
2023-03-28 19:58:33
兰州跨境电商公服平台对阿里巴巴国际站进行访谈
2023-03-28 19:23:12
第八批国家组织药品集中采购明日将开标,肝素类产品首次被纳入
2023-03-28 18:21:35
佛山顺德自然科学馆国庆放假吗?(附防疫要求)_全球新消息
2023-03-28 17:35:07
环球热消息:每天吃一次绿豆汤可以吗?
2023-03-28 16:42:55
钓鱼台国宾馆今天再释放关键信息! 快看
2023-03-28 15:49:40
襄城县农业农村局组织召开学习贯彻党的二十大精神分组讨论会 热点评
2023-03-28 14:50:30
世界快看点丨2023年北京失业保险金领取条件,流程,资料大全
2023-03-28 12:55:39
深圳外贸“新三样” 出口增长迅猛
2023-03-28 11:47:04
上海大华挺进北京土地市场
2023-03-28 10:36:20
虎牙坦克世界视频解说_虎牙坦克世界
2023-03-28 09:27:06
【家国同春】中国式现代化的“郑州图景”大型系列报道第八篇章 “环境保护”之三:信有山林在市城_世界通讯
2023-03-28 08:16:43
开心汽车(KXIN.US)3月27日收盘报0.38美元/股,涨4.97%-世界即时
2023-03-28 05:55:10
工信部部长金壮龙:加快产业链供应链智能化绿色化升级
2023-03-28 01:20:37
合肥城建(002208):第七届第三十七次董事会会议决议,审议《关于注销全资子公司的议案》(《关于注销全资子公司的公告》
2023-03-27 22:11:40
【全球聚看点】餐饮消费加速回暖 活力涌动人气旺
2023-03-27 20:36:28
全球快讯:加强医生协作 为签约居民提供“一站式”全专结合服务
2023-03-27 19:17:16
漕运总督_关于漕运总督介绍 环球看点
2023-03-27 17:47:25
成都先导(688222)龙虎榜数据(03-27)
2023-03-27 16:47:46
MySQL架构特征笔记
2023-03-27 15:24:11
国际油价持续下跌 国内成品油是否将迎来今年“第3次”下调?
2023-03-27 14:01:05
北京师范大学自考本科专业有哪些 中山大学自考本科专业-天天时讯
2023-03-27 12:16:09
北京等城市开启今年首轮土地出让 天天观速讯
2023-03-27 11:10:26
河钢集团与必和必拓签署钢铁行业CCUS工业示范项目合作协议|环球报道
2023-03-27 10:07:26