Spring源码二:Spring 初始化机制

文章目录


Spring 初始化机制

Spring 容器的初始化流程初探

Spring容器初始化的核心方法 refresh(),下面主要分析 obtainFreshBeanFactory() 方法流程,也就是BeanFactory 的创建过程的主要流程。

Spring 初始化核心流程

Spring容器初始化的核心方法是AbstractApplicationContext#refresh()
├─ refresh // Spring 初始化核心流程入口
│ ├─ prepareRefresh // 准备此上下文用于刷新,设置启动时间和active标志,初始化属性
│ ├─ obtainFreshBeanFactory // 创建 BeanFactory 本节主要跟踪的源码流程
│ ├─ prepareBeanFactory // 设置beanFactory的基本属性
│ ├─ postProcessBeanFactory // 子类处理自定义的BeanFactoryPostProcess
│ ├─ invokeBeanFactoryPostProcessors // 调用所有的BeanFactoryPostProcessor
│ ├─ registerBeanPostProcessors // 注册,把实现了BeanPostProcessor接口的类实例化,加到BeanFactory
│ ├─ initMessageSource // 初始化上下文中的资源文件,如国际化文件的处理等
│ ├─ initApplicationEventMulticaster // 初始化上下文的事件传播器
│ ├─ onRefresh // 给子类扩展初始化其他Bean,springboot 中用来做内嵌 tomcat 启动
│ ├─ registerListeners // 在所有bean中查找监听 bean,然后注册到广播器中
│ ├─ finishBeanFactoryInitialization // 初始化所有的单例Bean、ioc、BeanPostProcessor的执行、Aop入口
│ └─ finishRefresh // 完成刷新过程,发布相应的事件

├─ testSpringStart()

	@Test
	public void testSpringStart() {
	    ApplicationContext wApplicationContext = new ClassPathXmlApplicationContext("spring.xml");
	}

├─ ClassPathXmlApplicationContext()

调用 ClassPathXmlApplicationContext 的构造方法,实例化ClassPathXmlApplicationContext上下文

类文件:org.springframework.context.support. ClassPathXmlApplicationContext

	public ClassPathXmlApplicationContext(String configLocation) throws BeansException {
			this(new String[] {configLocation}, true, null);
	}

实际调用了ClassPathXmlApplicationContext()的重载方法

类文件:org.springframework.context.support. ClassPathXmlApplicationContext

	public ClassPathXmlApplicationContext(
			String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
			throws BeansException {
		// 实例化的时候,调用父类的构造函数
		super(parent);
		// 将配置文件名存到AbstractRefreshableConfigApplicationContext的configLocations属性中,
		// AbstractXmlApplicationContext的loadBeanDefinitions方法中会取出
		setConfigLocations(configLocations);
		if (refresh) {
			refresh();
		}
	}

├─ refresh()

进入 refresh() 方法

类文件:org.springframework.context.support. AbstractApplicationContext

   /**
	 * 该方法是spring容器初始化的核心方法。是Spring初始化的核心流程
	 * 根据不同的上下文,会掉到不同的上下文对象的子类
	 *
	 * 核心的上下文子类:
	 * ClassPathXmlApplicationContext
	 * FileSystemXmlApplicationContext
	 * AnnotationConfigApplicationContext
	 *
	 * @throws BeansException
	 * @throws IllegalStateException
	 */
	@Override
	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
			// 为上下文容器初始化做准备
			prepareRefresh();

			/**
			 *	1、建BeanFactory对象
			 *	2、xml解析
			 *		传统的标签解析: alias import bean beans
			 * 		自定义标签解析:<context:componet-scan base-package=""/>
			 * 		自定义标签的解析流程:
			 * 	    a、根据当前解析标签的头信息找到对应的namespaceUri
			 * 	    b、加载spring所有jar中的spring.handles文件,建立联系
			 * 	    c、根据namespaceUri从映射关系中找出对应实现了NamespaceHandler的接口
			 * 	    d、调用类的init方法, init方法注册了各种自定义标签的解析类
			 * 	    e、根据namespaceUri找到对应的解析类,然后调用paser方法完成标签解析
			 * 3、把解析出来的xml标签封装成BeanDefinition对象
			 */
			// Tell the subclass to refresh the internal bean factory.
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

			// 给beanFactory设置一些属性值,可以不看
			// Prepare the bean factory for use in this context.
			prepareBeanFactory(beanFactory);

			try {
				// Allows post-processing of the bean factory in context subclasses.
				postProcessBeanFactory(beanFactory);

				// BeanDefinitionRegistryPostProcessor
				// BeanFactoryPostProcessor
				// 完成对实现以上两个接口类的调用
				// 激活各种 BeanFactory 处理器
				// Invoke factory processors registered as beans in the context.
				invokeBeanFactoryPostProcessors(beanFactory);

				// 把实现BeanPostProcessor接口实例化, 并加入BeanFactory中
				// 例如ComponentScanBeanDefinitionParser中registerComponents方法注册的
				// CommonAnnotationBeanPostProcessor 、AutowiredAnnotationBeanPostProcessor 等等
				// Register bean processors that intercept bean creation.
				registerBeanPostProcessors(beanFactory);

				// 初始化消息源   例如: 国际化
				// Initialize message source for this context.
				initMessageSource();

				// 初始化上下文事件广播器(事件广播和监听机制是典型的观察者模式的实现)
				// Initialize event multicaster for this context.
				initApplicationEventMulticaster();

				// 钩子方法 (模板设计模式), 在SpringBoot中,应用于tomcat启动
				// Initialize other special beans in specific context subclasses.
				onRefresh();

				// 注册监听事件
				// Check for listener beans and register them.
				registerListeners();

				// BeanDefination的实例化、ioc依赖注入、aop动态代理等等
				// Instantiate all remaining (non-lazy-init) singletons.
				finishBeanFactoryInitialization(beanFactory);
				
				// 完成刷新过程,通知生命周期处理器 lifecycleProcessor 刷新过程,同时发出
				// Last step: publish corresponding event.
				finishRefresh();
			}

├─ obtainFreshBeanFactory()

进入 obtainFreshBeanFactory()方法

类文件:org.springframework.context.support. AbstractApplicationContext

	protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
		// 模板设计模式 以下两个方法都是钩子方法
		// 获得Bean工厂
		refreshBeanFactory();
		return getBeanFactory();
	}

