SpringIOC源码解析（基于注解）

缺乏、安全感 2024-04-18 20:38 30阅读 0赞

> 注意，看完这篇文章需要很长很长很长时间。。。

#### 准备工作 ####

本文会基于注解的方向分析SpringIOC模块的整体流程，在阅读本篇文章之前建议您先阅读基于XML分析的两篇文章: [SpringIOC源码解析(上)][SpringIOC]，[SpringIOC源码解析(下)][SpringIOC 1]

##### Demo工程 #####

本次源码分析的demo工程我已经准备好了，大家可自行前往以下地址下载

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 </pre></td> 
 <td><pre>https://github.com/shiyujun/spring-framework </pre></td> 
 </tr> 
 </tbody> 
</table>

本次工程复用了之前工程的包cn.shiyujun.service中的接口和实现类，同时新增了一个基于注解的配置类，此类在cn.shiyujun.config包下

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 </pre></td> 
 <td><pre>@Configuration public class AnnotationConfig {
 @Bean public IOCService iocService(){
 return new IOCServiceImpl(); } } </pre></td> 
 </tr> 
 </tbody> 
</table>

然后就是启动类了，启动类在cn.shiyujun.demo包下

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 </pre></td> 
 <td><pre>public class AnnotationIOCDemo {
 public static void main (String args[]){
 ApplicationContext context = new AnnotationConfigApplicationContext("cn.shiyujun.config"); IOCService iocService=context.getBean(IOCService.class); System.out.println(iocService.hollo()); } } </pre></td> 
 </tr> 
 </tbody> 
</table>

#### `AnnotationConfigApplicationContext`继承关系 ####

![640?wx\_fmt=png][640_wx_fmt_png]

#### 再次拿出之前的一张图片，可以看到相较于`ClassPathXmlApplicationContext`和`FileSystemXmlApplicationContext`来说`AnnotationConfigApplicationContext`这个类的辈分好像更高一些    ####

接着我们看一下它的方法

![640?wx\_fmt=png][640_wx_fmt_png 1]

我们会发现除了register注册bean的方法以外，有一个scan方法，有没有感觉很熟悉。@CompantScan用过没，他们之间什么关系，在启动类中new AnnotationConfigApplicationContext的时候传的一个包名是不是跟这个有关系？带着疑问往下看吧

#### 源码分析 ####

##### 构造方法 #####

源码分析第一站就是进入如下构造方法

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 </pre></td> 
 <td><pre>public AnnotationConfigApplicationContext(String... basePackages) {
 		this(); 		scan(basePackages); 		refresh(); 	} </pre></td> 
 </tr> 
 </tbody> 
</table>

千万不要小瞧上方简简单单的三行代码，我们整篇文章都会基于这三行代码来展开

