Opens a DOM Document; then initializes the default settings * specified at the {@code } level; then parses the contained bean definitions. */ @Override public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { this.readerContext = readerContext; // 获得 XML Document Root Element // 执行注册 BeanDefinition doRegisterBeanDefinitions(doc.getDocumentElement()); } /** * Register each bean definition within the given root {@code } element. */ @SuppressWarnings("deprecation") // for Environment.acceptsProfiles(String...) protected void doRegisterBeanDefinitions(Element root) { // Any nested elements will cause recursion in this method. In // order to propagate and preserve 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 对象 BeanDefinitionParserDelegate parent = this.delegate; // <1> 创建 BeanDefinitionParserDelegate 对象,并进行设置到 delegate this.delegate = createDelegate(getReaderContext(), root, parent); // <2> 检查 根标签的命名空间是否为空,或者是 http://www.springframework.org/schema/beans if (this.delegate.isDefaultNamespace(root)) { // <2.1> 处理 profile 属性。可参见《Spring3自定义环境配置 》http://nassir.iteye.com/blog/1535799 String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE); if (StringUtils.hasText(profileSpec)) { // <2.2> 使用分隔符切分,可能有多个 profile 。 String[] specifiedProfiles = StringUtils.tokenizeToStringArray( profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS); // <2.3> 如果所有 profile 都无效,则不进行注册 // 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; } } } // <3> 解析前处理 preProcessXml(root); // <4> 解析 parseBeanDefinitions(root, this.delegate); // <5> 解析后处理 postProcessXml(root); // 设置 delegate 回老的 BeanDefinitionParserDelegate 对象 this.delegate = parent; } ``` - `<1>` 处,创建 BeanDefinitionParserDelegate 对象,并进行设置到 `delegate` 。BeanDefinitionParserDelegate 是一个重要的类,它负责**解析 BeanDefinition**。代码如下: > FROM 《Spring 源码深度解析》P16 > > 定义解析 XML Element 的各种方法 ``` protected BeanDefinitionParserDelegate createDelegate( XmlReaderContext readerContext, Element root, @Nullable BeanDefinitionParserDelegate parentDelegate) { // 创建 BeanDefinitionParserDelegate 对象 BeanDefinitionParserDelegate delegate = new BeanDefinitionParserDelegate(readerContext); // 初始化默认 delegate.initDefaults(root, parentDelegate); return delegate; } ``` - `<2>` 处,检查 `` **根**标签的命名空间是否为空,或者是 http://www.springframework.org/schema/beans 。 - `<2.1>` 处,判断是否 `` 上配置了 `profile` 属性。不了解这块的胖友,可以看下 [《《Spring3自定义环境配置 》》](http://nassir.iteye.com/blog/1535799) 。 - `<2.2>` 处,使用分隔符切分,可能有**多个** profile 。 - `<2.3>` 处,判断,如果所有 profile 都无效,则 `return` 不进行注册。 - `<4>` 处,调用 `#parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate)` 方法,进行解析逻辑。详细解析,见 [「3.1 parseBeanDefinitions」](http://svip.iocoder.cn/Spring/IoC-register-BeanDefinitions/#) 。 - `<3>` / `<5>` 处,解析**前后**的处理,目前这两个方法都是空实现,交由子类来实现。代码如下: ``` protected void preProcessXml(Element root) {} protected void postProcessXml(Element root) {} ``` #### 2.1.1 parseBeanDefinitions `#parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate)` 方法,进行解析逻辑。代码如下: ``` /** * Parse the elements at the root level in the document: * "import", "alias", "bean". * @param root the DOM root element of the document */ protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { // <1> 如果根节点使用默认命名空间,执行默认解析 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; // <1> 如果该节点使用默认命名空间,执行默认解析 if (delegate.isDefaultNamespace(ele)) { parseDefaultElement(ele, delegate); // 如果该节点非默认命名空间,执行自定义解析 } else { delegate.parseCustomElement(ele); } } } // <2> 如果根节点非默认命名空间,执行自定义解析 } else { delegate.parseCustomElement(root); } } ``` - Spring 有**两种** Bean 声明方式: - 配置文件式声明:`` 。对应 `<1>` 处。 - 自定义注解方式:`` 。对应 `<2>` 处。 - `<1>` 处,如果**根**节点或**子**节点**使用**默认命名空间,调用 `#parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate)` 方法,执行默认解析。代码如下: ``` private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) { if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) { // import importBeanDefinitionResource(ele); } else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) { // alias processAliasRegistration(ele); } else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) { // bean processBeanDefinition(ele, delegate); } else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) { // beans // recurse doRegisterBeanDefinitions(ele); } } ``` - 详细的解析,见后续文章。 - `<2>` 处,如果**根**节点或**子**节点**不使用**默认命名空间,调用 `BeanDefinitionParserDelegate#parseCustomElement(Element ele)` 方法,执行**自定义**解析。详细的解析,见后续文章。 ## 3. createReaderContext `#createReaderContext(Resource resource)` 方法,创建 XmlReaderContext 对象。代码如下: ``` private ProblemReporter problemReporter = new FailFastProblemReporter(); private ReaderEventListener eventListener = new EmptyReaderEventListener(); private SourceExtractor sourceExtractor = new NullSourceExtractor(); @Nullable private NamespaceHandlerResolver namespaceHandlerResolver; /** * Create the {@link XmlReaderContext} to pass over to the document reader. */ public XmlReaderContext createReaderContext(Resource resource) { return new XmlReaderContext(resource, this.problemReporter, this.eventListener, this.sourceExtractor, this, getNamespaceHandlerResolver()); } ``` 关于 XmlReaderContext 的详细解析,见后续文章。 ## 4. 小结 至此,`XmlBeanDefinitionReader#doLoadBeanDefinitions(InputSource inputSource, Resource resource)` 方法中,做的三件事情已经全部分析完毕,下面将对 **BeanDefinition 的解析过程**做详细分析说明。 另外,`XmlBeanDefinitionReader#doLoadBeanDefinitions(InputSource inputSource, Resource resource)` 方法,整体时序图如下:  - 红框部分,就是 **BeanDefinition 的解析过程**。