│ ├─ refreshBeanFactory()

进入子类的 refreshBeanFactory()方法

类文件:org.springframework.context.support. AbstractRefreshableApplicationContext

	@Override
	protected final void refreshBeanFactory() throws BeansException {
		// 如果存在beanFactory, 则清除BeanFactory和里面的实例
		if (hasBeanFactory()) {
			destroyBeans();
			closeBeanFactory();
		}
		try {
			// 创建一个beanFactory的对象
			DefaultListableBeanFactory beanFactory = createBeanFactory();
			// 设置 beanFactory的唯一标识
			beanFactory.setSerializationId(getId());
			// 是否允许使用相同名称重新注册不同的bean实现,默认允许。
			// 设置是否可以循环依赖 allowCircularReferences,默认允许。
			customizeBeanFactory(beanFactory);
			// 解析xml,并把xml中的标签封装成BeanDefinition对象 (模板设计模式)
			loadBeanDefinitions(beanFactory);
			this.beanFactory = beanFactory;
		}
		catch (IOException ex) {
			throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
		}
	}

│ ├─ loadBeanDefinitions()

进入 loadBeanDefinitions()方法

类文件:org.springframework.context.support.AbstractXmlApplicationContext

	@Override
	protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
		// Create a new XmlBeanDefinitionReader for the given BeanFactory.
		// 创建一个XmlBeanDefinitionReader, xml解析器。 (委托设计模式)
		XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);

		// Configure the bean definition reader with this context's
		// resource loading environment.
		beanDefinitionReader.setEnvironment(this.getEnvironment());
		// 这里this, 是因为当前类继承了DefaultResourceLoader
		beanDefinitionReader.setResourceLoader(this);
		beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));

		// Allow a subclass to provide custom initialization of the reader,
		// then proceed with actually loading the bean definitions.
		initBeanDefinitionReader(beanDefinitionReader);
		// 加载beanDefination
		loadBeanDefinitions(beanDefinitionReader);
	}

进入 loadBeanDefinitions()的重载方法

类文件:org.springframework.context.support.AbstractXmlApplicationContext

	protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
		Resource[] configResources = getConfigResources();
		if (configResources != null) {
			reader.loadBeanDefinitions(configResources);
		}
		// 取出spring.xml文件名 (目前只有该一个配置文件)
		String[] configLocations = getConfigLocations();
		if (configLocations != null) {
			// 委托给XmlBeanDefinitionReader来进行解析 (委托设计模式)
			reader.loadBeanDefinitions(configLocations);
		}
	}

