愿你归来时,仍是少年
Spring的模块划分参考上一篇:Spring源码1 -Spring模块总览
有些书籍在开篇时,会让我们去下载Spring的源码,不过我觉得用maven直接创建项目,然后再引入需要的包,用maven下载源码也挺方便的,这里就不介绍怎么去下整个源码了,带着一些问题从一个最简单的例子开始。
1. 第一个例子
测试功能:先定义一个最简单的javaBean,然后通过xml的方式进行配置,并在程序中读取并使用该bean
简单分析下,这里只用到了Spring最基础的功能,即spring-beans模块,那么,我们新建一个项目,引入spring-beans模块即可。这里为了测试还引入了junit,maven项目的pom文件如下:
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.test</groupId>
<artifactId>springStudy</artifactId>
<version>1.0-SNAPSHOT</version>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-framework-bom</artifactId>
<version>5.1.8.RELEASE</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
<dependencies>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
</dependency>
</dependencies>
</project>
上面的<dependencyManagement> 依赖管理在上一节有提到过,spring为了减少版本混乱引起的问题,提供了一个依赖管理的bom,定义了一个Spring版本的所有内部组件的版本,下面在<dependencies>中直接引用spring-beans模块即可
上面的模块引入之后,直接在idea中maven里面把这个模块的源码下下来即可,后面调试的时候就可以看到带注释的源码了
定义一个javaBean,下面看到这个bean只有一个field,和getter&setter
public class MyTestBean {
private String testStr = "testStr";
public String getTestStr() {
return testStr;
}
public void setTestStr(String testStr) {
this.testStr = testStr;
}
}
新建一个配置文件,引入这个bean
spring-beans.xml
<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd">
<bean id="myTestBean" class="basic.MyTestBean"/>
</beans>
下面是测试类,测试一下定义的bean是否可以正常使用
package basic;
import org.junit.Assert;
import org.junit.Test;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.xml.XmlBeanFactory;
import org.springframework.core.io.ClassPathResource;
/**
* Describe ***
* Created by zhanjp on 2018/6/7
*/
public class BeanFactoryTest {
@Test
public void testSimpleLoad(){
BeanFactory bf = new XmlBeanFactory(new ClassPathResource("spring-beans.xml"));
MyTestBean bean = (MyTestBean) bf.getBean("myTestBean");
Assert.assertEquals("testStr", bean.getTestStr());
}
}
运行后,可以看到测试正常
可以看到程序的大体逻辑为,告诉Spring要加载哪些beans,然后Spring根据配置生成了一个Bean的工厂,后面获取Bean是通过这个工厂类得到的。
我们没有去new一个实例,而是把控制权转给了spring
下面看看Spring是怎么把我们定义的配置文件,解析为一个BeanFactory的。
2. 追踪源码
2.1 代码1
new ClassPathResource("spring-beans.xml")
首先这句代码,字面上理解就是加载一个类路径下的资源文件,进入源码
注释说明了这里创建了一个ClassPathResource,并使用一个thread context 类加载器去加载这个资源,即最后一行的ClassUtils.getDefaultClassLoader()
关于类加载器,可以看我的另外一篇博客https://mp.csdn.net/postedit/98119054
一般的类加载器,大部分采用双亲委派机制,而这里使用了一个线程上下文类加载器,是一个破坏双亲委派机制的做法,因为spring要读取我们程序里面的资源
到此为止,我们可以看到ClassPathResource这个类做的事情还是比较简单的,把我们传的参数整理了一下,然后存到对象的属性里面,和生成了一个class context 的类加载器。
那么ClassPathResource这个类出了hold住这两个对象,还要做什么功能呢?看下类结构图
我们进入Resource接口中看一眼,它定义了所有Resource类提供的方法
内容不是很多,我们大概看方法名了解一下,然后继续分析后面的代码
2.2 代码2
这里初始化了一个XmlBeanFactory对象,先了解下XmlBeanFactory
类结构图:
从类图来看,这个类相当的复杂,顶层有不少的接口,BeanFactory、SingletenBeanRegistry、AliasRegistry,但是可以看到XmlBeanFactory直接继承于DefaultListableBeanFactory,这个类对上面的接口做了大量的实现,只留了一小部分工作给XmlBeanFactory。
另外,可以看到XmlBeanFactory已经不被推荐使用了,类上面的注释告诉我们,从Spring3.1开始,更推荐使用DefaultListableBeanFactory和XmlBeanDefinitionReader这两个类。
由于上面的类过多且庞大,暂时不细致的去说,先看看XmlBeanFactory干了什么。
这里我们可以看到,XmlBeanFactory做的事情也很简单,最关键的一行代码,
this.reader.loadBeanDefinitions(resource);
通过一个Resource去加载Bean的定义。这个过程委托给了XmlBeanDefinitionReader这个类,而这个类的构造参数是this,说明这个Reader也依赖了当前的BeanFactory。
看到这里有些疑问了,XmlBeanFactory和XmlBeanDefinitionReader互相依赖,Factory构造的时候需要reader属性,而Reader在构建的时候又需要XmlBeanFactory。
实际上reader只是一个普通的属性,而非静态属性,所以,当类初始化完成后,this已经存在,可以被用来生成XmlBeanDefinitionReader。如果reader属性是个静态属性,就不能这么玩了。可以看下面
下面进入XmlBeanDefinitionReader类看一看,还是先看结构图
顶层有两个接口,EnvironmentCapable和BeanDefinitionReader,前一个里面只有一个方法,获取当前组件关联的Environment,主要看一下第二个接口
主要包括,获取BeanDefinition注册表、获取资源加载器、获取Bean的类加载器、获取Bean的名称生成器和加载Bean的定义的几个方法。
而XmlBeanDefinitionReader这个类就比较复杂了,毕竟从XML里面加载Bean的大部分代码都在这里,先跟到代码里看看
loadBeanDefinition方法没什么特殊的,就一个Resouce参数,转成了EncodedResouce,这个类里面主要是对特殊的编码进行处理,而我们没有做什么特殊编码的函数,可以直接先把当成一个Resouce来看。
直接看320行代码,
resourcesCurrentlyBeingLoaded的初始化如下
NamedThreadLocal只是ThreadLocal的一个简单的子类,多了一个name的属性,大概是描述这个ThreadLocal变量是干嘛用的。
可以看出,这个变量是为了保存已经加载的resouce资源。
继续往下看
325行,Spring尝试把当前加载的资源文件放入已加载集合中,由于可能会有循环的import,碰到互相import的情况,这里就会直接抛出异常了。可以看出这个集合的作用是防止循环引用变成死循环。
那下面可以看到最重要的地方了,
先从resouce中获取输入流,还记得 2.1 new ClassPathResouce的时候,还初始化了一个线程上下文类加载器吗?进入getInputStream,可以看到
隐藏的还挺深的,这也是为什么看源码这么让人头疼的地方,毕竟不是自己写的。。
好了,继续,根据这个InputStream,332行初始化了一个InputSource,并设置了编码。额,我们并没有给什么编码,就认为InputSource就是个InputStream吧。
下面就进入了336行
doLoadBeanDefinitions(inputSource, encodedResource.getResource());
开始加载bean的定义!
跟进代码,这里先是根据输入流和Resouce初始化了一个Document类,这就是根据Xml解析出来的对象了。下面一行就是根据这个document解析并把Bean的定义注册到Registry中了,并返回加载的数量。
这也是Spring加载Bean的最重要的两个逻辑了
- Spring如何去解析Xml
- Spring如何去注册Bean
3. Spring如何解析Xml?
首先进入代码
Spring把加载XML资源的活全都委托给了documentLoader这个对象,这个对象的类型是DefaultDocumentLoader,实现了DocumentLoader接口。而DocumentLoader接口只有这一个实现类,可见这个DocumentLoader就是专门干加载Xml资源这个活的。
接下来看看DefaultDocumentLoader类里面的代码
这里的类结构大概可以看到,其实spring主要的解析Xml的方法,就是loadDocument这个方法,另外包含了两个protected方法,和两个静态变量,
这两个静态变量分别用来配置如何验证schema语言,和表示XSD schema语言的。从描述来看,是给JAXP验证XML用的两个属性。
真正去解析xml的代码,先创建了一个DocumentBuilderFactory然后再创建了一个DocumentBuilder,这两个类都是javax.xml.parser包下面的,可见spring用来解析xml正式依赖了java系统的javax.xml.parser包,而这个包正是JAXP下面的,什么是JAXP呢?就是Java api for xml processing,为处理xml而制定的一套javaAPI。下面是JAXP的官方文档:
https://docs.oracle.com/javase/8/docs/technotes/guides/xml/jaxp/
文档的最下面还有一些jaxp提供的一些教程,这里也贴一下
https://docs.oracle.com/javase/tutorial/jaxp/index.html
可以看到上面的代码里,需要的5个参数都是jaxp的参数,所以Spring解析XML而写的DefaultDocumentLoader是为了解析XML而专门包装的工具类。
XML涉及的东西过多,这里不再详细介绍,有机会后面再写一些使用JAXP的例子。相信有一些小例子更容易使我们理解Spring的解析XML的内容。
下一篇博客继续