在我們實(shí)現(xiàn)的 Spring 框架中,每一個(gè)章節(jié)都會(huì)結(jié)合上一章節(jié)繼續(xù)擴(kuò)展功能,就像每一次產(chǎn)品都在加需求一樣,那么在學(xué)習(xí)的過(guò)程中可以承上啟下的對(duì)照和參考,看看每一個(gè)模塊的添加都是用什么邏輯和技術(shù)細(xì)節(jié)實(shí)現(xiàn)的。這些內(nèi)容的學(xué)習(xí),會(huì)非常有利于你以后在設(shè)計(jì)和實(shí)現(xiàn),自己承接產(chǎn)品需求時(shí)做的具體開(kāi)發(fā),代碼的質(zhì)量也會(huì)越來(lái)越高,越來(lái)越有擴(kuò)展性和可維護(hù)性。
二、目標(biāo)
在完成 Spring 的框架雛形后,現(xiàn)在我們可以通過(guò)單元測(cè)試進(jìn)行手動(dòng)操作 Bean 對(duì)象的定義、注冊(cè)和屬性填充,以及最終獲取對(duì)象調(diào)用方法。但這里會(huì)有一個(gè)問(wèn)題,就是如果實(shí)際使用這個(gè) Spring 框架,是不太可能讓用戶通過(guò)手動(dòng)方式創(chuàng)建的,而是最好能通過(guò)配置文件的方式簡(jiǎn)化創(chuàng)建過(guò)程。需要完成如下操作:
如圖中我們需要把步驟:2、3、4整合到Spring框架中,通過(guò) Spring 配置文件的方式將 Bean 對(duì)象實(shí)例化。
接下來(lái)我們就需要在現(xiàn)有的 Spring 框架中,添加能解決 Spring 配置的讀取、解析、注冊(cè)Bean的操作。
三、設(shè)計(jì)
依照本章節(jié)的需求背景,我們需要在現(xiàn)有的 Spring 框架雛形中添加一個(gè)資源解析器,也就是能讀取classpath、本地文件和云文件的配置內(nèi)容。這些配置內(nèi)容就是像使用 Spring 時(shí)配置的 Spring.xml 一樣,里面會(huì)包括 Bean 對(duì)象的描述和屬性信息。在讀取配置文件信息后,接下來(lái)就是對(duì)配置文件中的 Bean 描述信息解析后進(jìn)行注冊(cè)操作,把 Bean 對(duì)象注冊(cè)到 Spring 容器中。整體設(shè)計(jì)結(jié)構(gòu)如下圖:
資源加載器屬于相對(duì)獨(dú)立的部分,它位于 Spring 框架核心包下的IO實(shí)現(xiàn)內(nèi)容,主要用于處理Class、本地和云環(huán)境中的文件信息。
當(dāng)資源可以加載后,接下來(lái)就是解析和注冊(cè) Bean 到 Spring 中的操作,這部分實(shí)現(xiàn)需要和 DefaultListableBeanFactory 核心類結(jié)合起來(lái),因?yàn)槟闼械慕馕龊蟮淖?cè)動(dòng)作,都會(huì)把 Bean 定義信息放入到這個(gè)類中。
ListableBeanFactory,是一個(gè)擴(kuò)展 Bean 工廠接口的接口,新增加了 getBeansOfType、getBeanDefinitionNames() 方法,在 Spring 源碼中還有其他擴(kuò)展方法。
HierarchicalBeanFactory,在 Spring 源碼中它提供了可以獲取父類 BeanFactory 方法,屬于是一種擴(kuò)展工廠的層次子接口。Sub-interface implemented by bean factories that can be part of a hierarchy.
publicClassPathResource(String path, ClassLoader classLoader){ Assert.notNull(path, "Path must not be null"); this.path = path; this.classLoader = (classLoader != null ? classLoader : ClassUtils.getDefaultClassLoader()); }
@Override public InputStream getInputStream()throws IOException { InputStream is = classLoader.getResourceAsStream(path); if (is == null) { thrownew FileNotFoundException( this.path + " cannot be opened because it does not exist"); } return is; } }
這樣在接口 BeanDefinitionReader 的具體實(shí)現(xiàn)類中,就可以把解析后的 XML 文件中的 Bean 信息,注冊(cè)到 Spring 容器去了。以前我們是通過(guò)單元測(cè)試使用,調(diào)用 BeanDefinitionRegistry 完成Bean的注冊(cè),現(xiàn)在可以放到 XMl 中操作了
for (int i = 0; i < childNodes.getLength(); i++) { // 判斷元素 if (!(childNodes.item(i) instanceof Element)) continue; // 判斷對(duì)象 if (!"bean".equals(childNodes.item(i).getNodeName())) continue;
// 解析標(biāo)簽 Element bean = (Element) childNodes.item(i); String id = bean.getAttribute("id"); String name = bean.getAttribute("name"); String className = bean.getAttribute("class"); // 獲取 Class,方便獲取類中的名稱 Class<?> clazz = Class.forName(className); // 優(yōu)先級(jí) id > name String beanName = StrUtil.isNotEmpty(id) ? id : name; if (StrUtil.isEmpty(beanName)) { beanName = StrUtil.lowerFirst(clazz.getSimpleName()); }
// 定義Bean BeanDefinition beanDefinition = new BeanDefinition(clazz); // 讀取屬性并填充 for (int j = 0; j < bean.getChildNodes().getLength(); j++) { if (!(bean.getChildNodes().item(j) instanceof Element)) continue; if (!"property".equals(bean.getChildNodes().item(j).getNodeName())) continue; // 解析標(biāo)簽:property Element property = (Element) bean.getChildNodes().item(j); String attrName = property.getAttribute("name"); String attrValue = property.getAttribute("value"); String attrRef = property.getAttribute("ref"); // 獲取屬性值:引入對(duì)象、值對(duì)象 Object value = StrUtil.isNotEmpty(attrRef) ? new BeanReference(attrRef) : attrValue; // 創(chuàng)建屬性信息 PropertyValue propertyValue = new PropertyValue(attrName, value); beanDefinition.getPropertyValues().addPropertyValue(propertyValue); } if (getRegistry().containsBeanDefinition(beanName)) { thrownew BeansException("Duplicate beanName[" + beanName + "] is not allowed"); } // 注冊(cè) BeanDefinition getRegistry().registerBeanDefinition(beanName, beanDefinition); } }
}
XmlBeanDefinitionReader 類最核心的內(nèi)容就是對(duì) XML 文件的解析,把我們本來(lái)在代碼中的操作放到了通過(guò)解析 XML 自動(dòng)注冊(cè)的方式。
loadBeanDefinitions 方法,處理資源加載,這里新增加了一個(gè)內(nèi)部方法:doLoadBeanDefinitions,它主要負(fù)責(zé)解析 xml
在上面的測(cè)試案例中可以看到,我們把以前通過(guò)手動(dòng)注冊(cè) Bean 以及配置屬性信息的內(nèi)容,交給了 new XmlBeanDefinitionReader(beanFactory) 類讀取 Spring.xml 的方式來(lái)處理,并通過(guò)了測(cè)試驗(yàn)證。
六、總結(jié)
此時(shí)的工程結(jié)構(gòu)已經(jīng)越來(lái)越有 Spring 框架的味道了,以配置文件為入口解析和注冊(cè) Bean 信息,最終再通過(guò) Bean 工廠獲取 Bean 以及做相應(yīng)的調(diào)用操作。
關(guān)于案例中每一個(gè)步驟的實(shí)現(xiàn)小傅哥這里都會(huì)盡可能參照 Spring 源碼的接口定義、抽象類實(shí)現(xiàn)、名稱規(guī)范、代碼結(jié)構(gòu)等,做相應(yīng)的簡(jiǎn)化處理。這樣大家在學(xué)習(xí)的過(guò)程中也可以通過(guò)類名或者接口和整個(gè)結(jié)構(gòu)體學(xué)習(xí) Spring 源碼,這樣學(xué)習(xí)起來(lái)就容易多了。