进入 loadBeanDefinitions()的重载方法

类文件:org.springframework.context.support.AbstractBeanDefinitionReader

	public int loadBeanDefinitions(String location, @Nullable Set<Resource> actualResources) throws BeanDefinitionStoreException {
		// 获取上下文对象 就是刚刚通过this赋值的AbstractXmlApplicationContext
		ResourceLoader resourceLoader = getResourceLoader();
		if (resourceLoader == null) {
			throw new BeanDefinitionStoreException(
					"Cannot load bean definitions from location [" + location + "]: no ResourceLoader available");
		}

		// ApplicationContext继承了ResourcePatternResolver(资源解析器),
		// 而所有 XXXApplicationContext都继承了ApplicationContext
		if (resourceLoader instanceof ResourcePatternResolver) {
			// Resource pattern matching available.
			try {
				// 根据文件名 从classpath*: XXX  下获取对应的配置文件 形如:classpath*:user/**/*-context.xml,
				// 再通过流的方式加载配置文件,然后封装到Resource(继承了InputStreamSource)对象中
				Resource[] resources = ((ResourcePatternResolver) resourceLoader).getResources(location);

				// 更具resources加载BeanDefinition  (必看)
				int count = loadBeanDefinitions(resources);
				if (actualResources != null) {
					Collections.addAll(actualResources, resources);
				}
				if (logger.isTraceEnabled()) {
					logger.trace("Loaded " + count + " bean definitions from location pattern [" + location + "]");
				}
				return count;
			}
			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 count = loadBeanDefinitions(resource);
			if (actualResources != null) {
				actualResources.add(resource);
			}
			if (logger.isTraceEnabled()) {
				logger.trace("Loaded " + count + " bean definitions from location [" + location + "]");
			}
			return count;
		}
	}

进入 loadBeanDefinitions()的重载方法

类文件:org.springframework.context.support.AbstractBeanDefinitionReader

	@Override
	public int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException {
		Assert.notNull(resources, "Resource array must not be null");
		int count = 0;
		for (Resource resource : resources) {
			// 调用子类的loadBeanDefinitions方法, 这里主要指XmlBeanDefinitionReader(模板设计模式)
			count += loadBeanDefinitions(resource);
		}
		return count;
	}

进入 loadBeanDefinitions()方法

类文件:org.springframework.beans.factory.xml.XmlBeanDefinitionReader

	public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
		Assert.notNull(encodedResource, "EncodedResource must not be null");
		if (logger.isTraceEnabled()) {
			logger.trace("Loading XML bean definitions from " + encodedResource);
		}

		Set<EncodedResource> currentResources = this.resourcesCurrentlyBeingLoaded.get();

		if (!currentResources.add(encodedResource)) {
			throw new BeanDefinitionStoreException(
					"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
		}

		// 获取Resource中配置文件的输入流
		try (InputStream inputStream = encodedResource.getResource().getInputStream()) {
			// 把文件流对象包装成 InputSource
			// 注:InputSource是jdk包org.xml.sax中负责XML文档解析
			InputSource inputSource = new InputSource(inputStream);
			if (encodedResource.getEncoding() != null) {
				inputSource.setEncoding(encodedResource.getEncoding());
			}
			// 加载BeanDefinition
			return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
		}
		catch (IOException ex) {
			throw new BeanDefinitionStoreException(
					"IOException parsing XML document from " + encodedResource.getResource(), ex);
		}
		finally {
			currentResources.remove(encodedResource);
			if (currentResources.isEmpty()) {
				this.resourcesCurrentlyBeingLoaded.remove();
			}
		}
	}

│ ├─ doLoadBeanDefinitions()

进入 doLoadBeanDefinitions()方法

org.springframework.beans.factory.xml.XmlBeanDefinitionReader

	protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
			throws BeanDefinitionStoreException {

		try {
			// 把inputSource 封装成了个Document文件对象,这是jdk的API
			Document doc = doLoadDocument(inputSource, resource);
			// 注册BeanDefinition  主要解析Document对象,获取其中的标签元素封装成BeanDefinition
			int count = registerBeanDefinitions(doc, resource);
			if (logger.isDebugEnabled()) {
				logger.debug("Loaded " + count + " bean definitions from " + resource);
			}
			return count;
		}
		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);
		}
	}

