本节跟踪使用XmlBeanFactory容器时的启动阶段, 即包括:
- 使用BeanDefinitionReader从xml文件中读取BeanDefinition。
- 将BeanDefinition注册到容器中
- 通过BeanFactoryPostProcessor对BeanDefinition做后置处理
如何学习和阅读源码
从本章起开始系统的学习框架源码，因为学习的目标框架都是非常成熟，优秀的框架，提供了某个领域的解决方案，且贡献者都是顶级开发者，所以源码会逻辑复杂，且代码量很大。如果不遵循一些好的阅读实践，很容易迷失在源码的细节中，最后不得不放弃。
首先为什么阅读源码重要？为什么不是只看开发文档即可。因为仅看文档只能靠猜测或推导实现，是不准确的，会有很多误解，且容易造成死记硬背，如果深入源码就会豁然开朗。
其次代码会告知细节，这是文档覆盖不了的。细节是魔鬼，往往细节决定成败。
读文档 vs 读源码
如果想了解一种思想，方法，原理和经验，读书和文档更有效率。
如果想了解具体细节，如某模块的性能，某个算法的实现，就需要读代码。
如何阅读源码
在阅读之前，要有以下前提，读起来才会顺畅
1）基础知识。 相关语言和基础技术的知识
2）软件功能。 哪些功能，特性，配置项，读一遍手册，能跑起来，自己先用一下，感受一下。
3) 相关文档。quickStart, readme, release notes, design，wiki等。
4）代码的组织结构。
了解这个软件的代码由哪些部分组成：
1）接口抽象定义。
2）模块粘合层。如middleware, promises, callback, 代理委托， IoC等。
3）业务流程。不要直接进入细节，需要在高层搞清楚整个业务的流程，流程中数据如何被传递和处理。需要画程序流程图和时序处理图
4）具体实现。深入细节，阅读具体实现的代码。包括：代码逻辑，出错处理，数据处理，重要的算法，底层交互
5）运行时调试。
1. XmlBeanFactory构造方法
public XmlBeanFactory(Resource resource, BeanFactory parentBeanFactory) throws BeansException {
// 1. 调用父类构造方法，传递当前容器的父容器（如果有的话）
super(parentBeanFactory);
// 2. 使用XmlBeanDefintionReader从外部XML中读取并加载BeanDefintion
// 最后注册到当前容器中
this.reader.loadBeanDefinitions(resource);
}
第一步比较简单，不再深入。 重点看第二步，从外部读取BeanDefintion，最后注册到容器中，这是核心功能，此步骤并不是容器本身实现，而是借助XmlBeanDefintionReader实现。我们来看一看。
先看类结构图：
XmlBeanDefintionReader实现了BeanDefintionReader接口， BeanDefintionReader提供了若干个接口用于从外部资源读取Bean定义。
BeanDefinitionReader接口定义见下图。
如上图，BeanDefintionReader提供了若干个批量加载BeanDefinition的方法，以及获取BeanDefinitionRegistry等方法。
除了比较常见加载BeanDefinition的XmlBeanDefinitionReader， spring内置还有GroovyBeanDefinitionReader， PropertiesBeanDefinitionReader。
this.reader.loadBeanDefinitions(resource);
继续跟踪XmlBeanFactory构造方法中的this.reader.loadBeanDefinitions(resource); 看看是如何加载外部资源的。
核心方法如下：
/**
* Load bean definitions from the specified XML file.
* @param encodedResource the resource descriptor for the XML file,
* allowing to specify an encoding to use for parsing the file
* @return the number of bean definitions found
* @throws BeanDefinitionStoreException in case of loading or parsing errors
*
*/
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
Assert.notNull(encodedResource, "EncodedResource must not be null");
if (logger.isTraceEnabled()) {
logger.trace("Loading XML bean definitions from " + encodedResource);
}
Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();
if (currentResources == null) {
currentResources = new HashSet<>(4);
this.resourcesCurrentlyBeingLoaded.set(currentResources);
}
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
// 上面一段是校验资源重复加载，利用ThreadLocal和Set集合。
try {
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
// 使用标准的InputSource进行封装，并设置Encoding
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
// 交给底层方法执行，执行结果是加载成功的BeanDefintion数量
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
inputStream.close();
}
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
currentResources.remove(encodedResource);
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
// 上面的try { try{...} finally {close();} } catch (IOException e) {throw ...}
// 这是一个典型的处理IO异常比较优雅的模式，之所以嵌套了两层是因为不可以在finally中再抛出异常。
doLoadBeanDefinitions(inputSource, encodedResource.getResource())
进一步分析doLoadBeanDefinitions(inputSource, encodedResource.getResource())实现，源代码如下：
/**
* Actually load bean definitions from the specified XML file.
* @param inputSource the SAX InputSource to read from
* @param resource the resource descriptor for the XML file
* @return the number of bean definitions found
* @throws BeanDefinitionStoreException in case of loading or parsing errors
* @see #doLoadDocument
* @see #registerBeanDefinitions
*/
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
// 使用DocumentLoader从指定的源加载Document，此处理解为由DOM对象组成的文档对象
// doLoadDocument这个方法不准确展开，了解它的含义即可，跟主流程不相干
Document doc = doLoadDocument(inputSource, resource);
// 调用registerBeanDefinitions方法，返回注册的BeanDefintion数量
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (SAXParseException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
}
catch (SAXException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"XML document from " + resource + " is invalid", ex);
}
catch (ParserConfigurationException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Parser configuration exception parsing XML from " + resource, ex);
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"IOException parsing XML document from " + resource, ex);
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Unexpected exception parsing XML document from " + resource, ex);
}
}
registerBeanDefinitions
调用registerBeanDefinitions方法实际进行BeanDefinition注册
/**
* Register the bean definitions contained in the given DOM document.
* Called by {@code loadBeanDefinitions}.
* <p>Creates a new instance of the parser class and invokes
* {@code registerBeanDefinitions} on it.
* @param doc the DOM document
* @param resource the resource descriptor (for context information)
* @return the number of bean definitions found
* @throws BeanDefinitionStoreException in case of parsing errors
* @see #loadBeanDefinitions
* @see #setDocumentReaderClass
* @see BeanDefinitionDocumentReader#registerBeanDefinitions
*/
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
// 初始化BeanDefinitionDocumentReader实例，实现类是DefaultBeanDefinitionDocumentReader，该类用于解析转换XML中的Bean定义（根据xml的DTD和XSD格式）
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
// 先读取加载Bean定义之前容器中Bean定义数量
int countBefore = getRegistry().getBeanDefinitionCount();
// 委托BeanDefinitionDocumentReader注册BeanDefinition
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
// 计算并返回本次加载的BeanDefinition数量
return getRegistry().getBeanDefinitionCount() - countBefore;
}
registerBeanDefinitions
分析documentReader的registerBeanDefinitions方法
/**
* Register each bean definition within the given root {@code <beans/>} element.
*/
@SuppressWarnings("deprecation") // for Environment.acceptsProfiles(String...)
protected void doRegisterBeanDefinitions(Element root) {
// Any nested <beans> elements will cause recursion in this method. In
// order to propagate and preserve <beans> default-* attributes correctly,
// keep track of the current (parent) delegate, which may be null. Create
// the new (child) delegate with a reference to the parent for fallback purposes,
// then ultimately reset this.delegate back to its original (parent) reference.
// this behavior emulates a stack of delegates without actually necessitating one.
BeanDefinitionParserDelegate parent = this.delegate;
// 创建的BeanDefinitionParserDelegate委托类，用于具体执行处理Xml BeanDefinition定义
this.delegate = createDelegate(getReaderContext(), root, parent);
// 判断当前根节点 namespace 是否是http://www.springframework.org/schema/beans
if (this.delegate.isDefaultNamespace(root)) {
// 以下逻辑是用于判断当前是否profile属性，如果有判断是否匹配，决定是否加载该beans下的BeanDefinition。 该特性是spring4之后加入的。
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
// We cannot use Profiles.of(...) since profile expressions are not supported
// in XML config. See SPR-12458 for details.
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isDebugEnabled()) {
logger.debug("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
// 解析BeanDefinition的前置处理（默认空）
preProcessXml(root);
// 处理BeanDefinition核心方法
parseBeanDefinitions(root, this.delegate);
// 解析BeanDefinition的后置处理（默认空）
postProcessXml(root);
this.delegate = parent;
}
parseBeanDefinitions
/**
* Parse the elements at the root level in the document:
* "import", "alias", "bean".
* 从文档的顶级元素节点开始解析，子节点通常有import, alias, bean等
* @param root the DOM root element of the document
*/
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
// 以下if这一段用于迭代处理节点，如果是缺省节点调用parseDefaultElement处理，否则调用parseCustomElement处理。我们只关注缺省节点的处理
if (delegate.isDefaultNamespace(root)) {
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
if (delegate.isDefaultNamespace(ele)) {
parseDefaultElement(ele, delegate);
}
else {
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
/**
* 解析缺省元素节点，逻辑比较简单，注意一个else if, 当节点又匹配到beans时，执行递归方法调用
*/
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
// 解析import节点
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
importBeanDefinitionResource(ele);
}
// 解析alias节点
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
processAliasRegistration(ele);
}
// 解析bean节点（重点关注）
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
processBeanDefinition(ele, delegate);
}
// 递归解析beans
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
doRegisterBeanDefinitions(ele);
}
}
processBeanDefinition
终于来到了最终的生产BeanDefinition对象，并注册到容器中的方法。
/**
* Process the given bean element, parsing the bean definition
* and registering it with the registry.
* 解析出BeanDefiniton对象，并注册到容器中
*/
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
// 解析Bean节点，生成BeanDefinitionHolder对象，持有beanDefinition对象，beanName和aliases
// 具体如何解析属性并生成BeanDefinition的过程不展开。
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
// 注册BeanDefinition实例至容器，跟进去看一下如何实现
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
registerBeanDefinition
该方法是BeanDefinitionReaderUtils工具类的静态方法， 逻辑很清晰明了，就是向容器注册BeanDefinition， 指定的beanName来源于BeanDefinitionHolder，同时注册bean别名，也来源于BeanDefinitionHolder。
/**
* Register the given bean definition with the given bean factory.
* @param definitionHolder the bean definition including name and aliases
* @param registry the bean factory to register with
* @throws BeanDefinitionStoreException if registration failed
*/
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
registry.registerAlias(beanName, alias);
}
}
}
至于得到了beanName, BeanDefinition和alias后容器如何注册的，就不再是XmlBeanDefinitionReader的职责了，而是又回到了最初的DefaultListableBeanFactory。
DefaultListableBeanFactory.registerBeanDefinition
下面开始分析registerBeanDefinition如何实现。
/**
* 总体的过程是：
* 1）从BeanDefinitionMap中以beanName为key获取对应的BeanDefinition
* 2) 如果该beanDefinition实例已经存在，则比较新旧版本的Role，如果新的Role更大则覆盖
* 3）记录beanDefinition覆盖的日志
* 4）如果不存在旧beanDefinition， 则put到beanDefinitionMap中
*
*/
@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.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
// 此处的beanDefinitionMap首次揭秘了IoC容器如何存储BeanDefinition，本质上就是一个Map，key是BeanName, value是BeanDefinition
BeanDefinition existingDefinition = this.beanDefinitionMap.get(beanName);
if (existingDefinition != null) {
// 不允许覆盖的情况下直接抛出异常，不过默认都是允许覆盖的
if (!isAllowBeanDefinitionOverriding()) {
throw new BeanDefinitionOverrideException(beanName, beanDefinition, existingDefinition);
}
// 这里的Role是决定BeanDefiniton的级别，本身比较简单，原则是框架层的更优先
else if (existingDefinition.getRole() < beanDefinition.getRole()) {
// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
if (logger.isInfoEnabled()) {
logger.info("Overriding user-defined bean definition for bean '" + beanName +
"' with a framework-generated bean definition: replacing [" +
existingDefinition + "] with [" + beanDefinition + "]");
}
}
else if (!beanDefinition.equals(existingDefinition)) {
if (logger.isDebugEnabled()) {
logger.debug("Overriding bean definition for bean '" + beanName +
"' with a different definition: replacing [" + existingDefinition +
"] with [" + beanDefinition + "]");
}
}
else {
if (logger.isTraceEnabled()) {
logger.trace("Overriding bean definition for bean '" + beanName +
"' with an equivalent definition: replacing [" + existingDefinition +
"] with [" + beanDefinition + "]");
}
}
this.beanDefinitionMap.put(beanName, beanDefinition);
}
else {
if (hasBeanCreationStarted()) {
// Cannot modify startup-time collection elements anymore (for stable iteration)
// 此处使用synchronized是避免注册BeanDefinition时又对Bean实例化产生影响
synchronized (this.beanDefinitionMap) {
this.beanDefinitionMap.put(beanName, beanDefinition);
List<String> updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
updatedDefinitions.addAll(this.beanDefinitionNames);
updatedDefinitions.add(beanName);
this.beanDefinitionNames = updatedDefinitions;
removeManualSingletonName(beanName);
}
}
else {
// Still in startup registration phase
this.beanDefinitionMap.put(beanName, beanDefinition);
this.beanDefinitionNames.add(beanName);
removeManualSingletonName(beanName);
}
this.frozenBeanDefinitionNames = null;
}
if (existingDefinition != null || containsSingleton(beanName)) {
resetBeanDefinition(beanName);
}
}
小结
由此我们从XmlBeanFactory分析了Bean定义加载阶段的整个过程。 通过分析整个过程能对spring容器的初始化有了更深的理解，对xml元素配置的作用就非常清楚了。这里再分析一下BeanDefinition。本章的BeanDefinition的加载阶段主要就是围绕着它。
BeanDefinition对象说白了就是即将生成Bean对象的元数据信息，看一下它的接口定义：
可以看出它就是包含了Bean实例化的相关信息，如scope, initMethodName, propertyValues等。
下一节开始讲Bean的实例化阶段，看spring容器如何借助已有BeanDefinition生成Bean实例的。
180
被折叠的 条评论
为什么被折叠?
到【灌水乐园】发言
