Spring学习(四)-Bean的定义,解析,注册（BeanDefinition）

偏执的太偏执、 2024-02-19 15:57 13阅读 0赞

**Bean:**其在spring是主角。所有的事件都是围绕这他进行的。

**Bean 在 Spring 中作用就像 Object 对面向对象的意义一样，没有对象的概念就像没有面向对象编程，Spring 中没有 Bean 也就没有 Spring 存在的意义。**

Spring Bean 的创建时典型的工厂模式，他的顶级接口是 BeanFactory。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70][]

public interface BeanFactory {
    
    	String FACTORY_BEAN_PREFIX = "&";
    
    	//通过名称获取对象
    	Object getBean(String name) throws BeansException;
    
    	//通过名称与类型获取对象
    	<T> T getBean(String name, Class<T> requiredType) throws BeansException;
    
    	Object getBean(String name, Object... args) throws BeansException;
    
    	//通过类型获取对象
    	<T> T getBean(Class<T> requiredType) throws BeansException;
    
    	<T> T getBean(Class<T> requiredType, Object... args) throws BeansException;
    
        //判断容器中是否存在该对象
    	
    	boolean containsBean(String name);
    
    	//判断是否是单实例
    	boolean isSingleton(String name) throws NoSuchBeanDefinitionException;
    
    	//判断是否是多实例
    	boolean isPrototype(String name) throws NoSuchBeanDefinitionException;
    
    	//判断类型是否匹配
    	boolean isTypeMatch(String name, ResolvableType typeToMatch) throws NoSuchBeanDefinitionException;
    
    	boolean isTypeMatch(String name, Class<?> typeToMatch) throws NoSuchBeanDefinitionException;
    
    	//通过名称获取class类型
    	Class<?> getType(String name) throws NoSuchBeanDefinitionException;
    
    	//通过名称获取
    	String[] getAliases(String name);
    
    }

BeanFactory有三个是子类：AutowireCapableBeanFactory，HierarchicalBeanFactory，ListableBeanFactory。最终的默认实现类是 DefaultListableBeanFactory。

Bean 的定义主要有 BeanDefinition 描述.

public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement {
    
    	
    	String SCOPE_SINGLETON = ConfigurableBeanFactory.SCOPE_SINGLETON;
    
    	
    	String SCOPE_PROTOTYPE = ConfigurableBeanFactory.SCOPE_PROTOTYPE;
    
    	
    	。。。。。。。。。。。。
    
    	
    	String getScope();
        。。。。。。。。。。。。。。。。
    	
    	BeanDefinition getOriginatingBeanDefinition();
    
    }

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 1][]

Beans的定义实例上就是读取配置文件xml中<bean/> 节点中所有的信息或者通过相关注解获取bean相关数据，包括各种子节点。当 Spring 成功解析你定义的一个 <bean/> 节点后，在 Spring 的内部他就被转化成 BeanDefinition 对象。以后所有的操作都是对这个对象完成的。

BeanDefition创建加载时机：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 2][]

![20190114224914905.png][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 3][]

Beans的解析：AbstractBeanDefinitionReader的loadBeanDefinitions(String location,Set<Resouce> actualResouces)方法完成定位，紧接着调用loadBeanDefinitions()方法：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 4][]

三个子类：

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 5][]

如： 通过xml文件定义的bean，所以调用的是XmlBeanDefinitionReader的loadBeanDefinitions方法。

该方法通过入参encodedResource.getResource()获取到inputStream，最后调用了doLoadBeanDefinitions()方法。

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
    			throws BeanDefinitionStoreException {
    		try {
    			Document doc = doLoadDocument(inputSource, resource);
    			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);
    		}
    	}

最终，xml中的数据都放到了Document对象中。

获得Document以后调用XmlBeanDefinitionReader的registerBeanDefinitions（Document doc,Resouce resouce）方法：

protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
                //解析
    			Document doc = doLoadDocument(inputSource, resource);
                //注册
    			return registerBeanDefinitions(doc, resource);
    		}

public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
            //创建对象
            BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
            documentReader.setEnvironment(getEnvironment());
            //获取BeanDefinition的registry对象，DefaultListableBeanFactory，初始化XmlBeanDefinitionReader时进行的设置
            int countBefore = getRegistry().getBeanDefinitionCount();
            documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
            return getRegistry().getBeanDefinitionCount() - countBefore;
        }

方法里创建了BeanDefinitionDocumentReader,解析、注册BeanDefinition的工作又委托给了它。

public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
           //BeanDefinition读取过程中传递的上下文，封装相关的的配置和状态
    		this.readerContext = readerContext;
    		logger.debug("Loading bean definitions");
    		Element root = doc.getDocumentElement();
    		doRegisterBeanDefinitions(root);
    	}

此处需要注意第二次参数：XmlReaderContext

