Spring源码(一)-IOC容器BeanDefinition加载
创始人
2024-03-29 18:32:15
0

IOC容器

IOC容器的实现包含了两个非常重要的过程:

  • 读取XML配置生成BeanDefinition注册到IOC中;
  • 通过BeanDefinition实例化bean,并从IOC中通过getBean()获取Bean实例。
//spring源码中将一个bean的BeanDefinition放入到IOC中
this.beanDefinitionMap.put(beanName, beanDefinition);//Spring源码中通过beanName获取一个bean
public Object getBean(String name) throws BeansException {assertBeanFactoryActive();return getBeanFactory().getBean(name);
}

这两个过程还对应了两个非常核心的接口:
BeanDefinitionRegistry和BeanFactory,一个向IOC中注册BeanDefinition,一个从IOC获取Bean实例对象。
BeanDefinition是一个接口,无论是通过xml声明还是通过注解定义一个bean实例,在IOC容器中第一步总是为其对应生成一个BeanDefinition,里面包含了类的所有基本信息。其中AbstractBeanDefinition实现BeanDefinition,这个接口有两个子接口GenericBeanDefinition和RootBeanDefinition,再来看看BeanDefinition中的一些方法:

  • getBeanClassName()获取bean的全限定名;
  • getScope()获取该类的作用域;
  • isLazyInit()该类是否为懒加载;
  • getPropertyValues()获取配置的属性值列表(用于setter注入);
  • getConstructorArgumentValues()获取配置的构造函数值(用于构造器注入)等bean的重要信息,如果通过注解的方式,还会包含一些注解的属性信息;

总而言之 ,BeanDefinition包含了我们定义的一个类的所有信息,然后通过 BeanDefinitionRegistry接口的registerBeanDefinition注册到IOC容器中,最后通过BeanDefinition结合asm,反射等相关技术,便可通过BeanFactory接口的getBean()方法获取一个实例对象。实际过程中spring在实现IOC时,用了大量设计模式,比如:单例模式、模板方法、工厂模式、代理模式(AOP基本上全是)等,此外面向对象的基本原则中的单一职责、开放封闭原则等随处可见。

读取XML配置文件

    @Testpublic void testSpringLoad() {ClassPathXmlApplicationContext application = new ClassPathXmlApplicationContext("spring/spring-context.xml");BankPayService bankPayService = (BankPayService) application.getBean("bankPayService");Assert.assertNotNull(bankPayService);}
  


首先会进入ClassPathXmlApplicationContext的构造函数中:

public ClassPathXmlApplicationContext(String[] configLocations, boolean refresh, ApplicationContext parent){super(parent);//获取当前环境 装饰传入的路径setConfigLocations(configLocations);if (refresh) {//程序入口refresh();}
}

构造函数中最关键的部分是refresh()方法,该方法用于刷新IOC容器数据,该方法由AbstractApplicationContext实现。

