當前位置：首頁 > 编程资源 > 编程问答 >内容正文

编程问答

spring beans源码解读之--XmlBeanFactory

發布時間：2025/4/5 编程问答 14 豆豆

生活随笔收集整理的這篇文章主要介紹了 spring beans源码解读之--XmlBeanFactory 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

導讀：

XmlBeanFactory繼承自DefaultListableBeanFactory，擴展了從xml文檔中讀取bean definition的能力。從本質上講，XmlBeanFactory等同于DefaultListableBeanFactory+XmlBeanDefinitionReader ，如果有更好的需求，可以考慮使用DefaultListableBeanFactory+XmlBeanDefinitionReader方案，因為該方案可以從多個xml文件讀取資源，并且在解析xml上具有更靈活的可配置性。

1?XmlBeanFactory的使用

典型構造方法：

public XmlBeanFactory(Resource resource, BeanFactory parentBeanFactory) throws BeansException {super(parentBeanFactory);this.reader.loadBeanDefinitions(resource);}

其中，

reader是XmlBeanDefinitionReader的實例，XmlBeanDefinitionReader繼承自AbstractBeanDefinitionReader(http://www.cnblogs.com/davidwang456/p/4190428.html 已經介紹過)。

?Resource 接口封裝了各種可能的資源類型，也就是對使用者來說屏蔽了文件類型的不同。這樣所有的資源都被可以通過 InputStream 這個類來獲取，所以也屏蔽了資源的提供者。另外還有一個問題就是加載資源的問題，也就是資源的加載者要統一，從上圖中可以看出這個任務是由 ResourceLoader 接口完成，他屏蔽了所有的資源加載者的差異，只需要實現這個接口就可以加載所有的資源，他的默認實現是 DefaultResourceLoader。

?1.1?Resource 接口繼承了 InputStreamSource 接口，這個接口中有個 getInputStream 方法，返回的是 InputStream 類。

public interface InputStreamSource {InputStream getInputStream() throws IOException; } getInputStream設計希望每次請求都返回一個新的流。這種要求在一個場合非常重要，例如javamail api，它在創建多個郵件附件時需要多次讀取到流，在這中情況下，它就要求每個getInputStream請求能返回一個新的流。

1.2 抽象資源類AbstractResource繼承自Source接口，實現了部分方法。
exists方法檢查一個文件或者輸入量是否可以打開；
isOpen 通常返回false;
　　getUrl和getFile 拋出異常；
toString返回描述信息。

另外有一個有用的方法：lastModified()返回文件的最后修改時間。調用了File.lastModified() 返回此抽象路徑名表示的文件最后一次被修改的時間。 @Overridepublic long lastModified() throws IOException {long lastModified = getFileForLastModifiedCheck().lastModified();if (lastModified == 0L) {throw new FileNotFoundException(getDescription() +" cannot be resolved in the file system for resolving its last-modified timestamp");}return lastModified;}

1.3 Resource的實現子類：

AbstractResource的直接子類有：AbstractFileResolvingResource, ByteArrayResource,BeanDefinitionResource, DescriptiveResource, FileSystemResource, InputStreamResource, PathResource, VfsResource。
其中，AbstractFileResolvingResource的直接子類有：ClassPathResource, PortletContextResource, ServletContextResource, UrlResource 比較重要的實現類為實現了ContextResource接口的資源類，ContextResource接口繼承了Resource接口，通過從一個封裝的context中加載資源來擴展Resource接口的功能。例如：可以從ServletContext，PortletContext，普通的classpth路徑或者文件系統的相對路徑(特別是沒有指明前綴，因此適用于本地ResourceLoader的context)，其子類實現有：PortletContextResource, ServletContextResource,ClassPathContextResource,ClassRelativeContextResource,FileSystemContextResource.

1.4 資源的加載ResourceLoader，ResourceLoader是一個加載資源的策略接口，可以從classpth或者文件系統中，ApplicationContext需要加載資源功能，使用了其擴展類ResourcePatternReolver。DefaultResourceLoader是該接口的標準實現，適用于一個ApplicationContext外部，可以用在ResourceEditor中。在application允許過程中，使用特定的context子原因加載策略，可以將type資源和資源組通過string的形式設置bean的屬性。

(來源：http://www.ibm.com/developerworks/cn/java/j-lo-spring-principle/)

2. Bean的解析與注冊詳細過程分析

　　　　(來源：http://www.ibm.com/developerworks/cn/java/j-lo-spring-principle/)

? ?首先， XmlBeanFactory構造函數this.reader.loadBeanDefinitions(resource);

　 1.?XmlBeanDefinitionReader加載bean定義：loadBeanDefinitions方法

? ? 2.?XmlBeanDefinitionReader解析bean定義，并注冊：doLoadBeanDefinitions方法

Document doc = doLoadDocument(inputSource, resource);
return registerBeanDefinitions(doc, resource);

? 3.1. 使用標準的JAXP配置的xml解析器從Resource中加載到Document。

/*** Load the {@link Document} at the supplied {@link InputSource} using the standard JAXP-configured* XML parser.*/@Overridepublic Document loadDocument(InputSource inputSource, EntityResolver entityResolver,ErrorHandler errorHandler, int validationMode, boolean namespaceAware) throws Exception {DocumentBuilderFactory factory = createDocumentBuilderFactory(validationMode, namespaceAware);if (logger.isDebugEnabled()) {logger.debug("Using JAXP provider [" + factory.getClass().getName() + "]");}DocumentBuilder builder = createDocumentBuilder(factory, entityResolver, errorHandler);return builder.parse(inputSource);}

? ?3.2.根據加載的Document 注冊Bean definition。

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();documentReader.setEnvironment(getEnvironment());int countBefore = getRegistry().getBeanDefinitionCount();documentReader.registerBeanDefinitions(doc, createReaderContext(resource));return getRegistry().getBeanDefinitionCount() - countBefore;}

3.2.1 創建BeanDefinitionDocument的解析器BeanUtils.instantiateClass(this.documentReaderClass)

3.2.2?BeanDefinitionDocument解析器注冊bean definition，從根節點<beans>開始

/*** Register each bean definition within the given root {@code <beans/>} element.*/protected void doRegisterBeanDefinitions(Element root) {String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);if (StringUtils.hasText(profileSpec)) {String[] specifiedProfiles = StringUtils.tokenizeToStringArray(profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);if (!getEnvironment().acceptsProfiles(specifiedProfiles)) {return;}}// 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;this.delegate = createDelegate(this.readerContext, root, parent); preProcessXml(root);parseBeanDefinitions(root, this.delegate);postProcessXml(root);this.delegate = parent;} /*** 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) {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);}}private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {importBeanDefinitionResource(ele);}else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {processAliasRegistration(ele);}else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {processBeanDefinition(ele, delegate);}else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {// recurse doRegisterBeanDefinitions(ele);}}

4.?documentReader.registerBeanDefinitions(doc, createReaderContext(resource));--->

public XmlReaderContext createReaderContext(Resource resource) {return new XmlReaderContext(resource, this.problemReporter, this.eventListener,this.sourceExtractor, this, getNamespaceHandlerResolver());}

5.調用：

protected NamespaceHandlerResolver createDefaultNamespaceHandlerResolver() {return new DefaultNamespaceHandlerResolver(getResourceLoader().getClassLoader());}

6.BeanDefinitionReaderUtils.registerBeanDefinition

/*** Process the given bean element, parsing the bean definition* and registering it with the registry.*/protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);if (bdHolder != null) {bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);try {// Register the final decorated instance. 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));}}

7.處理給定的Bean元素，并解析到BeanDefinition。

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 aliase : aliases) {registry.registerAlias(beanName, aliase);}}}