/**
     * Extension of {@link org.springframework.beans.factory.parsing.ReaderContext},
     * specific to use with an {@link XmlBeanDefinitionReader}. Provides access to the
     * {@link NamespaceHandlerResolver} configured in the {@link XmlBeanDefinitionReader}.
     *
     * @author Rob Harrop
     * @author Juergen Hoeller
     * @since 2.0
     */
    public class XmlReaderContext extends ReaderContext {
    
        private final XmlBeanDefinitionReader reader;//注册BeanDefinition用实际上就是DefaultListableBeanFacotry
    
        private final NamespaceHandlerResolver namespaceHandlerResolver;//根据xml文件命名空间，查找对应的Handler去解析属性(除了固定的属性的自定义属性)
    　　//省略......................

查看NamespaceHandlerResolver实现类：DefaultNamespaceHandlerResolver会发现该类读取的是classpath下所有的"META-INF/spring.handlers"文件，并存放在handlerMappings（Map）中，在后续的解析xml自定义属性时会根据命名空间在handlerMappings中查找NamespaceHandler去解析自定义的属性。

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 6][]

比如上几天学习过的dubbo，有一个DubboNamespaceHandler类。为了注册dubbo相关的类，需要解析其自定义属性。

DubboBeanDefinitionParser是用来解析自定义属性的，它需要实现BeanDefinitionParser接口：

/**
     * DubboNamespaceHandler
     *
     * @export
     */
    public class DubboNamespaceHandler extends NamespaceHandlerSupport {
    
        static {
            Version.checkDuplicate(DubboNamespaceHandler.class);
        }
    
        @Override
        public void init() {
            registerBeanDefinitionParser("application", new DubboBeanDefinitionParser(ApplicationConfig.class, true));
            registerBeanDefinitionParser("module", new DubboBeanDefinitionParser(ModuleConfig.class, true));
            registerBeanDefinitionParser("registry", new DubboBeanDefinitionParser(RegistryConfig.class, true));
            registerBeanDefinitionParser("monitor", new DubboBeanDefinitionParser(MonitorConfig.class, true));
            registerBeanDefinitionParser("provider", new DubboBeanDefinitionParser(ProviderConfig.class, true));
            registerBeanDefinitionParser("consumer", new DubboBeanDefinitionParser(ConsumerConfig.class, true));
            registerBeanDefinitionParser("protocol", new DubboBeanDefinitionParser(ProtocolConfig.class, true));
            registerBeanDefinitionParser("service", new DubboBeanDefinitionParser(ServiceBean.class, true));
            registerBeanDefinitionParser("reference", new DubboBeanDefinitionParser(ReferenceBean.class, false));
            registerBeanDefinitionParser("annotation", new AnnotationBeanDefinitionParser());
        }
    
    }

![20190114143403222.png][]

拿到上下文，然后经Document转换成Element对象，进行具体解析，其工作是由BeanDefinitionParserDelegate 完成。解析后的BeanDefinition被封装为BeanDefinitionHolder返回。接下来就是就是BeanDefinition的注册

Beans的注册**:**

private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
              //import
    		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
    			importBeanDefinitionResource(ele);
    		}
    		//alias
    		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
    			processAliasRegistration(ele);
    		}
    		//bean
    		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
    		
    		    //注册 将BeanDefinition注册到DefaultListableBeanFacotry
    			processBeanDefinition(ele, delegate);
    		}
    		//beans
    		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
    			// recurse
    			doRegisterBeanDefinitions(ele);
    		}
    	}

调用BeanDefinitionReaderUtils.registerBeanDefinition方法进行BeanDefinition的注册，其中入参registry其实就是BeanFactory：DefaultListableBeanFacotry，它本身实现了BeanDefinitionRegistry接口.

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());
    
    		// Register aliases for bean name, if any.
    		String[] aliases = definitionHolder.getAliases();
    		if (aliases != null) {
    			for (String alias : aliases) {
    				registry.registerAlias(beanName, alias);
    			}
    		}
    	}

至此：将一个bean注册就完成了。

核心：BeanDefinitionReaderUtils.registerBeanDefinition

总结：

1.AbstractApplicationContext 的refresh()定义容器初始化的整个流程。
    
    2.由AbstractApplicationContext的子类AbstractRefreshableApplicationContext来完成容器的刷新工作，由它来创建了新的容器，DefaultListableBeanFactory。
    
    3.BeanDefinition资源不同(XML、注解等)，需要由不同的子类去继承AbstractRefreshableApplicationContext进行资源的定位,例如AbstractXmlApplicationContext。
    
    4.AbstractXmlApplicationContext自己本身不会去定位解析BeanDefinition，它创建了BeanDefinitionReader，委托的它来完成定位、加载工作。
    
    5.BeanDefinitionReader完成定位、加载工作。也就是先获取Resource，通过Resource获取InputStream，根据InputStream获取Document。然后创建了BeanDefinitionDocumentReader。
    
    6.BeanDefinitionDocumentReader最后完成xml的解析工作获得BeanDefinitionHolder。
    
    7.最后BeanDefinitionDocumentReader委托DefaultListableBeanFactory完成注册。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/5df1921d2c64476f918f5ac1116a88ba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/e3f4c2de7656470e8ac845b595f0ff23.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/7b9d89e882704ad1b28a58982308ed9a.png
[20190114224914905.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/3652264ccd3c4205a2008b69dd0a3c2f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/283b2333973b43d5b3ab63030e3235b2.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/8dc55cd0eadc45069baa181df798fbba.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/55c7e473f6724dc8a10462f00e1f2dad.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzU0OTU3OA_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/bc08a881185e4151a29280774cbb5656.png
[20190114143403222.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/01/29/e2da115a35d445308f6cc18945406fcf.png