首先看this

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 </pre></td> 
 <td><pre>public AnnotationConfigApplicationContext() {
 //注解bean读取器 		this.reader = new AnnotatedBeanDefinitionReader(this); //注解bean扫描器 		this.scanner = new ClassPathBeanDefinitionScanner(this); } </pre></td> 
 </tr> 
 </tbody> 
</table>

同时子类的构造方法执行之前肯定会先执行父类的构造方法，所以还有父类  
GenericApplicationContext的构造方法

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 </pre></td> 
 <td><pre>public GenericApplicationContext() {&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; //这个bean的相关知识请参考之前的文章 this.beanFactory = new DefaultListableBeanFactory(); } </pre></td> 
 </tr> 
 </tbody> 
</table>

##### 注册bean #####

接着看`scan`方法

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 </pre></td> 
 <td><pre>public void scan(String... basePackages) {
 		Assert.notEmpty(basePackages, "At least one base package must be specified"); 		this.scanner.scan(basePackages); } </pre></td> 
 </tr> 
 </tbody> 
</table>

可以看到这里调用的是bean扫描器`ClassPathBeanDefinitionScanner`的`scan`方法

接着往下看`doScan`方法

###### 扫描包 ######

在接着往下看之前，我们有必要先认识一个东东，MetadataReader。这个接口有三个方法

第一个返回Resource就不必多说了，就是配置类的资源对象。第二个第三个根据名字我们可以猜到是类的元数据和注解的元数据  
可以看一下它们两个的方法

![640?wx\_fmt=png][640_wx_fmt_png 2]

![640?wx\_fmt=png][640_wx_fmt_png 3]

接着往下看

###### 创建BeanDefinition ######

现在回到开始的`doScan`方法

###### 注册bean ######

到了一个比较重要的节点了，跟着上文的`registerBeanDefinition`方法走

其实这个注册bean的方法是`DefaultListableBeanFactory`的方法，之前的文章已经解析过了，大体就是下面这么个流程

<table> 
 <tbody> 
 <tr> 
 <td><pre>1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 </pre></td> 
 <td><pre>@Override public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException {
 Assert.hasText(beanName, "Bean name must not be empty"); Assert.notNull(beanDefinition, "BeanDefinition must not be null"); if (beanDefinition instanceof AbstractBeanDefinition) {
 try {
 ((AbstractBeanDefinition) beanDefinition).validate(); } catch (BeanDefinitionValidationException ex) {
 throw new BeanDefinitionStoreException(...); } } BeanDefinition oldBeanDefinition; // 所有的 Bean 注册后都会被放入到这个beanDefinitionMap 中，查看是否已存在这个bean oldBeanDefinition = this.beanDefinitionMap.get(beanName); // 处理重复名称的 Bean 定义的情况 if (oldBeanDefinition != null) {
 if (!isAllowBeanDefinitionOverriding()) {
 // 如果不允许覆盖的话，抛异常 throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName, 					"Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName + 						"': There is already [" + oldBeanDefinition + "] bound."); } else if (oldBeanDefinition.getRole() &lt; beanDefinition.getRole()) {
 // 用框架定义的 Bean 覆盖用户自定义的 Bean 		if (this.logger.isWarnEnabled()) {
 					this.logger.warn("Overriding user-defined bean definition for bean '" + beanName + 							"' with a framework-generated bean definition: replacing [" + 							oldBeanDefinition + "] with [" + beanDefinition + "]"); 				} } else if (!beanDefinition.equals(oldBeanDefinition)) {
 // 用新的 Bean 覆盖旧的 Bean 	if (this.logger.isWarnEnabled()) {
 					this.logger.warn("Overriding user-defined bean definition for bean '" + beanName + 							"' with a framework-generated bean definition: replacing [" + 							oldBeanDefinition + "] with [" + beanDefinition + "]"); 				} } else {
 // log...用同等的 Bean 覆盖旧的 Bean 	if (this.logger.isInfoEnabled()) {
 					this.logger.info("Overriding bean definition for bean '" + beanName + 							"' with a different definition: replacing [" + oldBeanDefinition + 							"] with [" + beanDefinition + "]"); 				} } // 覆盖 this.beanDefinitionMap.put(beanName, beanDefinition); } else {
 // 判断是否已经有其他的 Bean 开始初始化了.注意，"注册Bean" 这个动作结束，Bean 依然还没有初始化 在 Spring 容器启动的最后，会 预初始化 所有的 singleton beans if (hasBeanCreationStarted()) {
 // Cannot modify startup-time collection elements anymore (for stable iteration) synchronized (this.beanDefinitionMap) {
 this.beanDefinitionMap.put(beanName, beanDefinition); List&lt;String&gt; updatedDefinitions = new ArrayList&lt;String&gt;(this.beanDefinitionNames.size() + 1); updatedDefinitions.addAll(this.beanDefinitionNames); updatedDefinitions.add(beanName); this.beanDefinitionNames = updatedDefinitions; if (this.manualSingletonNames.contains(beanName)) {
 Set&lt;String&gt; updatedSingletons = new LinkedHashSet&lt;String&gt;(this.manualSingletonNames); updatedSingletons.remove(beanName); this.manualSingletonNames = updatedSingletons; } } } else {
 // 将 BeanDefinition 放到这个 map 中，这个 map 保存了所有的 BeanDefinition this.beanDefinitionMap.put(beanName, beanDefinition); // 这是个 ArrayList，所以会按照 bean 配置的顺序保存每一个注册的 Bean 的名字 this.beanDefinitionNames.add(beanName); // 这是个 LinkedHashSet，代表的是手动注册的 singleton bean， this.manualSingletonNames.remove(beanName); } this.frozenBeanDefinitionNames = null; } if (oldBeanDefinition != null || containsSingleton(beanName)) {
 resetBeanDefinition(beanName); } } </pre></td> 
 </tr> 
 </tbody> 
</table>

现在回到文章开始的三句代码

可以看到，只剩最后一个`refresh()`方法了，如果看过之前文章的同学可能都已经知道这里面是什么东西了

##### `refresh()` #####

首先整个方法进来以后跟使用XML的时候是一样的

###### 与XML的不同点 ######