│ ├─ registerBeanDefinitions()

进入 registerBeanDefinitions()方法

类文件:org.springframework.beans.factory.xml.XmlBeanDefinitionReader

	public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
		// BeanDefinition解析器, (委托模式, 继承自DefaultBeanDefinitionDocumentReader)
		BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
		// 第一次启动个数为0
		int countBefore = getRegistry().getBeanDefinitionCount();
		// 注册BeanDefinitions
		// createReaderContext方法中加载了所有的NamespaceHandler
		documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
		return getRegistry().getBeanDefinitionCount() - countBefore;
	}

│ ├─ registerBeanDefinitions()

进入 registerBeanDefinitions()方法

类文件:org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader

	@Override
	public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
		this.readerContext = readerContext;
		// 获取根节点(beans标签), 传入方法
		doRegisterBeanDefinitions(doc.getDocumentElement());
	}

│ ├─ doRegisterBeanDefinitions()

进入 doRegisterBeanDefinitions()方法

类文件:org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader

	@SuppressWarnings("deprecation")  // for Environment.acceptsProfiles(String...)
	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);
		// xml中所有标签的解析流程
		parseBeanDefinitions(root, this.delegate);
		postProcessXml(root);

		this.delegate = parent;
	}

│ ├─ parseBeanDefinitions()

进入parseBeanDefinitions()方法

类文件:org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader

	protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
		// root是根节点, 判断里是否是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)) {
						// 默认标签解析
						parseDefaultElement(ele, delegate);
					}
					else {
						// 自定义标签解析
						delegate.parseCustomElement(ele);
					}
				}
			}
		}
		else {
			// 自定义标签解析
			delegate.parseCustomElement(root);
		}
	}

│ │ ├─ parseDefaultElement() 默认标签解析入口

进入 parseDefaultElement()方法,默认标签解析

类文件:org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader

	private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
		if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
			// import标签解析
			importBeanDefinitionResource(ele);
		}
		else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
			// alias标签解析 别名标签
			processAliasRegistration(ele);
		}
		else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
			// bean标签的解析 常用
			processBeanDefinition(ele, delegate);
		}
		else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
			// beans标签解析
			// recurse
			doRegisterBeanDefinitions(ele);
		}
	}

│ │ │ ├─ processBeanDefinition()

进入 processBeanDefinition()方法

类文件:org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader

	protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
		// 解析document   封装成BeanDefinition
		BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
		if (bdHolder != null) {
			// 添加属性(属性前缀)   SPI设计思想   (装饰者设计模式)
			// 例如: xmlns:p="http://www.springframework.org/schema/p"
			// 例如: xmlns:c="http://www.springframework.org/schema/c"
			bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
			try {
				// 注册BeanDefinition  , 就是把注册BeanDefinition放到BeanFactory的beanDefinitionMap属性中
				BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
			}
			catch (BeanDefinitionStoreException ex) {
				getReaderContext().error("Failed to register bean definition with name '" +
						bdHolder.getBeanName() + "'", ele, ex);
			}
			// Send registration event.
			getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
		}
	}

│ │ │ ├─ parseBeanDefinitionElement()

进入 parseBeanDefinitionElement()方法

类文件:org.springframework.beans.factory.xml.BeanDefinitionParserDelegate

	@Nullable
	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");
			}
		}
		// 检查 beanName 是否重复
		if (containingBean == null) {
			checkNameUniqueness(beanName, aliases, ele);
		}
		// 解析Element, 并封装成一个BeanDefinition对象
		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);
			// beanDefinition的再次封装
			return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
		}

		return null;
	}

进入 parseBeanDefinitionElement()方法

类文件:org.springframework.beans.factory.xml.DefaultBeanDefinitionDocumentReader

	@Nullable
	public AbstractBeanDefinition parseBeanDefinitionElement(
			Element ele, String beanName, @Nullable BeanDefinition containingBean) {

		this.parseState.push(new BeanEntry(beanName));

		String className = null;
		if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
			className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
		}
		String parent = null;
		if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
			parent = ele.getAttribute(PARENT_ATTRIBUTE);
		}

		try {
			// 创建一个GenericBeanDefinition 并把当前类名和父类名赋值进去
			AbstractBeanDefinition bd = createBeanDefinition(className, parent);
			// 解析bean标签的属性,并把解析出来的属性设置到BeanDefinition对象中  例: singleton、scope、abstract、lazy-init等
			parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
			bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
			// 解析bean中的meta标签
			parseMetaElements(ele, bd);
			// 解析bean中的lookup-method标签
			parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
			// 解析bean中的replaced-method标签
			parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
			// 解析bean中的constructor-arg标签
			parseConstructorArgElements(ele, bd);
			// 解析bean中的property标签
			parsePropertyElements(ele, bd);
			// 解析bean中的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;
	}

