首先,先看我自己画的BeanFactory启动时的时序图。
第一次接触时序图,可能有些地方画的不是很符合时序图的规则,大家只关注调用顺序即可。
public static void main(String[] args){ BeanFactory factory=new XmlBeanFactory(new ClassPathResource("applicationContext2.xml")); }
另外,上面的xmlbeanfactory已经被废弃,改为
Resource resource=new ClassPathResource("applicationContext2.xml"); BeanFactory factory=new DefaultListableBeanFactory(); BeanDefinitionReader bdr=new XmlBeanDefinitionReader((BeanDefinitionRegistry) factory); bdr.loadBeanDefinitions(resource);
但是处理逻辑没怎么变
我们从这一行代码开始。
关于Resources与ResourcesLoader的资料,大家可以看http://www.blogjava.net/DLevin/category/54913.html
public class XmlBeanFactory extends DefaultListableBeanFactory { private final XmlBeanDefinitionReader reader = new XmlBeanDefinitionReader(this); public XmlBeanFactory(Resource resource) throws BeansException { this(resource, null); } public XmlBeanFactory(Resource resource, BeanFactory parentBeanFactory) throws BeansException { super(parentBeanFactory); this.reader.loadBeanDefinitions(resource); } }
OK,我们之间开始看XmlBeanDefinitionReader的loadBeanDefinitions。(图中的第二步)
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException { .... InputStream inputStream = encodedResource.getResource().getInputStream(); InputSource inputSource = new InputSource(inputStream); if (encodedResource.getEncoding() != null) { inputSource.setEncoding(encodedResource.getEncoding()); } return doLoadBeanDefinitions(inputSource, encodedResource.getResource()); .... }
上面的EncodedResource是对Resource的再包装,不是重点。重点在doLoadBeanDefinitions
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) throws BeanDefinitionStoreException { Document doc = this.documentLoader.loadDocument( inputSource, getEntityResolver(), this.errorHandler, validationMode, isNamespaceAware()); return registerBeanDefinitions(doc, resource); ... //省略try catch }
上面的documentLoader是DefaultDocumentLoader的实例,Document是org.w3c.dom.Document的实例。
我们不用看具体的代码都知道,这一行就是把xml文件读入到Document中。 这是上图中的第四步。
然后就是第五步registerBeanDefinitions。
//XmlBeanDefinitionReader.java public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException { BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader(); documentReader.setEnvironment(this.getEnvironment()); int countBefore = getRegistry().getBeanDefinitionCount(); documentReader.registerBeanDefinitions(doc, createReaderContext(resource)); return getRegistry().getBeanDefinitionCount() - countBefore; }
countBefore,就是之前已经注册了多少bean。
这里的重点在于:documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
而这个documentReader的默认实现是:DefaultBeanDefinitionDocumentReader
//DefaultBeanDefinitionDocumentReader.java public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) { this.readerContext = readerContext; logger.debug("Loading bean definitions"); Element root = doc.getDocumentElement(); doRegisterBeanDefinitions(root); } protected void doRegisterBeanDefinitions(Element root) { this.delegate = createHelper(readerContext, root, parent); //preProcessXml与postProcessXml都是空方法 preProcessXml(root); parseBeanDefinitions(root, this.delegate); postProcessXml(root); this.delegate = parent; } protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) { //<beans xmlns="http://www.springframework.org/schema/beans" /> //查看是否是默认的命名空间 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)) { //这一行用来出来bean标签 parseDefaultElement(ele, delegate); } else { delegate.parseCustomElement(ele); } } } } else { delegate.parseCustomElement(root); } }
我们看看我调试时的一张图
NodeList保持这所有bean的信息。
parseDefaultElement(ele, delegate)这一行,就在for循环里,不断的处理每一个bean。
看到这,这个delegate是个什么东西。
我给大家看看一下BeanDefinitionParserDelegate的几个类变量。
public static final String NAME_ATTRIBUTE = "name"; public static final String BEAN_ELEMENT = "bean"; public static final String META_ELEMENT = "meta"; public static final String ID_ATTRIBUTE = "id"; public static final String PARENT_ATTRIBUTE = "parent"; public static final String CLASS_ATTRIBUTE = "class"; public static final String ABSTRACT_ATTRIBUTE = "abstract"; .....
猜都猜出来了:具体解析xml的。
这是图中的第九步。从这之后都是循环处理每一个bean/import/alias/节点。
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) { //是否是import节点 if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) { importBeanDefinitionResource(ele); } else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) { processAliasRegistration(ele); } //是否是bean节点 else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) { processBeanDefinition(ele, delegate); } else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) { // recurse doRegisterBeanDefinitions(ele); } }
我们抓主要矛盾,看processBeanDefinition,这已经是图中的第十步了。
大家看看上图中第八步与第十步的名称processBeanDefinitions与processBeanDefinition。就明白他们的关系了。
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder); // Register the final decorated instance. BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry()); getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder)); }
在这里我简单介绍一下BeanDefinitionHolder
Bean----我们使用的各个基本组件。
BeanDefinition---定义Bean,我们可以认为是对bean的包装。
BeanDefinitionHolder---持有BeanDefinition,我们可以认为是对BeanDefinition的包装。
我们看parseBeanDefinitionElement。也就是上图中的第11步。
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, BeanDefinition containingBean) { String id = ele.getAttribute(ID_ATTRIBUTE); String nameAttr = ele.getAttribute(NAME_ATTRIBUTE); String beanName = id; AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean); if (beanDefinition != null) { return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray); } return null; }
上面的代码,我已经删去了一部分。(注意,上面的两个parseBeanDefinitionElement方法,一个有两个参数一个有三个参数)
还是parseBeanDefinitionElement,继续解析。
第十一步:
//BeanDefinitionParserDelegate.java public AbstractBeanDefinition parseBeanDefinitionElement( Element ele, String beanName, BeanDefinition containingBean) { String className = null; String parent = null; if (ele.hasAttribute(PARENT_ATTRIBUTE)) { parent = ele.getAttribute(PARENT_ATTRIBUTE); } AbstractBeanDefinition bd = createBeanDefinition(className, parent); parseBeanDefinitionAttributes(ele, beanName, containingBean, bd); bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT)); parseMetaElements(ele, bd); parseLookupOverrideSubElements(ele, bd.getMethodOverrides()); parseReplacedMethodSubElements(ele, bd.getMethodOverrides()); parseConstructorArgElements(ele, bd); parsePropertyElements(ele, bd); parseQualifierElements(ele, bd); bd.setResource(this.readerContext.getResource()); bd.setSource(extractSource(ele)); return bd; }
parseLookupOverrideSubElements,parseConstructorArgElements,parsePropertyElements大家能猜出来里面是干什么的吗?
bean元素下面还包含property标签,lookup-method标签,replaced-method标签。
至于lookup-method标签,replaced-method标签里面都是干什么的。大家自己百度。
至于parsePropertyElements,它是处理property。
更具体的,就是xml的分析了,没有太多的技术点。我就不继续讲了。
咱们继续往下走。
第十一步结束后,就是
//DefaultBeanDefinitionDocumentReader.java protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) { //十一步 BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele); bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder); // Register the final decorated instance. //十二步 BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry()); getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder)); } //BeanDefinitionReaderUtils.java 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()); }
大家得记得,我们的容器,XmlBeanFactory本身也实现了BeanDefinitionRegistry。
所以registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
调用的就是XmlBeanFactory的registerBeanDefinition(XmlBeanFactory的父类DefaultListableBeanFactory就已经实现了registerBeanDefinition这个方法了)。
//DefaultListableBeanFactory.java public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition) throws BeanDefinitionStoreException { this.beanDefinitionNames.add(beanName); this.beanDefinitionMap.put(beanName, beanDefinition); resetBeanDefinition(beanName); }
beanDefinitionMap里面维护着整个容器里面的bean。
大功告成。
接着我们看
Spring BeanFactory getBean 源码剖析
感谢glt