`obtainFreshBeanFactory()`方法  
还记得在之前的文章中列出了好几万行代码来解析这个方法，但是回忆一个这个方法是干啥的来着，创建bean容器，但是呢，bean容器在scan方法里就已经创建好了，所以这里就没必要再进行额外的逻辑了，你看现在它的代码现在多简单

再接下来，其实就没了，有一个重点就是初始化，但是初始化逻辑是放在这个Spring家族的超级富二代`DefaultListableBeanFactory`身上的。

#### 心得体会 ####

源码阅读入门很难，面对几十兆几百兆的代码不是一时半会就能看明白的，也不是一遍两遍debug就能搞懂的。阅读源码，一定要静下心来花上几个小时甚至几天的时间来钻研。

一通百通，当你研究明白一部分以后，再去看另外的部分，就好像有人推着你走一样，无比的顺利

![640?wx\_fmt=gif][640_wx_fmt_gif]

不得不看

1.[SpringCloud系列博客汇总][SpringCloud]

2.[为啥一线大厂面试必问Redis，有啥好问的？][Redis]

3.[Java多线程面试必备基础知识汇总][Java]

4.[Java集合源码分析汇总][Java 1]

5.[Linux常用命令汇总][Linux]

6.[JVM系列文章汇总][JVM]

7.[MySQL系列文章汇总][MySQL]

8.[RabbitMQ系列文章汇总][RabbitMQ]

![640?wx\_fmt=jpeg][640_wx_fmt_jpeg]

[SpringIOC]: https://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484561&idx=1&sn=a7281dae7aaaa3499d59dec730464e63&scene=21#wechat_redirect
[SpringIOC 1]: https://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484564&idx=1&sn=84bd8fee210c0d00687c3094431482a7&scene=21#wechat_redirect
[640_wx_fmt_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/00cdbad0f9b2477f974ae9e6ec75b94f.png
[640_wx_fmt_png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/06a3cecdc049442fb45214d8ec10e946.png
[640_wx_fmt_png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/732c168dd51d4af891a2a12260b66cee.png
[640_wx_fmt_png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/3fc0ec147ca144989e689902ccb56e37.png
[640_wx_fmt_gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/dbde86713bbb4361aca02a201d3fae99.gif
[SpringCloud]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484030&idx=1&sn=7ad29239aca876e29155f5b1439281bb&chksm=fe396840c94ee156adfcd44c63a3b5c1cf93805cf592ad7d45bc5222c349ba6f552b553a5c09&scene=21#wechat_redirect
[Redis]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484172&idx=1&sn=cad78126f0367dbd67e0336b0b369b5d&chksm=fe396932c94ee0248ce1527844d9664a01e29a43b11b1910aa415facdc569c82a63cb07e44cf&scene=21#wechat_redirect
[Java]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484030&idx=2&sn=ddf120fcbfc45238e64662fd183156de&chksm=fe396840c94ee156a80b744033ac34d67e331545193d2f9d4f2943995aa4412a53fec023d599&scene=21#wechat_redirect
[Java 1]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484098&idx=1&sn=ba605ae1b35d6f2a8caef5901f0b86f6&chksm=fe3968fcc94ee1ea2493ce7faaab40316fa3954effa1613165b47955f5c097ef96c400b1485b&scene=21#wechat_redirect
[Linux]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484117&idx=1&sn=b4c6eb9b4027390767e92efad018a08e&chksm=fe3968ebc94ee1fdf40b5192f574b0e7cdc176663411c7f9f44c814a71a14139c510b0c35bf2&scene=21#wechat_redirect
[JVM]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484238&idx=1&sn=a30cd56a84f93da11bf916591612ef8d&chksm=fe396970c94ee066ef23c65375f88dd6ff727fd1c03c60ba61d1a9072a879cbb54084f779107&scene=21#wechat_redirect
[MySQL]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484315&idx=1&sn=8aaa78331f58909420c5e1d283d070e1&chksm=fe3969a5c94ee0b38f5152157b187f136a8dcb283039a715e8161d2e5fa98de92b66d0522cb4&scene=21#wechat_redirect
[RabbitMQ]: http://mp.weixin.qq.com/s?__biz=MzU5MDgzOTYzMw==&mid=2247484392&idx=1&sn=700f4eb1b4b3ca3ac29f1445a3a3f79c&chksm=fe3969d6c94ee0c019e758880cc53d57496f6f104d76231d1e3eea8973558db5cc30611f8154&scene=21#wechat_redirect
[640_wx_fmt_jpeg]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/27189c8bf724445d9ab3b5874cab83af.png