│ │ │ ├─ parseBeanDefinitionAttributes()

进入 parseBeanDefinitionAttributes()方法,最终的BeanDefinition属性在这里统一解析

类文件:org.springframework.beans.factory.xml.BeanDefinitionParserDelegate

	public AbstractBeanDefinition parseBeanDefinitionAttributes(Element ele, String beanName,
			@Nullable BeanDefinition containingBean, AbstractBeanDefinition bd) {

		if (ele.hasAttribute(SINGLETON_ATTRIBUTE)) {
			error("Old 1.x 'singleton' attribute in use - upgrade to 'scope' declaration", ele);
		}
		else if (ele.hasAttribute(SCOPE_ATTRIBUTE)) {
			bd.setScope(ele.getAttribute(SCOPE_ATTRIBUTE));
		}
		else if (containingBean != null) {
			// Take default from containing bean in case of an inner bean definition.
			bd.setScope(containingBean.getScope());
		}

		if (ele.hasAttribute(ABSTRACT_ATTRIBUTE)) {
			bd.setAbstract(TRUE_VALUE.equals(ele.getAttribute(ABSTRACT_ATTRIBUTE)));
		}

		String lazyInit = ele.getAttribute(LAZY_INIT_ATTRIBUTE);
		if (isDefaultValue(lazyInit)) {
			lazyInit = this.defaults.getLazyInit();
		}
		bd.setLazyInit(TRUE_VALUE.equals(lazyInit));

		String autowire = ele.getAttribute(AUTOWIRE_ATTRIBUTE);
		bd.setAutowireMode(getAutowireMode(autowire));

		if (ele.hasAttribute(DEPENDS_ON_ATTRIBUTE)) {
			String dependsOn = ele.getAttribute(DEPENDS_ON_ATTRIBUTE);
			bd.setDependsOn(StringUtils.tokenizeToStringArray(dependsOn, MULTI_VALUE_ATTRIBUTE_DELIMITERS));
		}

		String autowireCandidate = ele.getAttribute(AUTOWIRE_CANDIDATE_ATTRIBUTE);
		if (isDefaultValue(autowireCandidate)) {
			String candidatePattern = this.defaults.getAutowireCandidates();
			if (candidatePattern != null) {
				String[] patterns = StringUtils.commaDelimitedListToStringArray(candidatePattern);
				bd.setAutowireCandidate(PatternMatchUtils.simpleMatch(patterns, beanName));
			}
		}
		else {
			bd.setAutowireCandidate(TRUE_VALUE.equals(autowireCandidate));
		}

		if (ele.hasAttribute(PRIMARY_ATTRIBUTE)) {
			bd.setPrimary(TRUE_VALUE.equals(ele.getAttribute(PRIMARY_ATTRIBUTE)));
		}

		if (ele.hasAttribute(INIT_METHOD_ATTRIBUTE)) {
			String initMethodName = ele.getAttribute(INIT_METHOD_ATTRIBUTE);
			bd.setInitMethodName(initMethodName);
		}
		else if (this.defaults.getInitMethod() != null) {
			bd.setInitMethodName(this.defaults.getInitMethod());
			bd.setEnforceInitMethod(false);
		}

		if (ele.hasAttribute(DESTROY_METHOD_ATTRIBUTE)) {
			String destroyMethodName = ele.getAttribute(DESTROY_METHOD_ATTRIBUTE);
			bd.setDestroyMethodName(destroyMethodName);
		}
		else if (this.defaults.getDestroyMethod() != null) {
			bd.setDestroyMethodName(this.defaults.getDestroyMethod());
			bd.setEnforceDestroyMethod(false);
		}

		if (ele.hasAttribute(FACTORY_METHOD_ATTRIBUTE)) {
			bd.setFactoryMethodName(ele.getAttribute(FACTORY_METHOD_ATTRIBUTE));
		}
		if (ele.hasAttribute(FACTORY_BEAN_ATTRIBUTE)) {
			bd.setFactoryBeanName(ele.getAttribute(FACTORY_BEAN_ATTRIBUTE));
		}

		return bd;
	}

