摘要:前言以下源碼基于版本解析。實現(xiàn)源碼分析對于的實現(xiàn),總結(jié)來說就是定位加載和注冊。定位就是需要定位配置文件的位置,加載就是將配置文件加載進(jìn)內(nèi)存注冊就是通過解析配置文件注冊。下面我們從其中的一種使用的方式一步一步的分析的實現(xiàn)源碼。
前言
以下源碼基于Spring 5.0.2版本解析。
什么是IOC容器?容器,顧名思義可以用來容納一切事物。我們平常所說的Spring IOC容器就是一個可以容納對象的東西。IOC全名Inversion of Control,即控制反轉(zhuǎn),什么是控制反轉(zhuǎn)?平時我們代碼里需要創(chuàng)建一個對象是需要通過new操作或者反射等方式創(chuàng)建,也就是說現(xiàn)在是我們?nèi)藶榈貏?chuàng)建對象,控制對象,那么控制反轉(zhuǎn)的意思就顯而易見了,就是將原來屬于我們的控制權(quán)交由Spring框架進(jìn)行管理,由Spring替我們創(chuàng)建對象,管理對象以及對象之間的依賴關(guān)系。當(dāng)我們需要使用對象的時候直接問Spring取就可以了。
IOC實現(xiàn)源碼分析對于Spring IOC的實現(xiàn),總結(jié)來說就是定位、加載和注冊。定位就是Spring需要定位配置文件的位置,加載就是將配置文件加載進(jìn)內(nèi)存,注冊就是通過解析配置文件注冊BeanDefinition。
下面我們從其中的一種使用Spring的方式一步一步的分析IOC的實現(xiàn)源碼。我們平時編程式地使用Spring框架如下代碼所示。
public class TestSpring { public static void main(String[] args) { //傳入配置文件路徑信息,初始化Spring IOC容器 ClassPathXmlApplicationContext context = new ClassPathXmlApplicationContext("spring-context.xml"); //從容器中獲取名稱為world的bean實例 context.getBean("world"); } }
所以我們分析Spring IOC實現(xiàn)的入口也就是ClassPathXmlApplicationContext的構(gòu)造方法。ClassPathXmlApplicationContext的構(gòu)造方法源碼如下:
//這里是我們上述初始化IOC容器的地方 public ClassPathXmlApplicationContext(String configLocation) throws BeansException { this(new String[]{configLocation}, true, (ApplicationContext)null); } //實際調(diào)用的是這個核心方法初始化IOC容器的 public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent) throws BeansException { //設(shè)置父容器信息 super(parent); //設(shè)置配置文件路徑,方便接下來的查找 this.setConfigLocations(configLocations); //判斷是否需要重新刷新IOC容器 if (refresh) { //調(diào)用父類AbstractApplicationContext的refresh方法 this.refresh(); } }
所以這里我們需要進(jìn)入refresh方法分析Spring IOC是如何刷新的,源碼如下:
public void refresh() throws BeansException, IllegalStateException { Object var1 = this.startupShutdownMonitor; //這里需要進(jìn)行同步操作,防止多個線程同時刷新容器 synchronized(this.startupShutdownMonitor) { //刷新前的準(zhǔn)備工作,獲取容器的當(dāng)時時間,同時給容器設(shè)置同步標(biāo)識。 this.prepareRefresh(); //這里是IOC容器初始化的核心方法,告訴子類啟動refreshBeanFactory()方法,Bean定義資源文件的載入從子類的refreshBeanFactory()方法啟動 ConfigurableListableBeanFactory beanFactory = this.obtainFreshBeanFactory(); //對容器進(jìn)行一些相關(guān)設(shè)置,為BeanFactory配置容器特性,例如類加載器、事件處理器等 this.prepareBeanFactory(beanFactory); try { //為容器的某些子類指定特殊的BeanPost事件處理器 this.postProcessBeanFactory(beanFactory); //調(diào)用bean的后置處理器 this.invokeBeanFactoryPostProcessors(beanFactory); //為BeanFactory注冊BeanPost事件處理器.BeanPostProcessor是Bean后置處理器,用于監(jiān)聽容器觸發(fā)的事件 this.registerBeanPostProcessors(beanFactory); //初始化信息源,和國際化相關(guān). this.initMessageSource(); //初始化容器事件傳播器. this.initApplicationEventMulticaster(); //調(diào)用子類的某些特殊Bean初始化方法 this.onRefresh(); //為事件傳播器注冊事件監(jiān)聽器. this.registerListeners(); //初始化所有剩余的單例Bean this.finishBeanFactoryInitialization(beanFactory); //初始化容器的生命周期事件處理器,并發(fā)布容器的生命周期事件 this.finishRefresh(); } catch (BeansException var9) { if (this.logger.isWarnEnabled()) { this.logger.warn("Exception encountered during context initialization - cancelling refresh attempt: " + var9); } //銷毀已創(chuàng)建的Bean this.destroyBeans(); //取消refresh操作,重置容器的同步標(biāo)識. this.cancelRefresh(var9); throw var9; } finally { //緩存清理工作 this.resetCommonCaches(); } } }
這里我們主要分析AbstractApplicationContext的obtainFreshBeanFactory方法,源碼如下:
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() { //這里使用了委派設(shè)計模式,父類定義了抽象的refreshBeanFactory()方法,具體實現(xiàn)調(diào)用子類容器的refreshBeanFactory()方法 refreshBeanFactory(); ConfigurableListableBeanFactory beanFactory = getBeanFactory(); if (logger.isDebugEnabled()) { logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory); } return beanFactory; }
分析AbstractApplicationContext子類AbstractRefreshableApplicationContext的refreshBeanFactory方法,源碼如下:
protected final void refreshBeanFactory() throws BeansException { //如果已經(jīng)有容器,銷毀容器中的bean,關(guān)閉容器 if (hasBeanFactory()) { destroyBeans(); closeBeanFactory(); } try { //創(chuàng)建IOC容器,這里是直接實例化DefaultListableBeanFactory對象 DefaultListableBeanFactory beanFactory = createBeanFactory(); beanFactory.setSerializationId(getId()); //對IOC容器進(jìn)行定制化,如設(shè)置啟動參數(shù),開啟注解的自動裝配等 customizeBeanFactory(beanFactory); //調(diào)用載入Bean定義的方法,主要這里又使用了一個委派模式,在當(dāng)前類中只定義了抽象的loadBeanDefinitions方法,具體的實現(xiàn)調(diào)用子類容器 loadBeanDefinitions(beanFactory); synchronized (this.beanFactoryMonitor) { this.beanFactory = beanFactory; } } catch (IOException ex) { throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex); } }
這里主要分析Spring是如何載入Bean定義的,進(jìn)入AbstractXmlApplicationContext的loadBeanDefinitions方法,源碼如下:
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException { // Create a new XmlBeanDefinitionReader for the given BeanFactory. //創(chuàng)建XmlBeanDefinitionReader,即創(chuàng)建Bean讀取器,并通過回調(diào)設(shè)置到容器中去,容器使用該讀取器讀取Bean定義資源 XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory); // Configure the bean definition reader with this context"s // resource loading environment. //為Bean讀取器設(shè)置Spring資源加載器,AbstractXmlApplicationContext的 //祖先父類AbstractApplicationContext繼承DefaultResourceLoader,因此,容器本身也是一個資源加載器 beanDefinitionReader.setEnvironment(this.getEnvironment()); beanDefinitionReader.setResourceLoader(this); //為Bean讀取器設(shè)置SAX xml解析器 beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this)); // Allow a subclass to provide custom initialization of the reader, // then proceed with actually loading the bean definitions. //當(dāng)Bean讀取器讀取Bean定義的Xml資源文件時,啟用Xml的校驗機制 initBeanDefinitionReader(beanDefinitionReader); //Bean讀取器真正實現(xiàn)加載的方法 loadBeanDefinitions(beanDefinitionReader); }
可以看到這里通過創(chuàng)建Bean讀取器,最后調(diào)用loadBeanDefinitions實現(xiàn)定位、加載和注冊。loadBeanDefinitions方法的源碼如下:
//Xml Bean讀取器加載Bean定義資源 protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException { //獲取Bean定義資源的定位 Resource[] configResources = getConfigResources(); if (configResources != null) { //Xml Bean讀取器調(diào)用其父類AbstractBeanDefinitionReader讀取定位 //的Bean定義資源 reader.loadBeanDefinitions(configResources); } //如果子類中獲取的Bean定義資源定位為空,則獲取FileSystemXmlApplicationContext構(gòu)造方法中setConfigLocations方法設(shè)置的資源 String[] configLocations = getConfigLocations(); if (configLocations != null) { //Xml Bean讀取器調(diào)用其父類AbstractBeanDefinitionReader讀取定位 //的Bean定義資源 reader.loadBeanDefinitions(configLocations); } }
接下來分析其父類AbstractBeanDefinitionReader是如何讀取定位Bean定義資源的,查看AbstractBeanDefinitionReader的loadBeanDefinitions方法,源碼如下:
public int loadBeanDefinitions(String location, @Nullable SetactualResources) throws BeanDefinitionStoreException { //獲取在IoC容器初始化過程中設(shè)置的資源加載器 ResourceLoader resourceLoader = getResourceLoader(); if (resourceLoader == null) { throw new BeanDefinitionStoreException( "Cannot import bean definitions from location [" + location + "]: no ResourceLoader available"); } if (resourceLoader instanceof ResourcePatternResolver) { // Resource pattern matching available. try { //將指定位置的Bean定義資源文件解析為Spring IOC容器封裝的資源 //加載多個指定位置的Bean定義資源文件 Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location); //委派調(diào)用其子類XmlBeanDefinitionReader的方法,實現(xiàn)加載功能 int loadCount = loadBeanDefinitions(resources); if (actualResources != null) { for (Resource resource : resources) { actualResources.add(resource); } } if (logger.isDebugEnabled()) { logger.debug("Loaded " + loadCount + " bean definitions from location pattern [" + location + "]"); } return loadCount; } catch (IOException ex) { throw new BeanDefinitionStoreException( "Could not resolve bean definition resource pattern [" + location + "]", ex); } } else { // Can only load single resources by absolute URL. //將指定位置的Bean定義資源文件解析為Spring IOC容器封裝的資源 //加載單個指定位置的Bean定義資源文件 Resource resource = resourceLoader.getResource(location); //委派調(diào)用其子類XmlBeanDefinitionReader的方法,實現(xiàn)加載功能 int loadCount = loadBeanDefinitions(resource); if (actualResources != null) { actualResources.add(resource); } if (logger.isDebugEnabled()) { logger.debug("Loaded " + loadCount + " bean definitions from location [" + location + "]"); } return loadCount; } }
可以看到這里最后委派調(diào)用其子類XmlBeanDefinitionReader的方法實現(xiàn)加載功能,XmlBeanDefinitionReader的loadBeanDefinitions方法源碼如下:
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException { //將讀入的XML資源進(jìn)行特殊編碼處理 return loadBeanDefinitions(new EncodedResource(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 */ //這里是載入XML形式Bean定義資源文件方法 public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException { Assert.notNull(encodedResource, "EncodedResource must not be null"); if (logger.isInfoEnabled()) { logger.info("Loading XML bean definitions from " + encodedResource.getResource()); } SetcurrentResources = 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!"); } try { //將資源文件轉(zhuǎn)為InputStream的IO流 InputStream inputStream = encodedResource.getResource().getInputStream(); try { //從InputStream中得到XML的解析源 InputSource inputSource = new InputSource(inputStream); if (encodedResource.getEncoding() != null) { inputSource.setEncoding(encodedResource.getEncoding()); } //這里是具體的讀取過程 return doLoadBeanDefinitions(inputSource, encodedResource.getResource()); } finally { //關(guān)閉從Resource中得到的IO流 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(); } } }
查看doLoadBeanDefinitions方法,源碼如下:
//從特定XML文件中實際載入Bean定義資源的方法 protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) throws BeanDefinitionStoreException { try { //將XML文件轉(zhuǎn)換為DOM對象,解析過程由documentLoader實現(xiàn) Document doc = doLoadDocument(inputSource, resource); //這里是啟動對Bean定義解析的詳細(xì)過程,該解析過程會用到Spring的Bean配置規(guī)則 return registerBeanDefinitions(doc, resource); } 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方法即對Bean定義解析的詳細(xì)過程。
//按照Spring的Bean語義要求將Bean定義資源解析并轉(zhuǎn)換為容器內(nèi)部數(shù)據(jù)結(jié)構(gòu) public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException { //得到BeanDefinitionDocumentReader來對xml格式的BeanDefinition解析 BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader(); //獲得容器中注冊的Bean數(shù)量 int countBefore = getRegistry().getBeanDefinitionCount(); //解析過程入口,這里使用了委派模式,BeanDefinitionDocumentReader只是個接口, //具體的解析實現(xiàn)過程有實現(xiàn)類DefaultBeanDefinitionDocumentReader完成 documentReader.registerBeanDefinitions(doc, createReaderContext(resource)); //統(tǒng)計解析的Bean數(shù)量 return getRegistry().getBeanDefinitionCount() - countBefore; }
這里最后調(diào)用了DefaultBeanDefinitionDocumentReader的registerBeanDefinitions方法對xml文件的解析和注冊。源碼如下:
//根據(jù)Spring DTD對Bean的定義規(guī)則解析Bean定義Document對象 @Override public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { //獲得XML描述符 this.readerContext = readerContext; logger.debug("Loading bean definitions"); //獲得Document的根元素 Element root = doc.getDocumentElement(); doRegisterBeanDefinitions(root); } protected void doRegisterBeanDefinitions(Element root) { // Any nestedelements 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實現(xiàn), //BeanDefinitionParserDelegate中定義了Spring Bean定義XML文件的各種元素 BeanDefinitionParserDelegate parent = this.delegate; this.delegate = createDelegate(getReaderContext(), root, parent); if (this.delegate.isDefaultNamespace(root)) { String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE); if (StringUtils.hasText(profileSpec)) { String[] specifiedProfiles = StringUtils.tokenizeToStringArray( profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS); if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) { if (logger.isInfoEnabled()) { logger.info("Skipped XML bean definition file due to specified profiles [" + profileSpec + "] not matching: " + getReaderContext().getResource()); } return; } } } //在解析Bean定義之前,進(jìn)行自定義的解析,增強解析過程的可擴展性 preProcessXml(root); //從Document的根元素開始進(jìn)行Bean定義的Document對象 parseBeanDefinitions(root, this.delegate); //在解析Bean定義之后,進(jìn)行自定義的解析,增加解析過程的可擴展性 postProcessXml(root); this.delegate = parent; }
這里主要分析觀察parseBeanDefinitions方法是如何解析配置文件的。源碼如下:
//使用Spring的Bean規(guī)則從Document的根元素開始進(jìn)行Bean定義的Document對象 protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { //Bean定義的Document對象使用了Spring默認(rèn)的XML命名空間 if (delegate.isDefaultNamespace(root)) { //獲取Bean定義的Document對象根元素的所有子節(jié)點 NodeList nl = root.getChildNodes(); for (int i = 0; i < nl.getLength(); i++) { Node node = nl.item(i); //獲得Document節(jié)點是XML元素節(jié)點 if (node instanceof Element) { Element ele = (Element) node; //Bean定義的Document的元素節(jié)點使用的是Spring默認(rèn)的XML命名空間 if (delegate.isDefaultNamespace(ele)) { //使用Spring的Bean規(guī)則解析元素節(jié)點 parseDefaultElement(ele, delegate); } else { //沒有使用Spring默認(rèn)的XML命名空間,則使用用戶自定義的解//析規(guī)則解析元素節(jié)點 delegate.parseCustomElement(ele); } } } } else { //Document的根節(jié)點沒有使用Spring默認(rèn)的命名空間,則使用用戶自定義的 //解析規(guī)則解析Document根節(jié)點 delegate.parseCustomElement(root); } }
可以看到這里有針對默認(rèn)命名空間的解析過程,也有針對自定義命名空間的解析過程,這里要注意的是針對非默認(rèn)命名空間是通過NamespaceHandler的handler方法解析的(這里在講解aop的時候會重點講),所以現(xiàn)在我們來分析針對默認(rèn)命名空間的解析過程parseDefaultElement方法,源碼如下:
//使用Spring的Bean規(guī)則解析Document元素節(jié)點 private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) { //如果元素節(jié)點是導(dǎo)入元素,進(jìn)行導(dǎo)入解析 if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) { importBeanDefinitionResource(ele); } //如果元素節(jié)點是 別名元素,進(jìn)行別名解析 else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) { processAliasRegistration(ele); } //元素節(jié)點既不是導(dǎo)入元素,也不是別名元素,即普通的 元素, //按照Spring的Bean規(guī)則解析元素 else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) { processBeanDefinition(ele, delegate); } else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) { // recurse doRegisterBeanDefinitions(ele); } }
可以看到的是這里包括對
//解析導(dǎo)入元素,從給定的導(dǎo)入路徑加載Bean定義資源到Spring IoC容器中 protected void importBeanDefinitionResource(Element ele) { //獲取給定的導(dǎo)入元素的location屬性 String location = ele.getAttribute(RESOURCE_ATTRIBUTE); //如果導(dǎo)入元素的location屬性值為空,則沒有導(dǎo)入任何資源,直接返回 if (!StringUtils.hasText(location)) { getReaderContext().error("Resource location must not be empty", ele); return; } // Resolve system properties: e.g. "${user.dir}" //使用系統(tǒng)變量值解析location屬性值 location = getReaderContext().getEnvironment().resolveRequiredPlaceholders(location); Set actualResources = new LinkedHashSet<>(4); // Discover whether the location is an absolute or relative URI //標(biāo)識給定的導(dǎo)入元素的location是否是絕對路徑 boolean absoluteLocation = false; try { absoluteLocation = ResourcePatternUtils.isUrl(location) || ResourceUtils.toURI(location).isAbsolute(); } catch (URISyntaxException ex) { // cannot convert to an URI, considering the location relative // unless it is the well-known Spring prefix "classpath*:" //給定的導(dǎo)入元素的location不是絕對路徑 } // Absolute or relative? //給定的導(dǎo)入元素的location是絕對路徑 if (absoluteLocation) { try { //使用資源讀入器加載給定路徑的Bean定義資源 int importCount = getReaderContext().getReader().loadBeanDefinitions(location, actualResources); if (logger.isDebugEnabled()) { logger.debug("Imported " + importCount + " bean definitions from URL location [" + location + "]"); } } catch (BeanDefinitionStoreException ex) { getReaderContext().error( "Failed to import bean definitions from URL location [" + location + "]", ele, ex); } } else { // No URL -> considering resource location as relative to the current file. //給定的導(dǎo)入元素的location是相對路徑 try { int importCount; //將給定導(dǎo)入元素的location封裝為相對路徑資源 Resource relativeResource = getReaderContext().getResource().createRelative(location); //封裝的相對路徑資源存在 if (relativeResource.exists()) { //使用資源讀入器加載Bean定義資源 importCount = getReaderContext().getReader().loadBeanDefinitions(relativeResource); actualResources.add(relativeResource); } //封裝的相對路徑資源不存在 else { //獲取Spring IOC容器資源讀入器的基本路徑 String baseLocation = getReaderContext().getResource().getURL().toString(); //根據(jù)Spring IOC容器資源讀入器的基本路徑加載給定導(dǎo)入路徑的資源 importCount = getReaderContext().getReader().loadBeanDefinitions( StringUtils.applyRelativePath(baseLocation, location), actualResources); } if (logger.isDebugEnabled()) { logger.debug("Imported " + importCount + " bean definitions from relative location [" + location + "]"); } } catch (IOException ex) { getReaderContext().error("Failed to resolve current resource location", ele, ex); } catch (BeanDefinitionStoreException ex) { getReaderContext().error("Failed to import bean definitions from relative location [" + location + "]", ele, ex); } } Resource[] actResArray = actualResources.toArray(new Resource[actualResources.size()]); //在解析完 元素之后,發(fā)送容器導(dǎo)入其他資源處理完成事件 getReaderContext().fireImportProcessed(location, actResArray, extractSource(ele)); }
可以看到這里主要對路徑的解析,針對絕對路徑或者相對路徑調(diào)用XmlBeanDefinitionReader的loadBeanDefinitions方法進(jìn)行BeanDefinition的解析定位,并且在解析完成之后發(fā)送容器導(dǎo)入其他資源處理完成事件。
下面分析
//解析別名元素,為Bean向Spring IoC容器注冊別名 protected void processAliasRegistration(Element ele) { //獲取 別名元素中name的屬性值 String name = ele.getAttribute(NAME_ATTRIBUTE); //獲取 別名元素中alias的屬性值 String alias = ele.getAttribute(ALIAS_ATTRIBUTE); boolean valid = true; // 別名元素的name屬性值為空 if (!StringUtils.hasText(name)) { getReaderContext().error("Name must not be empty", ele); valid = false; } // 別名元素的alias屬性值為空 if (!StringUtils.hasText(alias)) { getReaderContext().error("Alias must not be empty", ele); valid = false; } if (valid) { try { //向容器的資源讀入器注冊別名 getReaderContext().getRegistry().registerAlias(name, alias); } catch (Exception ex) { getReaderContext().error("Failed to register alias "" + alias + "" for bean with name "" + name + """, ele, ex); } //在解析完 元素之后,發(fā)送容器別名處理完成事件 getReaderContext().fireAliasRegistered(name, alias, extractSource(ele)); } }
可以看到這里的解析過程比較簡單,分別去除bean名稱以及別名,然后向容器注冊別名,最后發(fā)送容器注冊別名處理完成事件。下面繼續(xù)分析對
//解析Bean定義資源Document對象的普通元素 protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); // BeanDefinitionHolder是對BeanDefinition的封裝,即Bean定義的封裝類 //對Document對象中元素的解析由BeanDefinitionParserDelegate實現(xiàn) // BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); if (bdHolder != null) { bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder); try { // Register the final decorated instance. //向Spring IOC容器注冊解析得到的Bean定義,這是Bean定義向IOC容器注冊的入口 BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry()); } catch (BeanDefinitionStoreException ex) { getReaderContext().error("Failed to register bean definition with name "" + bdHolder.getBeanName() + """, ele, ex); } // Send registration event. //在完成向Spring IOC容器注冊解析得到的Bean定義之后,發(fā)送注冊事件 getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder)); } }
可以看到這里主要包括兩個過程,第一個是對節(jié)點的解析封裝,第二個是bean定義的注冊。我們先看對節(jié)點的解析封裝,這里的解析是委托給了BeanDefinitionParserDelegate的parseBeanDefinitionElement方法,源碼如下:
//解析Bean定義資源文件中的元素,這個方法中主要處理 元素的id,name和別名屬性 @Nullable public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) { //獲取 元素中的id屬性值 String id = ele.getAttribute(ID_ATTRIBUTE); //獲取 元素中的name屬性值 String nameAttr = ele.getAttribute(NAME_ATTRIBUTE); //獲取 元素中的alias屬性值 List aliases = new ArrayList<>(); //將 元素中的所有name屬性值存放到別名中 if (StringUtils.hasLength(nameAttr)) { String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS); aliases.addAll(Arrays.asList(nameArr)); } String beanName = id; //如果 元素中沒有配置id屬性時,將別名中的第一個值賦值給beanName if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) { beanName = aliases.remove(0); if (logger.isDebugEnabled()) { logger.debug("No XML "id" specified - using "" + beanName + "" as bean name and " + aliases + " as aliases"); } } //檢查 元素所配置的id或者name的唯一性,containingBean標(biāo)識 //元素中是否包含子 元素 if (containingBean == null) { //檢查 元素所配置的id、name或者別名是否重復(fù) checkNameUniqueness(beanName, aliases, ele); } //詳細(xì)對 元素中配置的Bean定義進(jìn)行解析的地方 AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean); if (beanDefinition != null) { if (!StringUtils.hasText(beanName)) { try { if (containingBean != null) { //如果 元素中沒有配置id、別名或者name,且沒有包含子元素 // 元素,為解析的Bean生成一個唯一beanName并注冊 beanName = BeanDefinitionReaderUtils.generateBeanName(beanDefinition, this.readerContext.getRegistry(), true); } else { //如果 元素中沒有配置id、別名或者name,且包含了子元素 // 元素,為解析的Bean使用別名向IOC容器注冊 beanName = this.readerContext.generateBeanName(beanDefinition); // Register an alias for the plain bean class name, if still possible, // if the generator returned the class name plus a suffix. // This is expected for Spring 1.2/2.0 backwards compatibility. //為解析的Bean使用別名注冊時,為了向后兼容 //Spring1.2/2.0,給別名添加類名后綴 String beanClassName = beanDefinition.getBeanClassName(); if (beanClassName != null && beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() && !this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) { aliases.add(beanClassName); } } if (logger.isDebugEnabled()) { logger.debug("Neither XML "id" nor "name" specified - " + "using generated bean name [" + beanName + "]"); } } catch (Exception ex) { error(ex.getMessage(), ele); return null; } } String[] aliasesArray = StringUtils.toStringArray(aliases); return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray); } //當(dāng)解析出錯時,返回null return null; }
可以看到這里的具體的解析過程交給了parseBeanDefinitionElement方法。
public AbstractBeanDefinition parseBeanDefinitionElement( Element ele, String beanName, @Nullable BeanDefinition containingBean) { //記錄解析的this.parseState.push(new BeanEntry(beanName)); //這里只讀取 元素中配置的class名字,然后載入到BeanDefinition中去 //只是記錄配置的class名字,不做實例化,對象的實例化在依賴注入時完成 String className = null; //如果 元素中配置了parent屬性,則獲取parent屬性的值 if (ele.hasAttribute(CLASS_ATTRIBUTE)) { className = ele.getAttribute(CLASS_ATTRIBUTE).trim(); } String parent = null; if (ele.hasAttribute(PARENT_ATTRIBUTE)) { parent = ele.getAttribute(PARENT_ATTRIBUTE); } try { //根據(jù) 元素配置的class名稱和parent屬性值創(chuàng)建BeanDefinition //為載入Bean定義信息做準(zhǔn)備 AbstractBeanDefinition bd = createBeanDefinition(className, parent); //對當(dāng)前的 元素中配置的一些屬性進(jìn)行解析和設(shè)置,如配置的單態(tài)(singleton)屬性等 parseBeanDefinitionAttributes(ele, beanName, containingBean, bd); //為 元素解析的Bean設(shè)置description信息 bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT)); //對 元素的meta(元信息)屬性解析 parseMetaElements(ele, bd); //對 元素的lookup-method屬性解析 parseLookupOverrideSubElements(ele, bd.getMethodOverrides()); //對 元素的replaced-method屬性解析 parseReplacedMethodSubElements(ele, bd.getMethodOverrides()); //解析 元素的構(gòu)造方法設(shè)置 parseConstructorArgElements(ele, bd); //解析 元素的 設(shè)置 parsePropertyElements(ele, bd); //解析 元素的qualifier屬性 parseQualifierElements(ele, bd); //為當(dāng)前解析的Bean設(shè)置所需的資源和依賴對象 bd.setResource(this.readerContext.getResource()); bd.setSource(extractSource(ele)); return bd; } catch (ClassNotFoundException ex) { error("Bean class [" + className + "] not found", ele, ex); } catch (NoClassDefFoundError err) { error("Class that bean class [" + className + "] depends on not found", ele, err); } catch (Throwable ex) { error("Unexpected failure during bean definition parsing", ele, ex); } finally { this.parseState.pop(); } //解析 元素出錯時,返回null return null; }
然后我們分析注冊部分,源碼如下:
//將解析的BeanDefinitionHold注冊到容器中 public static void registerBeanDefinition( BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry) throws BeanDefinitionStoreException { // Register bean definition under primary name. //獲取解析的BeanDefinition的名稱 String beanName = definitionHolder.getBeanName(); //向IOC容器注冊BeanDefinition registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition()); // Register aliases for bean name, if any. //如果解析的BeanDefinition有別名,向容器為其注冊別名 String[] aliases = definitionHolder.getAliases(); if (aliases != null) { for (String alias : aliases) { registry.registerAlias(beanName, alias); } } }
接下來分析BeanDefinitionRegistry的registerBeanDefinition方法,這里的BeanDefinitionRegistry是一個接口,最終由容器DefaultListableBeanFactory進(jìn)行注冊,源碼如下:
//向IOC容器注冊解析的BeanDefiniton @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"); //校驗解析的BeanDefiniton 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; oldBeanDefinition = this.beanDefinitionMap.get(beanName); 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() < beanDefinition.getRole()) { // e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE 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)) { if (this.logger.isInfoEnabled()) { this.logger.info("Overriding bean definition for bean "" + beanName + "" with a different definition: replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]"); } } else { if (this.logger.isDebugEnabled()) { this.logger.debug("Overriding bean definition for bean "" + beanName + "" with an equivalent definition: replacing [" + oldBeanDefinition + "] with [" + beanDefinition + "]"); } } this.beanDefinitionMap.put(beanName, beanDefinition); } else { if (hasBeanCreationStarted()) { // Cannot modify startup-time collection elements anymore (for stable iteration) //注冊的過程中需要線程同步,以保證數(shù)據(jù)的一致性 synchronized (this.beanDefinitionMap) { this.beanDefinitionMap.put(beanName, beanDefinition); ListupdatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1); updatedDefinitions.addAll(this.beanDefinitionNames); updatedDefinitions.add(beanName); this.beanDefinitionNames = updatedDefinitions; if (this.manualSingletonNames.contains(beanName)) { Set updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames); updatedSingletons.remove(beanName); this.manualSingletonNames = updatedSingletons; } } } else { // Still in startup registration phase this.beanDefinitionMap.put(beanName, beanDefinition); this.beanDefinitionNames.add(beanName); this.manualSingletonNames.remove(beanName); } this.frozenBeanDefinitionNames = null; } //檢查是否有同名的BeanDefinition已經(jīng)在IOC容器中注冊 if (oldBeanDefinition != null || containsSingleton(beanName)) { //重置所有已經(jīng)注冊過的BeanDefinition的緩存 resetBeanDefinition(beanName); } }
可以看到最終將bean定義注冊進(jìn)了一個Map結(jié)構(gòu)的beanDefinitionMap。
至此,IOC容器的初始化工作進(jìn)行完畢,下篇會分析bean的后置處理器是如何工作的。
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://specialneedsforspecialkids.com/yun/76977.html
摘要:初始化我們知道容器初始化后會對容器中非懶加載的,單例的以及非抽象的定義進(jìn)行的初始化操作,所以我們分析源碼的入口也就是在容器初始化的入口,分析容器初始化后在什么地方開始第一次的初始化。 前言 Spring IOC容器在初始化之后會對容器中非懶加載的,單例的以及非抽象的bean定義進(jìn)行bean的初始化操作,同時會也涉及到Bean的后置處理器以及DI(依賴注入)等行為。對于Bean的初始化,...
摘要:的在單例被破壞時由進(jìn)行方法調(diào)用。定義并實現(xiàn)這兩個接口容器創(chuàng)建完成注解是的縮寫,意思是規(guī)范提案。在創(chuàng)建完成并且屬性賦值完成來執(zhí)行初始化方法在容器銷毀之前回調(diào)通知支持自動裝配,類似。 Spring注解應(yīng)用篇--IOC容器Bean生命周期 這是Spring注解專題系類文章,本系類文章適合Spring入門者或者原理入門者,小編會在本系類文章下進(jìn)行企業(yè)級應(yīng)用實戰(zhàn)講解以及spring源碼跟進(jìn)。本文...
摘要:前言這篇是專題初始化的第二篇,主要對初始化具體過程的源碼分析。上篇博客專題之初始化源碼分析中我們對如何開始初始化以及初始化的總體過程有了大致的了解,接下來就繼續(xù)上篇博客的結(jié)尾處開始來分析初始化的具體過程。 前言 這篇是Spring專題Bean初始化的第二篇,主要對bean初始化具體過程的源碼分析。上篇博客Spring專題之Bean初始化源碼分析(1)中我們對Spring如何開始初始化b...
摘要:用法先創(chuàng)建個組件,,,分別在類上加上注解。發(fā)現(xiàn)有一個屬性源碼注釋這樣說的自動檢測使用組件。在的方法中,表示不匹配,代表匹配。這就說明使用注冊組件有種方式。 Spring注解應(yīng)用篇--IOC容器Bean組件注冊 這是Spring注解專題系類文章,本系類文章適合Spring入門者或者原理入門者,小編會在本系類文章下進(jìn)行企業(yè)級應(yīng)用實戰(zhàn)講解以及spring源碼跟進(jìn)。 環(huán)境準(zhǔn)備 編譯器IDEA...
閱讀 3748·2023-01-11 11:02
閱讀 4254·2023-01-11 11:02
閱讀 3072·2023-01-11 11:02
閱讀 5189·2023-01-11 11:02
閱讀 4750·2023-01-11 11:02
閱讀 5561·2023-01-11 11:02
閱讀 5327·2023-01-11 11:02
閱讀 4023·2023-01-11 11:02