@Overridepublic void refresh() throws BeansException, IllegalStateException {synchronized (this.startupShutdownMonitor) {// Prepare this context for refreshing.prepareRefresh();// 让子类去刷新beanFactory 进入这里查看ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();// Prepare the bean factory for use in this context.prepareBeanFactory(beanFactory);try {// Allows post-processing of the bean factory in context subclasses.postProcessBeanFactory(beanFactory);// Invoke factory processors registered as beans in the context.invokeBeanFactoryPostProcessors(beanFactory);// Register bean processors that intercept bean creation.registerBeanPostProcessors(beanFactory);// Initialize message source for this context.initMessageSource();// Initialize event multicaster for this context.initApplicationEventMulticaster();// Initialize other special beans in specific context subclasses.onRefresh();// Check for listener beans and register them.registerListeners();// Instantiate all remaining (non-lazy-init) singletons.finishBeanFactoryInitialization(beanFactory);// Last step: publish corresponding event.finishRefresh();}catch (BeansException ex) {// Destroy already created singletons to avoid dangling resources.destroyBeans();// Reset 'active' flag.cancelRefresh(ex);// Propagate exception to caller.throw ex;}}}

在refresh方法中主要完成了加载xml文件的环境配置、xml文件读取,注册BeanFactoryPostProcessor处理器、注册监听器等工作,其中比较核心的是第二行代码ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {//加载xml配置文件,生成BeanDefinition并注册到IOC容器中	refreshBeanFactory();//获取加载完xml文件之后的beanFactory对象ConfigurableListableBeanFactory beanFactory = getBeanFactory();if (logger.isDebugEnabled()) {logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);}return beanFactory;
}

refreshBeanFactory和getBeanFactory都是由AbstractApplicationContext的子类AbstractRefreshableApplicationContext实现的。

	@Overrideprotected final void refreshBeanFactory() throws BeansException {//如果beanFactory不为空 ,清除老的beanFactoryif (hasBeanFactory()) {destroyBeans();closeBeanFactory();}try {//创建一个beanFactoryDefaultListableBeanFactory beanFactory = createBeanFactory();beanFactory.setSerializationId(getId());//设置bean是否允许覆盖 是否允许循环依赖customizeBeanFactory(beanFactory);//加载beans声明,即读取xml或者扫描包 生成BeanDefinition注册到IOCloadBeanDefinitions(beanFactory);synchronized (this.beanFactoryMonitor) {this.beanFactory = beanFactory;}}catch (IOException ex) {throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);}
}

在Spring中DefaultListableBeanFactory是一个非常重要的类,它实现了BeanDefinitionRegistry和BeanFactory接口,并且完成了这两个接口的具体实现,DefaultListableBeanFactory的类图如下:
![image.png](https://img-blog.csdnimg.cn/img_convert/20cea7d37a9effcb36570baf13c448dc.png#averageHue=#f7f7f7&clientId=u6f28cd10-e06b-4&crop=0&crop=0&crop=1&crop=1&from=paste&height=374&id=ude0da7da&margin=[object Object]&name=image.png&originHeight=656&originWidth=1080&originalType=binary&ratio=1&rotation=0&showTitle=false&size=114694&status=done&style=none&taskId=uf854fa3a-a805-4849-ba59-747666ad6ba&title=&width=616)
BeanDefinitionRegistry完成了BeanDefinition的注册,BeanFactory完成了getBean()中bean的创建,其中xml读取和bean的入口就是loadBeanDefinitions(beanFactory)这个方法,loadBeanDefinitions是一个抽象方法,由类AbstractXmlApplicationContext实现。loadBeanDefinitions在AbstractXmlApplicationContext有很多个重载方法,在不通阶段方法使用的参数值不同,接下来看看各个loadBeanDefinitions的调用顺序:
创建XmlBeanDefinitionReader对象

	@Overrideprotected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {//Spring将读取xml操作委托给了XmlBeanDefinitionReader对象//并且传入DefaultListableBeanFactory将生成的beandefinition注册到IOC中XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);//设置Spring中bean的环境beanDefinitionReader.setEnvironment(this.getEnvironment());beanDefinitionReader.setResourceLoader(this);beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));// 设置beanDefinitionReader验证属性,子类可以重写该方法使用自定义reader对象initBeanDefinitionReader(beanDefinitionReader);//通过beanDefinitionReader读取xmlloadBeanDefinitions(beanDefinitionReader);}

Spring对于读取xml文件,是委托给了XmlBeanDefinitionReader,在该类内部会将xml配置文件转换成Resource,Spring封装了xml文件获取方式,使用ClassPathXmlApplicationContext读取xml,因此Spring会通过ClassLoader获取当前项目工作目录,并在该目录下查找spring-context.xml文件,当然还可以使用FileSystemXmlApplicationContext从文件系统上以绝对路径的方式读取文件。
继续查看第二个loadBeanDefinitions(beanDefinitionReader):

	protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {//默认返回为空子类可以实现该方法读取指定文件Resource[] configResources = getConfigResources();if (configResources != null) {reader.loadBeanDefinitions(configResources);}//获取我们配置的xml文件路径集合String[] configLocations = getConfigLocations();if (configLocations != null){reader.loadBeanDefinitions(configLocations);}}

在这个方法中,最终获取到了通过ClassPathXmlApplicationContext对象传进来的xml配置文件路径,然后进入委托对象XmlBeanDefinitionReader的loadBeanDefinitions方法中:

	@Overridepublic int loadBeanDefinitions(String... locations) throws BeanDefinitionStoreException {Assert.notNull(locations, "Location array must not be null");int counter = 0;for (String location : locations) {//循环读取配置的所有配置文件路径counter += loadBeanDefinitions(location);}//返回此次加载的BeanDefinition个数return counter;}

在XmlBeanDefinitionReader中,会循环读取配置的所有配置文件路径,并将读取到的bean的声明创建成BeanDefinition,并将此次生成的数量返回,继续查看loadBeanDefinitions:

	public int loadBeanDefinitions(String location, Set actualResources) throws BeanDefinitionStoreException {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 {Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);//实际执行到这里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.Resource resource = resourceLoader.getResource(location);int loadCount = loadBeanDefinitions(resource);if (actualResources != null) {actualResources.add(resource);}if (logger.isDebugEnabled()) {logger.debug("Loaded " + loadCount + " bean definitions from location [" + location + "]");}return loadCount;}}

这个方法就是上面所说的Spring将xml配置文件封装成Resourse,最终获取到Resourse的过程,就是找到ClassPathResource将xml路径放进去,然后调用loadBeanDefinitions(resources),再来看这个方法:

	@Overridepublic int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {return loadBeanDefinitions(new EncodedResource(resource));}

这个方法将Resource封装城了EncodedResource对象,这个对象有一个属性encoding,如果设置了xml文件的编码,在这里读取xml文件的时候会根据该编码进行读取,继续往下看:

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());}//获取前面加载到的xml配置资源文件Set currentResources = 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 {//之所以将路径都封装到Resource里面,就是使其提供一个统一的getInputStream方法//获取文件流对象,XmlBeanDefinitionReader无需关心xml文件怎么来的InputStream inputStream = encodedResource.getResource().getInputStream();try {InputSource inputSource = new InputSource(inputStream);if (encodedResource.getEncoding() != null) {inputSource.setEncoding(encodedResource.getEncoding());}//终于来到了最最核心的方法 解析文件流return doLoadBeanDefinitions(inputSource, encodedResource.getResource());}finally {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();}}}

spring的代码风格好像有一个特点,凡是真正开始做事的方法入口都会以do为前缀,经过前面一系列对xml配置文件的设置,终于来到了doLoadBeanDefinitions(inputSource, encodedResource.getResource()),在这个方法里Spring会读取每一个Element标签,并根据命名空间找到对应的NameSpaceHandler去读取解析Node生成BeanDefinition对象。经过一系列操作Resouse最终会被转换成InputSource对象,这个类也没什么特别的,只是除了文件流之外多了一些参数而已,比如XSD,DTD的publicId,systemId约束,文件流的编码等,最重要的还是InputStream,然后来看看这个方法:

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource) {//主要是校验文件 通过查找DTD文件约束 校验文件格式//读取xml文件生成DOCDocument doc = doLoadDocument(inputSource, resource);return registerBeanDefinitions(doc, resource);
}

这个方法完成两件事情:

  • 通过inputSource生成Document对象
  • 解析Document并将生成BeanDefinition注册到IOC中

解析DOC生成BeanDefinition

	public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();documentReader.setEnvironment(this.getEnvironment());//获取加载之前IOC容器中的BeanDefinition数量int countBefore = getRegistry().getBeanDefinitionCount();//具体解析 注册 documentReader.registerBeanDefinitions(doc, createReaderContext(resource));//返回本次加载的BeanDefinition数量return getRegistry().getBeanDefinitionCount() - countBefore;}

在这个方法里,首先创建BeanDefinitionDocumentReader,这是个接口用于完成BeanDefinition向IOC容器注册的功能,Spring只提供了唯一的实现DefaultBeanDefinitionDocumentReader,查看registerBeanDefinitions:

	@Overridepublic void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {this.readerContext = readerContext;logger.debug("Loading bean definitions");//root 在这个测试里就是Element root = doc.getDocumentElement();doRegisterBeanDefinitions(root);}

该方法第一步首先会去xml的根节点,在这个测试xml里就是标签了,然后将根节点作为参数传入到下面的方法中解析doRegisterBeanDefinitions:

	protected void doRegisterBeanDefinitions(Element root) {//获取profile环境变量String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);if (StringUtils.hasText(profileSpec)) {Assert.state(this.environment != null, "Environment must be set for evaluating profiles");String[] specifiedProfiles = StringUtils.tokenizeToStringArray(profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);//判断该root下的bean是否是前面通过web.xml或者前面设置的bean的环境值//如果不是则不需要解析当前root标签if (!this.environment.acceptsProfiles(specifiedProfiles)) {return;}}BeanDefinitionParserDelegate parent = this.delegate;this.delegate = createDelegate(this.readerContext, root, parent);//解析bean所要执行的方法,该方法实际是空的 允许子类扩展 去读取自定义的node//属于模板方法preProcessXml(root);//真正解析beans的方法parseBeanDefinitions(root, this.delegate);//beans解析完之后需要执行的方法,实际也是通过子类扩展 是模板方法postProcessXml(root);this.delegate = parent;}

这个方法真正核心的只有两部分:

  • 读取beans的profile属性,判断是否属于被激活的组,如果不是则不解析
  • 创建BeanDefinitionParserDelegate,委托该类执行beans解析工作。

最后通过parseBeanDefinitions(root, this.delegate)方法将beans的解析交给BeanDefinitionParserDelegate

	protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {//判断是否是默认的命名空间 也就是beansif (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)) {//判断是否是xml配置的bean,如果是则调用该方法解析parseDefaultElement(ele, delegate);}else {//否则按照自定义方式解析delegate.parseCustomElement(ele);}}}}else {//否则按照自定义方式解析delegate.parseCustomElement(root);}}

这个方法很重要,这里已经开始解析了,首先会判断,要解析的root是否是beans标签,如果是再判断子元素是否是元素,正常来讲,使用spring的时候都会在标签下配置,所以一般都会走到for循环里,然后在for循环里判断是否是默认命名空间的时候就会发生变化:

  • 如果是则走parseDefaultElement(ele, delegate);
  • 如果是mvc:annotation-driven、 等则会走到自定义元素解析delegate.parseCustomElement(ele)里

自定义解析加载到最后还是会跟加载默认命名空间的bean一样,所以在这里只分析自定义命名空间的解析,不过值得提一下的是自定义解析方法里会首先根据Element的命名空间找到NamespaceHandler,然后由该NamespaceHanler去解析

	public BeanDefinition parseCustomElement(Element ele, BeanDefinition containingBd) {//获取元素的命名空间String namespaceUri = getNamespaceURI(ele);//获取命名空间解析器NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);if (handler == null) {error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);return null;}//解析自定义元素return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));}

接着看Spring解析,查看parseDefaultElement:

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {//解析 importimportBeanDefinitionResource(ele);}else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {//解析aliasprocessAliasRegistration(ele);}else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {//解析beanprocessBeanDefinition(ele, delegate);}else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {// 如果还是beans  递归调用doRegisterBeanDefinitions(ele);}}

这个方法里面就是几个if判断,用于解析对应的标签,其中import alias相当于是去读取另一个xml文件,最后还是会调用解析bean,所以在这里只看解析bean的方法processBeanDefinition(ele, delegate):

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {//将bean的属性都读取到到BeanDefinitionHolder上BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);if (bdHolder != null) {//如果bean里面有自定义标签 来决定是否再次解析bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);try {// 将生成的BeanDefinitionHolder注册到IOC中BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());}catch (BeanDefinitionStoreException ex) {getReaderContext().error("Failed to register bean definition with name '" +bdHolder.getBeanName() + "'", ele, ex);}// 发送注册事件getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));}}

在这个方法里 ,之前分析的逻辑才逐渐清晰起来,代码的条例也很清晰

  • BeanDefinitionParserDelegate将bean标签的属性读取到BeanDefinitionHolder对象中
  • 如果beans下还有其他自定义标签决定是否有必要再次解析
  • 将BeanDefinition注册到IOC中
  • 发送注册事件

首先来看第一步,读取node属性到BeanDefinitionParserDelegate中

	public AbstractBeanDefinition parseBeanDefinitionElement(Element ele, String beanName, BeanDefinition containingBean) {this.parseState.push(new BeanEntry(beanName));String className = null;if (ele.hasAttribute(CLASS_ATTRIBUTE)) {//获取class全限定名className = ele.getAttribute(CLASS_ATTRIBUTE).trim();}try {String parent = null;if (ele.hasAttribute(PARENT_ATTRIBUTE)) {parent = ele.getAttribute(PARENT_ATTRIBUTE);}//设置beanClass或者beanClassNameAbstractBeanDefinition bd = createBeanDefinition(className, parent);//读取node属性,将配置的属性塞入合适的字段中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);//解析属性(setter注入)parsePropertyElements(ele, bd);parseQualifierElements(ele, bd);bd.setResource(this.readerContext.getResource());bd.setSource(extractSource(ele));return bd;}finally {this.parseState.pop();}return null;}

这个方法完成了读取一个bean包括将node属性读入到BeanDefinition,读取bean的构造函数配置(是构造器注入的前提),读取bean的属性配置(是setter注入的前提),其实将node属性读取到BeanDefinition很简单,仅仅是一一对应而已,真正的复杂点在于读取构造函数参数、读取属性值参数

构造器和属性参数解析

    

property属性解析(setter注入)

setter注入即属性赋值,如果属性值都是string类型的还很好解决,如果pojo类的属性值不是String,而是比如像Boolean、int、Date等这些数据的时候,必须要进行数据转换操作才可以在getBean()的时候将property配置的属性通过反射注入到对应的字段里,但是如果是ref引用类型呢,这个问题该如何解决呢?Spring很巧妙的解决了这个问题,用RuntimeBeanReference来表示ref引用的数据,用TypedStringValue表示普通String字符串。既然一个pojo类的所有配置都会读取到BeanDefinition,所以在xml中配置的属性必然也会存储到BeanDefinition中,继续看源码会发现BeanDefinition中用MutablePropertyValues类表示属性集合,该类中propertyValueList就是property集合数据,Spring用PropertyValue存储了property的name value信息。

//在BeanDefinition类中
MutablePropertyValues getPropertyValues();//在MutablePropertyValues类中的属性
private final List propertyValueList;//在PropertyValue中的属性
private final String name;
private final Object value;

根据上面xml配置可知value可能需要类型转换,也可能是引用ref,鉴于getBean阶段无法直接赋值,所以需要一个中间类保存数据,在getBean()反射阶段根据类型去转换成对象,再次查看parsePropertyElements方法:

public void parsePropertyElements(Element beanEle, BeanDefinition bd) {NodeList nl = beanEle.getChildNodes();for (int i = 0; i < nl.getLength(); i++) {Node node = nl.item(i);//解析bean下的property属性节点if (isCandidateElement(node) && nodeNameEquals(node, PROPERTY_ELEMENT)) {parsePropertyElement((Element) node, bd);}}
}

parsePropertyElement解析bean下的property属性节点:

public void parsePropertyElement(Element ele, BeanDefinition bd) {//获取property的name  这个很简单String propertyName = ele.getAttribute(NAME_ATTRIBUTE);if (!StringUtils.hasLength(propertyName)) {error("Tag 'property' must have a 'name' attribute", ele);return;}this.parseState.push(new PropertyEntry(propertyName));try {if (bd.getPropertyValues().contains(propertyName)) {error("Multiple 'property' definitions for property '" + propertyName + "'", ele);return;}//获取获取property的value 这个需要用中间类表示Object val = parsePropertyValue(ele, bd, propertyName);PropertyValue pv = new PropertyValue(propertyName, val);parseMetaElements(ele, pv);pv.setSource(extractSource(ele));bd.getPropertyValues().addPropertyValue(pv);}finally {this.parseState.pop();}}

下面方法即是实现过程:

	public Object parsePropertyValue(Element ele, BeanDefinition bd, String propertyName) {String elementName = (propertyName != null) ?" element for property '" + propertyName + "'" :" element";// Should only have one child element: ref, value, list, etc.NodeList nl = ele.getChildNodes();Element subElement = null;for (int i = 0; i < nl.getLength(); i++) {Node node = nl.item(i);if (node instanceof Element && !nodeNameEquals(node, DESCRIPTION_ELEMENT) &&!nodeNameEquals(node, META_ELEMENT)) {// Child element is what we're looking for.if (subElement != null) {error(elementName + " must not contain more than one sub-element", ele);}else {subElement = (Element) node;}}}//是否有ref属性boolean hasRefAttribute = ele.hasAttribute(REF_ATTRIBUTE);//是否有value属性boolean hasValueAttribute = ele.hasAttribute(VALUE_ATTRIBUTE);//ref和value只能存在一个if ((hasRefAttribute && hasValueAttribute) ||((hasRefAttribute || hasValueAttribute) && subElement != null)) {error(elementName +" is only allowed to contain either 'ref' attribute OR 'value' attribute OR sub-element", ele);}if (hasRefAttribute) {String refName = ele.getAttribute(REF_ATTRIBUTE);if (!StringUtils.hasText(refName)) {error(elementName + " contains empty 'ref' attribute", ele);}//如果是ref 则转换成RuntimeBeanReferenceRuntimeBeanReference ref = new RuntimeBeanReference(refName);ref.setSource(extractSource(ele));return ref;}else if (hasValueAttribute) {//如果是String则转换成TypedStringValueTypedStringValue valueHolder = new TypedStringValue(ele.getAttribute(VALUE_ATTRIBUTE));valueHolder.setSource(extractSource(ele));return valueHolder;}else if (subElement != null) {return parsePropertySubElement(subElement, bd);}else {// Neither child element nor "ref" or "value" attribute found.error(elementName + " must specify a ref or value", ele);return null;}}

setter注入的第一阶段BeanDefinition保存属性数据的方式,在调用BeanFactory的getBean()方法时,在反射阶段获取到值对象时可以根据类型去获取值,如果是TypedStringValue则只需校验值是否应该转换,如果需要转换即可,至于如何转换,如果是RuntimeBeanReference,直接通过getBean()获取就好了,记住这两个类型,在分析getBean()阶段属性值解析的时候就会用到他们。

构造函数constructor-arg解析(构造函数注入)

构造器注入其实比setter注入要稍微麻烦一点,因为构造器可能会有很多重载,在xml配置中如果参数顺序不同可能会调用不同的构造函数,导致注入失败,所以如果要保证构造参数值必须匹配到唯一合适的构造函数,并且在xml配置的constructor-arg必须按照一定规则与匹配的构造函数一一对应,才可以在getBean()阶段注入成功。
spring允许在xml中通过index、name、type来指定一个参数,在BeanDefinition中使用ConstructorArgumentValues存储构造函数参数集合,在ConstructorArgumentValues包含了两个集合一个配置了索引的indexedArgumentValues参数集合,另一个没有配置索引的enericArgumentValues构造函数参数集合,然后构造函数参数值用内部类ValueHolder表示,这个类里包含了参数的value,类型,参数名等。

//在BeanDefinition类中    
ConstructorArgumentValues getConstructorArgumentValues();//在ConstructorArgumentValues类中
//使用了索引的构造函数参数值集合
private final Map indexedArgumentValues = new LinkedHashMap(0);  
//未使用索引的构造函数参数值集合
private final List genericArgumentValues = new LinkedList();//在ValueHolder中的属性
private Object value;
private String type;
private String name;
private Object source;

构造函数参数的存储结构分析完了,这里只看关键的代码:

	public void parseConstructorArgElements(Element beanEle, BeanDefinition bd) {NodeList nl = beanEle.getChildNodes();for (int i = 0; i < nl.getLength(); i++) {Node node = nl.item(i);if (isCandidateElement(node) && nodeNameEquals(node, CONSTRUCTOR_ARG_ELEMENT)) {parseConstructorArgElement((Element) node, bd);}}}

解析constructor-arg标签parseConstructorArgElement:

public void parseConstructorArgElement(Element ele, BeanDefinition bd) {//获取indexString indexAttr = ele.getAttribute(INDEX_ATTRIBUTE);//获取typeString typeAttr = ele.getAttribute(TYPE_ATTRIBUTE);//获取nameString nameAttr = ele.getAttribute(NAME_ATTRIBUTE);//如果index不为空 保存到indexedArgumentValues集合中if (StringUtils.hasLength(indexAttr)) {try {int index = Integer.parseInt(indexAttr);if (index < 0) {error("'index' cannot be lower than 0", ele);}else {try {this.parseState.push(new ConstructorArgumentEntry(index));//将value转换成RuntimeBeanReference或者TypedStringValueObject value = parsePropertyValue(ele, bd, null);ConstructorArgumentValues.ValueHolder valueHolder = new ConstructorArgumentValues.ValueHolder(value);//保存typeif (StringUtils.hasLength(typeAttr)) {valueHolder.setType(typeAttr);}//保存nameif (StringUtils.hasLength(nameAttr)) {valueHolder.setName(nameAttr);}valueHolder.setSource(extractSource(ele));if (bd.getConstructorArgumentValues().hasIndexedArgumentValue(index)) {error("Ambiguous constructor-arg entries for index " + index, ele);}else {//保存构造函数参数值bd.getConstructorArgumentValues().addIndexedArgumentValue(index, valueHolder);}}finally {this.parseState.pop();}}}catch (NumberFormatException ex) {error("Attribute 'index' of tag 'constructor-arg' must be an integer", ele);}}//index未配置 保存到普通集合中genericArgumentValueselse {try {this.parseState.push(new ConstructorArgumentEntry());Object value = parsePropertyValue(ele, bd, null);ConstructorArgumentValues.ValueHolder valueHolder = new ConstructorArgumentValues.ValueHolder(value);if (StringUtils.hasLength(typeAttr)) {valueHolder.setType(typeAttr);}if (StringUtils.hasLength(nameAttr)) {valueHolder.setName(nameAttr);}valueHolder.setSource(extractSource(ele));//保存构造函数参数值bd.getConstructorArgumentValues().addGenericArgumentValue(valueHolder);}finally {this.parseState.pop();}}}

至此,一个xml配置的bean被完全存放到了BeanDefinition中,其实基于扫描注解配置也是一样的,只不过在做很多清理工作,针对下面配置简要说明下基于注解的处理:

 
  • 首先spring读取到这个node,会查找该node的NameSpaceHandler,然后调用parse方法解析
  • 然后读取到属性base-package,转换成对应路径后查找该路径下所有的class文件
  • 读取class文件的注解,查看是否实现了特定注解,如果实现了注解则处里方式与xml配置的处理相同,否则不处理。

真实的处理过程比较复杂,无论是用过注解还是通过xml,最终的处理方式都是一样的,都是先生成一个BeanDefinition注册到IOC中,然后通过getBean()获取。

BeanDefinitionRegistry注册

BeanDefinition创建完成了,还差最后一步,将生成的BeanDefinition注册到IOC中,这就必须往回看了。

protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {//将bean的属性都读取到到BeanDefinitionHolder上BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);if (bdHolder != null) {//如果bean里面有自定义标签 来决定是否再次解析bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);try {// 将生成的BeanDefinitionHolder注册到IOC中BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());}catch (BeanDefinitionStoreException ex) {getReaderContext().error("Failed to register bean definition with name '" +bdHolder.getBeanName() + "'", ele, ex);}// 发送注册事件getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));}}

这次看最后一步registerBeanDefinition:

public static void registerBeanDefinition(BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)throws BeanDefinitionStoreException {// 获取beanNameString beanName = definitionHolder.getBeanName();//注册BeanDefinition,key为beanName,value是BeanDefinitionregistry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());// 如果配置别名的话获取别名String[] aliases = definitionHolder.getAliases();if (aliases != null) {for (String aliase : aliases) {//注册别名registry.registerAlias(beanName, aliase);}}}

该方法完成了以下事情

  • 将BeanDefinition用beanName作为key注册到IOC容器中
  • 如果配置了别名,将beanName与别名映射起来。

再来看具体的注册过程registry.registerBeanDefinition,注册是调用BeanDefinitionRegistry的registerBeanDefinition方法,在上面分析说过DefaultListableBeanFactory实现了BeanDefinitionRegistry和BeanFactory,而且实现了具体逻辑,下面的内容就是Spring注册的过程,为了清晰省去中间非核心代码:

@Overridepublic void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
{if (beanDefinition instanceof AbstractBeanDefinition) {try {//验证((AbstractBeanDefinition) beanDefinition).validate();}catch (BeanDefinitionValidationException ex) {}}//这里保证了线程安全synchronized (this.beanDefinitionMap) {BeanDefinition oldBeanDefinition = this.beanDefinitionMap.get(beanName);if (oldBeanDefinition != null) {if (!this.allowBeanDefinitionOverriding) {//不允许覆盖抛出异常}else if (oldBeanDefinition.getRole() < beanDefinition.getRole()) {if (this.logger.isWarnEnabled()) {}else {if (this.logger.isInfoEnabled()) {}}}else {this.beanDefinitionNames.add(beanName);this.frozenBeanDefinitionNames = null;}//注册进去喽this.beanDefinitionMap.put(beanName, beanDefinition);}resetBeanDefinition(beanName);}

至此IOC容器的第一步为bean生成BeanDefinition并注册到IOC容器中完成。

相关内容

热门资讯

中央广电总台副台长王晓真,黑龙... 据央视新闻报道,12月28日,中央广播电视总台《2026年春节联欢晚会》分会场发布。黑龙江哈尔滨、浙...
聚焦全国财政工作会议丨明年财政... (央视财经《经济信息联播》)明年是“十五五”规划的开局之年,财政政策将聚焦哪些关键领域精准发力? ...
原创 中... 12月26日,中国对美国实施了一次重磅反制,针对美国政府前不久批准的111亿美元对台军售,中方决定出...
徐杰11分王少杰遭驱逐 张宁缺... [搜狐体育战报]北京时间12月28日消息,2025-26赛季CBA常规赛继续第7轮角逐。王少杰第三节...
《今日说法》主持人李晓东买茶叶... 12月28日,《今日说法》栏目主持人李晓东发布视频称,此前“被骗1000元买茶叶”事件迎来新进展:该...
3-0领先终于能休息了!莫德里... 在意甲第17轮的一场焦点战中,AC米兰迎战维罗纳。比赛进行到第70分钟时,AC米兰在3-0领先的情况...
原创 数... 星链卫星接连失控坠落背后,美国太空霸权现裂痕?反观中国,悄然布下反超棋局,六战六捷消息一出,美国立马...
“墨色无变化”,故宫出借米芾《... 12月28日,江西省博物馆发布声明回应近日文学爱好者的质疑: 近日,有观众质疑我馆“山谷雅集——黄庭...
原创 彻... 近期,中日关系因为日本首相高市早苗的错误涉台言论,跌到了谷底。然而在多重施压下,高市早苗仍然拒绝撤回...