│ │ │ └─ registerBeanDefinition()

返回到 DefaultBeanDefinitionDocumentReader的 processBeanDefinition()方法继续往下走,第一步已经对BeanDefinition属性解析完成,返回 BeanDefinitionHolder对象。

接下来要进行registerBeanDefinition。

类文件:org.springframework.beans.factory.support.BeanDefinitionReaderUtils

	public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {

		// Register bean definition under primary name.
		String beanName = definitionHolder.getBeanName();
		// 注册 beanDefinition 
		// 把 beanDefinition   添加到beanDefinitionMap中
		// 把 beanName 放到 beanDefinitionNames list中
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
		// 建立别名和 id的映射,这样就可以根据别名获取到id
		// Register aliases for bean name, if any.
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
	}

│ │ ├─ parseCustomElement() 自定义标签解析入口

至此,默认标签的解析过程全部完成。

返回到 DefaultBeanDefinitionDocumentReader 的 parseBeanDefinitions 方法

进入 parseCustomElement()方法,自定义标签解析

类文件:org.springframework.beans.factory.xml.BeanDefinitionParserDelegate

	@Nullable
	public BeanDefinition parseCustomElement(Element ele, @Nullable BeanDefinition containingBd) {
		// 根据自定义标签的前缀(例如:context:component-scan)
		// 获取beans标签xsi:schemaLocation属性值中对应的uri
		// (http://www.springframework.org/schema/context)
		String namespaceUri = getNamespaceURI(ele);
		if (namespaceUri == null) {
			return null;
		}
		// SPI设计,获取/META-INF/spring.handers中URI对应的Hander处理类
		NamespaceHandler handler = this.readerContext.getNamespaceHandlerResolver().resolve(namespaceUri);
		if (handler == null) {
			error("Unable to locate Spring NamespaceHandler for XML schema namespace [" + namespaceUri + "]", ele);
			return null;
		}
		// 执行 实现类NamespaceHandlerSupport 中的parse 方法
		return handler.parse(ele, new ParserContext(this.readerContext, this, containingBd));
	}

│ │ │ ├─ parse()

进入 parse()方法

类文件:org.springframework.beans.factory.xml.NamespaceHandlerSupport

	@Override
	@Nullable
	public BeanDefinition parse(Element element, ParserContext parserContext) {
		// 根据自定义标签的前缀   获取对应的解析类。
		BeanDefinitionParser parser = findParserForElement(element, parserContext);
		// 执行对应的解析方法
		// 例如: 调用ComponentScanBeanDefinitionParser实现类中的 parse方法
		return (parser != null ? parser.parse(element, parserContext) : null);
	}

│ │ │ ├─ findParserForElement()

进入 findParserForElement()方法

类文件:org.springframework.beans.factory.xml.NamespaceHandlerSupport

	@Nullable
	private BeanDefinitionParser findParserForElement(Element element, ParserContext parserContext) {
		// 获取组件名称
		String localName = parserContext.getDelegate().getLocalName(element);
		// Map<String, BeanDefinitionParser> parsers = new HashMap<>()
		BeanDefinitionParser parser = this.parsers.get(localName);
		if (parser == null) {
			parserContext.getReaderContext().fatal(
					"Cannot locate BeanDefinitionParser for element [" + localName + "]", element);
		}
		return parser;
	}

│ │ │ ├─ parse() (这里已ComponentScanBeanDefinitionParser为例子)

进入 parse()方法

类文件:org.springframework.context.annotation.ComponentScanBeanDefinitionParser

	@Override
	@Nullable
	public BeanDefinition parse(Element element, ParserContext parserContext) {
		// 获取base-package属性的值
		String basePackage = element.getAttribute(BASE_PACKAGE_ATTRIBUTE);
		basePackage = parserContext.getReaderContext().getEnvironment().resolvePlaceholders(basePackage);
		String[] basePackages = StringUtils.tokenizeToStringArray(basePackage,
				ConfigurableApplicationContext.CONFIG_LOCATION_DELIMITERS);

		// Actually scan for bean definitions and register them.
		// 创建扫描器
		ClassPathBeanDefinitionScanner scanner = configureScanner(parserContext, element);
		// 进行扫描,并且把扫描到的类封装成BeanDefinition (扫描路径.class后缀的文件)
		Set<BeanDefinitionHolder> beanDefinitions = scanner.doScan(basePackages);
		// 注册组件
		registerComponents(parserContext.getReaderContext(), beanDefinitions, element);

		return null;
	}

