回顧上篇
上篇文章讀取配置檔案中,我們已經分析到spring如何讀取配置檔案(BeanFactoryTest.xml),并最終把配置檔案轉換成Document 對象。接下來Spring會去解析Document 對象,并将解析出來的資訊放到BeanDefinition中。最後BeanDefinition會被封裝到BeanDefinitionHolder中。接下來我們就跟着源碼,看看這一步是如何來實作的。
分析源碼實作
首先我們debug一下,看看解析BeanFactoryTest.xml配置檔案後建立出來的BeanDefinition裡面都有什麼屬性。
由于我們配置檔案寫的比較簡單,隻配置了一個id和class,是以在BeanDefinition中我們就看到一個beanClass屬性的值是我們再配置檔案中配置的。也就是說解析完配置檔案之後,我們配置的class屬性,就會儲存在BeanDefinition的beanClass這個字段中。
下面我們就看看Spring怎麼去解析Document對象,生成BeanDefinition的。
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
Document doc = doLoadDocument(inputSource, resource);
int count = registerBeanDefinitions(doc, resource);
if (logger.isDebugEnabled()) {
logger.debug("Loaded " + count + " bean definitions from " + resource);
}
return count;
}
在上面代碼中(為了閱讀友善,這裡把try-catch的代碼删除了),我們看到,擷取到Document對象後,就把Document作為參數,傳入了registerBeanDefinitions方法裡。
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
這裡首先是建立了一個BeanDefinitionDocumentReader, 然後調用BeanDefinitionDocumentReader的registerBeanDefinitions方法來去處了解析和注冊的邏輯。前面讀取XML,将XML配置檔案轉換成Document都是在XmlBeanDefinitionReader這個類裡面進行處理的,現在使用BeanDefinitionDocumentReader來對Document對象進行解析和注冊bean。這裡很好的展現了面向對象裡單一職責的原則。進入到registerBeanDefinitions方法裡面,看看裡面的處理邏輯。
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
doRegisterBeanDefinitions(doc.getDocumentElement());
}
protected void doRegisterBeanDefinitions(Element root) {
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);
// 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;
}
}
}
preProcessXml(root);
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);
this.delegate = parent;
}
在registerBeanDefinitions中,隻是提取了root。然後将root作為參數傳入doRegisterBeanDefinitions中,進行解析。這裡主要的解析邏輯是在parseBeanDefinitions(root, this.delegate)這行代碼中。
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);
}
}
這裡我們先看看root裡面都有什麼東西。
我們看到root裡面儲存的其實就是XML檔案裡面配置的beans節點的資訊。在parseBeanDefinitions這個方法主要邏輯是
1、判斷是否為預設命名空間。其實就是判斷節點namespaceURI是不是http://www.springframework.org/schema
/beans。是的話就是預設命名空間。
2、擷取root節點的子節點(NodeList nl = root.getChildNodes())。這裡擷取的子節點中包含了兩個text節點和一個bean節點,bean節點就是XML配置檔案中我們配置的bean,而text節點是不會去解析的,這個節點隻是我們在XML中配置bean的時候,換行産生的,裡面就是換行符。
3、循環周遊所有子節點,預設命名空間調用預設解析方法parseDefaultElement,非預設命名空間調用自定義解析方法parseCustomElement。
由于我們配置的bean是預設的命名空間,是以應該調用預設解析方法。
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);
}
}
這裡分别對四種節點(import、alias、bean、beans )進行判斷,不同的節點使用不同的方法進行解析。我們這邊傳入的bean節點,是以看到解析bean節點的方法processBeanDefinition。
(解析其它節點的方法暫時先忽略,等看完如何解析bean之後,再去看就會容易很多了)
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//1、解析bean節點得到一個BeanDefinitionHolder
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
//2、如果節點存在自定義屬性,那麼就還需要對自定義的屬性進行解析
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// 3、注冊BeanDefinition
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// 4、發送注冊事件,通知監聽器,bean已經加裝完成
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
我們先看 BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);這行代碼。
解析bean節點得到一個BeanDefinitionHolder
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
return parseBeanDefinitionElement(ele, null);
}
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
String id = ele.getAttribute(ID_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
List<String> aliases = new ArrayList<>();
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isTraceEnabled()) {
logger.trace("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
if (containingBean == null) {
checkNameUniqueness(beanName, aliases, ele);
}
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
if (beanDefinition != null) {
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
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.
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isTraceEnabled()) {
logger.trace("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);
}
return null;
}
這段代碼大緻做了下面幾件事
1、解析id和name屬性,并将beanName的值設定為id的值。這裡id的值就是我們XML配置檔案中配置的id的值myTestBean。
2、進一步解析其它的屬性,并傳回一個AbstractBeanDefinition,這個AbstractBeanDefinition其實是GenericBeanDefinition,也是後面往Spring裡注冊的BeanDefinition。
這裡我們看看具體代碼
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
this.parseState.push(new BeanEntry(beanName));
//解析class屬性
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
//解析parent屬性
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
//建立AbstractBeanDefinition,進入createBeanDefinition你可以看到這邊建立的是一個GenericBeanDefinition
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
//解析預設bean的各種屬性 例如 scope、abstract、lazy-init、init-method、destroy-method
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
//解析中繼資料
parseMetaElements(ele, bd);
//解析lookup-method屬性
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
//解析replaced-method屬性
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
//解析構造函數參數
parseConstructorArgElements(ele, bd);
//解析property
parsePropertyElements(ele, bd);
//解析qualifier
parseQualifierElements(ele, bd);
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();
}
return null;
}
每個步驟做什麼注釋上都已經寫了,具體怎麼解析的可以進入到每一個步驟裡面去詳細了解。到這裡所有的解析工作都已經完成了,我們已經看到Spring建立了一個AbstractBeanDefinition,這裡已經包含一個bean的所有資訊。
3、beanName沒有值,則使用預設規則生成beanName。如果我們在xml中配置bean的時候,既沒有配置bean的class屬性,也沒有配置name屬性,那麼這裡beanName就會沒有值。
4、将AbstractBeanDefinition、beanName、aliasesArray封裝到BeanDefinitionHolder中。
到這裡解析bean節點得到一個BeanDefinitionHolder的工作就已經完成了。