9.將解析的Bean定義放入BeanDefinitionNames和BeanDefinitionMap保存已經aliasMap等

@Overridepublic 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);}}BeanDefinition oldBeanDefinition;synchronized (this.beanDefinitionMap) {oldBeanDefinition = this.beanDefinitionMap.get(beanName);if (oldBeanDefinition != null) {if (!this.allowBeanDefinitionOverriding) {throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,"Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName +"': There is already [" + oldBeanDefinition + "] bound.");}else if (oldBeanDefinition.getRole() < beanDefinition.getRole()) {// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTUREif (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 (this.logger.isInfoEnabled()) {this.logger.info("Overriding bean definition for bean '" + beanName +"': replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]");}}}else {this.beanDefinitionNames.add(beanName);this.frozenBeanDefinitionNames = null;}this.beanDefinitionMap.put(beanName, beanDefinition);}if (oldBeanDefinition != null || containsSingleton(beanName)) {resetBeanDefinition(beanName);}}

3.?一個非常重要的部分就是建立 Bean 對象實例之間的關系，這也是 Spring 框架的核心競爭力，何時、如何建立他們之間的關系請看下面的時序圖：

? ? 來源：http://www.ibm.com/developerworks/cn/java/j-lo-spring-principle/

4. 小結：

　　從spring 3.1版本后，xmlBeanFactory被表明為Deprecated. 推薦使用DefaultListableBeanFactory和XmlBeanDefinitionReader替換。

本文從xmlBeanFactory擴展到XmlBeanDefinitionReader，再到Resource接口。

一些情節還沒有理順，顯得有些雜亂，后續會修改(寫的很累，休整一下)。寫這篇博客的時候，這句話一直在我腦邊回想：

"寫書就像冒險。一開始它是玩具和娛樂。然后她成了你的情婦。然后是你的主人。然后變成一個暴君。最后你終于認命的時候，它死了，然后給拖到外面游街。" ----溫斯頓.丘吉爾

參考文獻：

1. http://www.ibm.com/developerworks/cn/java/j-lo-spring-principle/

轉載于:https://www.cnblogs.com/davidwang456/p/4204569.html

總結

以上是生活随笔為你收集整理的spring beans源码解读之--XmlBeanFactory的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。

上一篇：项目中使用Quartz集群分享--转载
下一篇： Load Balance Tomcat