│ │ │ ├─ configureScanner()

进入 configureScanner()方法, 创建注解扫描器

类文件:org.springframework.context.annotation.ComponentScanBeanDefinitionParser


	protected ClassPathBeanDefinitionScanner configureScanner(ParserContext parserContext, Element element) {
		// 是否使用默认过滤器
		boolean useDefaultFilters = true;
		//  @Component 默认的过滤器
		if (element.hasAttribute(USE_DEFAULT_FILTERS_ATTRIBUTE)) {
			useDefaultFilters = Boolean.parseBoolean(element.getAttribute(USE_DEFAULT_FILTERS_ATTRIBUTE));
		}

		// Delegate bean definition registration to scanner class.
		// 创建一个扫描器
		ClassPathBeanDefinitionScanner scanner = createScanner(parserContext.getReaderContext(), useDefaultFilters);
		scanner.setBeanDefinitionDefaults(parserContext.getDelegate().getBeanDefinitionDefaults());
		scanner.setAutowireCandidatePatterns(parserContext.getDelegate().getAutowireCandidatePatterns());

		// 判断是否有resource-pattern属性
		if (element.hasAttribute(RESOURCE_PATTERN_ATTRIBUTE)) {
			scanner.setResourcePattern(element.getAttribute(RESOURCE_PATTERN_ATTRIBUTE));
		}

		try {
			// 解析name-generator属性
			parseBeanNameGenerator(element, scanner);
		}
		catch (Exception ex) {
			parserContext.getReaderContext().error(ex.getMessage(), parserContext.extractSource(element), ex.getCause());
		}

		try {
			// 解析scope-resolver属性
			parseScope(element, scanner);
		}
		catch (Exception ex) {
			parserContext.getReaderContext().error(ex.getMessage(), parserContext.extractSource(element), ex.getCause());
		}
		// 解析子标签 include-filter exclude-filter
		parseTypeFilters(element, scanner, parserContext);

		return scanner;
	}

│ │ │ ├─ createScanner()

进入 createScanner()方法

类文件:org.springframework.context.annotation.ComponentScanBeanDefinitionParser

	protected ClassPathBeanDefinitionScanner createScanner(XmlReaderContext readerContext, boolean useDefaultFilters) {
		return new ClassPathBeanDefinitionScanner(readerContext.getRegistry(), useDefaultFilters,
				readerContext.getEnvironment(), readerContext.getResourceLoader());
	}

│ │ │ ├─ classPathBeanDefinitionScanner()

进入 ClassPathBeanDefinitionScanner()方法

类文件:org.springframework.context.annotation.ClassPathBeanDefinitionScanner

	public ClassPathBeanDefinitionScanner(BeanDefinitionRegistry registry, boolean useDefaultFilters,
			Environment environment, @Nullable ResourceLoader resourceLoader) {

		Assert.notNull(registry, "BeanDefinitionRegistry must not be null");
		this.registry = registry;
		// 使用默认的过滤器
		if (useDefaultFilters) {
			// 添加默认过滤器  component 、javax.annotation.ManagedBean 、 javax.inject.Named
			// 存到ClassPathScanningCandidateComponentProvider的includeFilters中
			registerDefaultFilters();
		}
		setEnvironment(environment);
		setResourceLoader(resourceLoader);
	}

│ │ │ ├─ registerDefaultFilters()

进入 registerDefaultFilters()方法

类文件:org.springframework.context.annotation.ClassPathScanningCandidateComponentProvider

	@SuppressWarnings("unchecked")
	protected void registerDefaultFilters() {
		// 将@Component添加到 AnnotationTypeFilter包装类 在放到includeFilters中
		this.includeFilters.add(new AnnotationTypeFilter(Component.class));
		// 类加载器
		ClassLoader cl = ClassPathScanningCandidateComponentProvider.class.getClassLoader();
		try {
			// 将javax.annotation.ManagedBean添加到 AnnotationTypeFilter包装类 在放到includeFilters中
			this.includeFilters.add(new AnnotationTypeFilter(
					((Class<? extends Annotation>) ClassUtils.forName("javax.annotation.ManagedBean", cl)), false));
			logger.trace("JSR-250 'javax.annotation.ManagedBean' found and supported for component scanning");
		}
		catch (ClassNotFoundException ex) {
			// JSR-250 1.1 API (as included in Java EE 6) not available - simply skip.
		}
		try {
			// 将javax.inject.Named添加到 AnnotationTypeFilter包装类 在放到includeFilters中
			this.includeFilters.add(new AnnotationTypeFilter(
					((Class<? extends Annotation>) ClassUtils.forName("javax.inject.Named", cl)), false));
			logger.trace("JSR-330 'javax.inject.Named' annotation found and supported for component scanning");
		}
		catch (ClassNotFoundException ex) {
			// JSR-330 API not available - simply skip.
		}
	}

│ │ │ ├─ doScan()

至此注解扫描器创建过程完毕,注解类填充到List中,

返回parse()方法,进入doScan()方法

类文件:org.springframework.context.annotation.ClassPathBeanDefinitionScanner

	protected Set<BeanDefinitionHolder> doScan(String... basePackages) {
		Assert.notEmpty(basePackages, "At least one base package must be specified");
		Set<BeanDefinitionHolder> beanDefinitions = new LinkedHashSet<>();
		for (String basePackage : basePackages) {
			Set<BeanDefinition> candidates = findCandidateComponents(basePackage);
			for (BeanDefinition candidate : candidates) {
				// 解析Scope标签,如果没有则,则默认是singleton 单例模式
				ScopeMetadata scopeMetadata = this.scopeMetadataResolver.resolveScopeMetadata(candidate);
				candidate.setScope(scopeMetadata.getScopeName());
				String beanName = this.beanNameGenerator.generateBeanName(candidate, this.registry);
				// 设置默认属性值   涉及 lazy   destroyMethod 等
				if (candidate instanceof AbstractBeanDefinition) {
					postProcessBeanDefinition((AbstractBeanDefinition) candidate, beanName);
				}
				// 处理通用的Definition注解 ,如果存在对应的注解则进行设置    注解例如: @lazy @Primary  @DependsOn @Description 等
				if (candidate instanceof AnnotatedBeanDefinition) {
					AnnotationConfigUtils.processCommonDefinitionAnnotations((AnnotatedBeanDefinition) candidate);
				}
				// 检查是否注册同名的BeanDefinition, 如果有是不是一样的
				if (checkCandidate(beanName, candidate)) {
					BeanDefinitionHolder definitionHolder = new BeanDefinitionHolder(candidate, beanName);
					definitionHolder =
							AnnotationConfigUtils.applyScopedProxyMode(scopeMetadata, definitionHolder, this.registry);
					beanDefinitions.add(definitionHolder);
					// BeanDefinition的注册
					registerBeanDefinition(definitionHolder, this.registry);
				}
			}
		}
		return beanDefinitions;
	}

│ │ │ └─ registerBeanDefinition()

进入 registerBeanDefinition()方法

类文件:org.springframework.beans.factory.support.BeanDefinitionReaderUtils

	public static void registerBeanDefinition(
			BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
			throws BeanDefinitionStoreException {

		// Register bean definition under primary name.
		String beanName = definitionHolder.getBeanName();
		// 注册 beanDefinition
		// 把 beanDefinition   添加到beanDefinitionMap中
		// 把 beanName 放到 beanDefinitionNames list中
		registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
		// 建立别名和 id的映射,这样就可以根据别名获取到id
		// Register aliases for bean name, if any.
		String[] aliases = definitionHolder.getAliases();
		if (aliases != null) {
			for (String alias : aliases) {
				registry.registerAlias(beanName, alias);
			}
		}
	}

至此,自定义标签的解析过程全部完成。

总结

  • 默认标签和自定义标签最终注册都是存到BeanFactory的beanDefinitionMap和beanDefinitionNames 中。

  • 核心方法refresh()中的 obtainFreshBeanFactory()方法执行完成,解析出来的xml标签封装成BeanDefinition对象,然后通过getBeanFactory()方法 返回 ConfigurableListableBeanFactory对象,至此创建填充BeanFactory的功能也全部完成。

  • 0
    点赞
  • 2
    收藏
    觉得还不错? 一键收藏
  • 1
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值