Spring源码之getBean(获取 bean)方法(二)解读

目录

  • 前言
  • `spring` 初始化 `bean` 过程
    • 进入类 `ClassPathXmlApplicationContext` 的构造器
    • `AbstractApplicationContext` 的 `refresh()`方法(重点
      • `AbstractApplicationContext` 的 `refresh()`中的重点方法
    • `AbstractApplicationContext` 的 `finishBeanFactoryInitialization` 方法
    • 类 `DefaultListableBeanFactory` 的 `preInstantiateSingletons()` 方法
    • 调用了抽象类 `AbstractBeanFactory` 的 `getBean` 方法
      • 调用了抽象类 `AbstractBeanFactory` 的 `doGetBean` 方法
      • 如上的 `getSingleton()` 方法实现在父类 `DefaultSingletonBeanRegistry` 中
      • 如上的 `createBean` 方法位于 `AbstractAutowireCapableBeanFactory` 中
      • `doCreateBean(beanName, mbd, args)` 具体创建 `bean` 的逻辑步骤如下(重点
        • `doCreateBean(beanName, mbd, args)` 的主要方法流程:(重点
    • 至此在 `doCreateBean()` 方法中完成单例 `bean` 的创建,代码层面大致过程如下:
  • 文章疑问解答

前言

接着上篇博客 Spring源码之 getBean(获取 bean)方法解读 ,在博客最后有个疑问:getBean 的时候总是从单例缓存池(一级缓存 singletonObjects)中拿到了,那么productInfoServiceImpl 这个 bean 是在什么时候初始化的,又在什么时候添加进了单例缓存池(一级缓存 singletonObjects)中呢

public class Test_2 {

    public static void main(String[] args) {
        /* 初始化启动 spring ioc 容器 */
        ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext-spring.xml");
        /* 从 spring ioc 容器中获取一个 bean */
        ProductInfoService productInfoService = (ProductInfoService) applicationContext.getBean("productInfoServiceImpl");
        System.out.println("拿到的Bean为:" + productInfoService);
    }
}

spring 初始化 bean 过程

使用开发工具进入 DEBUG 模式,给下面的代码打上断点

ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext-spring.xml");

进入类 ClassPathXmlApplicationContext 的构造器

public ClassPathXmlApplicationContext(
			String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
			throws BeansException {

		super(parent);
		setConfigLocations(configLocations);
		if (refresh) {
			refresh();
		}
}

看一下它的核心方法肯定就在 refresh() 里面,实际上它调用的是抽象类AbstractApplicationContextrefresh()

AbstractApplicationContextrefresh()方法(重点

@Override
	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
		
			/**
			 * 刷新上下文环境,初始化上下文环境,对系统的环境变量或者系统属性进行准备和校验
			 */
			prepareRefresh();

			// 该方法会解析所有 spring 配置文件(通常我们会放在 resources 目录下)
			// 将配置文件中的 bean 定义封装成 BeanDefinition,加载到 BeanFactory 中
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

			/**
			 * 为上下文准备BeanFactory,即对BeanFactory的各种功能进行填充,如常用的注解@Autowired @Qualifier等
			 * 设置SPEL表达式#{key}的解析器
			 * 设置资源编辑注册器,如PerpertyEditorSupper的支持
			 * 添加ApplicationContextAwareProcessor处理器
			 * 在依赖注入忽略实现*Aware的接口,如EnvironmentAware、ApplicationEventPublisherAware等
			 * 注册依赖,如一个bean的属性中含有ApplicationEventPublisher(beanFactory),则会将beanFactory的实例注入进去
			 */
			prepareBeanFactory(beanFactory);

			try {
				/**
				 * 提供子类覆盖的额外处理,即子类处理自定义的BeanFactoryPostProcess
				 * 在当前上下文使用的Bean容器BeanFactory的标准初始化完成后对其做一些修改。此时
				 * 所有的Bean definition都已经加载但是还没有 Bean 被创建
				 */
				postProcessBeanFactory(beanFactory);

				/**
				 * 实例化和调用所有 BeanFactoryPostProcessor,包括其子类 BeanDefinitionRegistryPostProcessor
				 * 激活各种BeanFactory处理器,包括BeanDefinitionRegistryBeanFactoryPostProcessor和普通的BeanFactoryPostProcessor
				 * 执行对应的postProcessBeanDefinitionRegistry方法 和  postProcessBeanFactory方法
				 */
				invokeBeanFactoryPostProcessors(beanFactory);

				/**
				 * 注册所有的 BeanPostProcessor,将所有实现了 BeanPostProcessor 接口的类加载到 BeanFactory 中
				 * 注册拦截Bean创建的Bean处理器,即注册BeanPostProcessor,不是BeanFactoryPostProcessor,注意两者的区别
				 * 注意,这里仅仅是注册,并不会执行对应的方法,将在bean的实例化时执行对应的方法
				 */				
				registerBeanPostProcessors(beanFactory);

				// 初始化上下文中的资源文件,如国际化文件的处理等
				initMessageSource();

				// 初始化上下文事件广播器,并放入applicatioEventMulticaster,如ApplicationEventPublisher
				initApplicationEventMulticaster();

				// 给子类扩展初始化其他Bean
				onRefresh();

				// 注册监听器
				registerListeners();

				/**
				 * 设置转换器
				 * 注册一个默认的属性值解析器
				 * 冻结所有的bean定义,说明注册的bean定义将不能被修改或进一步的处理
				 * 初始化剩余的非惰性的bean,即初始化非延迟加载的bean
				 */
				finishBeanFactoryInitialization(beanFactory);

				/**
				 * 初始化生命周期处理器DefaultLifecycleProcessor,DefaultLifecycleProcessor含有start方法和stop方法,spring启动的时候调用start方法开始生命周期,
				 * spring关闭的时候调用stop方法来结束生命周期,通常用来配置后台程序,启动有一直运行,如一直轮询kafka
				 * 启动所有实现了Lifecycle接口的类
				 * 通过spring的事件发布机制发布ContextRefreshedEvent事件,以保证对应的监听器做进一步的处理,即对那种在spring启动后需要处理的一些类,这些类实现了
				 * ApplicationListener ,这里就是要触发这些类的执行(执行onApplicationEvent方法)另外,spring的内置Event有ContextClosedEvent、ContextRefreshedEvent、ContextStartedEvent、ContextStoppedEvent、RequestHandleEvent
				 * 完成初始化,通知生命周期处理器lifeCycleProcessor刷新过程,同时发出ContextRefreshEvent通知其他人
				 */
				finishRefresh();
			}

			catch (BeansException ex) {
				if (logger.isWarnEnabled()) {
					logger.warn("Exception encountered during context initialization - " +
							"cancelling refresh attempt: " + ex);
				}
				destroyBeans();
				cancelRefresh(ex);
				throw ex;
			}
			finally {
				resetCommonCaches();
			}
		}
	}

AbstractApplicationContextrefresh()中的重点方法

  • obtainFreshBeanFactory():创建一个新的 BeanFactory、读取和解析 bean 定义
  • invokeBeanFactoryPostProcessors :提供给开发者对 BeanFactory 进行扩展
  • registerBeanPostProcessors :提供给开发者对 bean 进行扩展
  • finishBeanFactoryInitialization实例化剩余的所有非懒加载单例 bean

AbstractApplicationContextfinishBeanFactoryInitialization 方法

该方法会实例化所有剩余的非懒加载单例 bean。除了一些内部的 bean、实现了 BeanFactoryPostProcessor 接口的 bean、实现了 BeanPostProcessor 接口的 bean,其他的非懒加载单例 bean 都会在这个方法中被实例化,并且 BeanPostProcessor 的触发也是在这个方法中

protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {

		// 1.初始化此上下文的转换服务
		if (beanFactory.containsBean(CONVERSION_SERVICE_BEAN_NAME) &&
				beanFactory.isTypeMatch(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class)) {
			beanFactory.setConversionService(
					beanFactory.getBean(CONVERSION_SERVICE_BEAN_NAME, ConversionService.class));
		}

		// 2.如果beanFactory之前没有注册嵌入值解析器,则注册默认的嵌入值解析器:主要用于注解属性值的解析
		if (!beanFactory.hasEmbeddedValueResolver()) {
			beanFactory.addEmbeddedValueResolver(strVal -> getEnvironment().resolvePlaceholders(strVal));
		}

		// 3.初始化LoadTimeWeaverAware Bean实例对象
		String[] weaverAwareNames = beanFactory.getBeanNamesForType(LoadTimeWeaverAware.class, false, false);
		for (String weaverAwareName : weaverAwareNames) {
			getBean(weaverAwareName);
		}

		// Stop using the temporary ClassLoader for type matching.
		beanFactory.setTempClassLoader(null);

		// 4.冻结所有bean定义,注册的bean定义不会被修改或进一步后处理,因为马上要创建 Bean 实例对象了
		beanFactory.freezeConfiguration();

		// 5.实例化所有剩余(非懒加载)单例对象
		beanFactory.preInstantiateSingletons();
	}

很明显应该继续追踪 beanFactory.preInstantiateSingletons(),会发现它调用的是类 DefaultListableBeanFactorypreInstantiateSingletons()

DefaultListableBeanFactorypreInstantiateSingletons() 方法

@Override
public void preInstantiateSingletons() throws BeansException {

    if (this.logger.isDebugEnabled()) {
        this.logger.debug("Pre-instantiating singletons in " + this);
    }
 
    // 1.创建beanDefinitionNames的副本beanNames用于后续的遍历,以允许init等方法注册新的bean定义
    List<String> beanNames = new ArrayList<String>(this.beanDefinitionNames);
 
    // 2.遍历beanNames,触发所有非懒加载单例bean的初始化
    for (String beanName : beanNames) {
        // 3.获取beanName对应的MergedBeanDefinition
        RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
        // 4.bd对应的Bean实例:不是抽象类 && 是单例 && 不是懒加载
        if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
            // 5.判断beanName对应的bean是否为FactoryBean
            if (isFactoryBean(beanName)) {
                // 5.1 通过beanName获取FactoryBean实例
                // 通过getBean(&beanName)拿到的是FactoryBean本身;通过getBean(beanName)拿到的是FactoryBean创建的Bean实例
                final FactoryBean<?> factory = (FactoryBean<?>) getBean(FACTORY_BEAN_PREFIX + beanName);
                // 5.2 判断这个FactoryBean是否希望急切的初始化
                boolean isEagerInit;
                if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
                    isEagerInit = AccessController.doPrivileged(new PrivilegedAction<Boolean>() {
                        @Override
                        public Boolean run() {
                            return ((SmartFactoryBean<?>) factory).isEagerInit();
                        }
                    }, getAccessControlContext());
                } else {
                    isEagerInit = (factory instanceof SmartFactoryBean &&
                            ((SmartFactoryBean<?>) factory).isEagerInit());
                }
                if (isEagerInit) {
                    // 5.3 如果希望急切的初始化,则通过beanName获取bean实例
                    getBean(beanName);
                }
            } else {
                // 6.如果beanName对应的bean不是FactoryBean,只是普通Bean,通过beanName获取bean实例
                getBean(beanName);
            }
        }
    }

    // 7.遍历beanNames,触发所有SmartInitializingSingleton的后初始化回调
    for (String beanName : beanNames) {
        // 7.1 拿到beanName对应的bean实例
        Object singletonInstance = getSingleton(beanName);
        // 7.2 判断singletonInstance是否实现了SmartInitializingSingleton接口
        if (singletonInstance instanceof SmartInitializingSingleton) {
            final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
            // 7.3 触发SmartInitializingSingleton实现类的afterSingletonsInstantiated方法
            if (System.getSecurityManager() != null) {
                AccessController.doPrivileged(new PrivilegedAction<Object>() {
                    @Override
                    public Object run() {
                        smartSingleton.afterSingletonsInstantiated();
                        return null;
                    }
                }, getAccessControlContext());
            } else {
                smartSingleton.afterSingletonsInstantiated();
            }
        }
    }
}

继续追踪 getBean(beanName) 方法

调用了抽象类 AbstractBeanFactorygetBean 方法

@Override
public Object getBean(String name) throws BeansException {
	return doGetBean(name, null, null, false);
}

调用了抽象类 AbstractBeanFactorydoGetBean 方法

到了这里,我们发现这个 doGetBean 方法

 /* 初始化启动 spring ioc 容器 */
ApplicationContext applicationContext = new ClassPathXmlApplicationContext("applicationContext-spring.xml");

在上面的代码会调用一次

/* 从 spring ioc 容器中获取一个 bean */
ProductInfoService productInfoService = (ProductInfoService) applicationContext.getBean("productInfoServiceImpl");

上面的代码也会调用一次;只不过 getBean("productInfoServiceImpl")时,productInfoServiceImpl 这个 bean会从下面代码中,单例缓存池(一级缓存 singletonObjects)可以拿到

// 可以拿到 productInfoServiceImpl 这个 bean
Object sharedInstance = getSingleton(beanName);

我们可以断定,第一次执行时 sharedInstance == null,即还没有添加进缓存中

@SuppressWarnings("unchecked")
protected <T> T doGetBean(final String name, @Nullable final Class<T> requiredType,
			@Nullable final Object[] args, boolean typeCheckOnly) throws BeansException {

	/**
	 * 通过 name 获取 beanName。这里不使用 name 直接作为 beanName 有两个原因
	 * 1、name 可能会以 & 字符开头,表明调用者想获取 FactoryBean 本身,而非 FactoryBean
	 *   实现类所创建的 bean。在 BeanFactory 中,FactoryBean 的实现类和其他的 bean 存储
	 *   方式是一致的,即 ,beanName 中是没有 & 这个字符的。所以我们需要
	 *   将 name 的首字符 & 移除,这样才能从缓存里取到 FactoryBean 实例。
	 * 2、还是别名的问题,转换需要 &beanName
	 */
	final String beanName = transformedBeanName(name);
	Object bean;

	// 先从缓存中获取,因为在容器初始化的时候或者其他地方调用过getBean,已经完成了初始化
	Object sharedInstance = getSingleton(beanName);
	// 如果已经初始化过,直接从缓存中获取
	if (sharedInstance != null && args == null) {
		// 如果beanName的实例存在于缓存中
		if (logger.isDebugEnabled()) {
			if (isSingletonCurrentlyInCreation(beanName)) {
				logger.debug("Returning eagerly cached instance of singleton bean '" + beanName +
						"' that is not fully initialized yet - a consequence of a circular reference");
			}
			else {
				logger.debug("Returning cached instance of singleton bean '" + beanName + "'");
			}
		}
	
	   /**
		* 如果 sharedInstance 是普通的单例 bean,下面的方法会直接返回。但如果
		* sharedInstance 是 FactoryBean 类型的,则需调用 getObject 工厂方法获取真正的
		* bean 实例。如果用户想获取 FactoryBean 本身,这里也不会做特别的处理,直接返回
		* 即可。毕竟 FactoryBean 的实现类本身也是一种 bean,只不过具有一点特殊的功能而已。
		*/
		bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
	}

	else {
		// 如果是原型不应该在初始化的时候创建,在这里直接抛出异常
		if (isPrototypeCurrentlyInCreation(beanName)) {
			throw new BeanCurrentlyInCreationException(beanName);
		}

		// 获取parentBeanFactory
		BeanFactory parentBeanFactory = getParentBeanFactory();
		if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
			// 将别名解析成真正的beanName
			String nameToLookup = originalBeanName(name);
			// 如果parentBeanFactory存在,并且beanName在当前BeanFactory不存在Bean定义,则尝试从parentBeanFactory中获取bean实例
			if (parentBeanFactory instanceof AbstractBeanFactory) {
				return ((AbstractBeanFactory) parentBeanFactory).doGetBean(
							nameToLookup, requiredType, args, typeCheckOnly);
			}
			// 尝试在parentBeanFactory中获取bean对象实例
			else if (args != null) {
				return (T) parentBeanFactory.getBean(nameToLookup, args);
			}
			else {
				return parentBeanFactory.getBean(nameToLookup, requiredType);
			}
		}

		if (!typeCheckOnly) {
			// 添加到alreadyCreated set集合当中,表示他已经创建过一次,做标记
			markBeanAsCreated(beanName);
		}

		try {
			// 根据beanName重新获取MergedBeanDefinition(步骤6将MergedBeanDefinition删除了,这边获取一个新的)
			final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
			// 检查MergedBeanDefinition
			checkMergedBeanDefinition(mbd, beanName, args);

			// 拿到当前bean依赖的bean名称集合,在实例化自己之前,需要先实例化自己依赖的bean
			String[] dependsOn = mbd.getDependsOn();
			if (dependsOn != null) {
				// 遍历当前bean依赖的bean名称集合
				for (String dep : dependsOn) {
					// 检查dep是否依赖于beanName,即检查是否存在循环依赖
					if (isDependent(beanName, dep)) {
					// 如果是循环依赖则抛异常
						throw new BeanCreationException(mbd.getResourceDescription(), beanName,
								"Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
					}
					// 将dep和beanName的依赖关系注册到缓存中
					registerDependentBean(dep, beanName);
					try {
						// 获取dep对应的bean实例,如果dep还没有创建bean实例,则创建dep的bean实例
						getBean(dep);
					}
					catch (NoSuchBeanDefinitionException ex) {
						throw new BeanCreationException(mbd.getResourceDescription(), beanName,
								"'" + beanName + "' depends on missing bean '" + dep + "'", ex);
					}
				}
			}

			// bean 的实例化
			if (mbd.isSingleton()) {
				// scope为 singleton 的bean创建(新建了一个ObjectFactory,并且重写了getObject方法)
				sharedInstance = getSingleton(beanName, () -> {
					try {
						// 创建Bean实例
						return createBean(beanName, mbd, args);
					}
					catch (BeansException ex) {
						destroySingleton(beanName);
						throw ex;
					}
				});
				// 返回beanName对应的实例对象
				bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
			}
				
			else if (mbd.isPrototype()) {
				// scope为 prototype 的bean创建
				Object prototypeInstance = null;
				try {
					// 创建实例前的操作(将beanName保存到prototypesCurrentlyInCreation缓存中)
					beforePrototypeCreation(beanName);
					// 创建Bean实例
					prototypeInstance = createBean(beanName, mbd, args);
				}
				finally {
				// 创建实例后的操作(将创建完的beanName从prototypesCurrentlyInCreation缓存中移除)
					afterPrototypeCreation(beanName);
				}
				// 返回beanName对应的实例对象
				bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
			}
			else {
				// 既不是单例也不是原型的 bean创建,可能是 request之类的
				// 根据scopeName,从缓存拿到scope实例
				String scopeName = mbd.getScope();
				final Scope scope = this.scopes.get(scopeName);
				if (scope == null) {
					throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
				}
				try {
				    // 既不是单例也不是原型的bean创建(新建了一个ObjectFactory,并且重写了getObject方法)
					Object scopedInstance = scope.get(beanName, () -> {
						// 创建实例前的操作(将beanName保存到prototypesCurrentlyInCreation缓存中)
						beforePrototypeCreation(beanName);
						try {
							// 创建bean实例
							return createBean(beanName, mbd, args);
						}
						finally {
							// 创建实例后的操作(将创建完的beanName从prototypesCurrentlyInCreation缓存中移除)
							afterPrototypeCreation(beanName);
						}
					});
					// 返回beanName对应的实例对象
					bean = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
				}
				catch (IllegalStateException ex) {
					throw new BeanCreationException(beanName,
							"Scope '" + scopeName + "' is not active for the current thread; consider " +
							"defining a scoped proxy for this bean if you intend to refer to it from a singleton",
							ex);
				}
			}
		}
		catch (BeansException ex) {
			// 如果创建bean实例过程中出现异常,则将beanName从alreadyCreated缓存中移除
			cleanupAfterBeanCreationFailure(beanName);
			throw ex;
		}
	}

	// 检查所需类型是否与实际的bean对象的类型匹配
	if (requiredType != null && !requiredType.isInstance(bean)) {
		try {
			// 类型不对,则尝试转换bean类型
			T convertedBean = getTypeConverter().convertIfNecessary(bean, requiredType);
			if (convertedBean == null) {
				throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
			}
			return convertedBean;
		}
		catch (TypeMismatchException ex) {
			if (logger.isDebugEnabled()) {
				logger.debug("Failed to convert bean '" + name + "' to required type '" +
						ClassUtils.getQualifiedName(requiredType) + "'", ex);
			}
			throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
		}
	}
	return (T) bean;
}

有关 doGetBean 的详情请查看

由于该测试案列中的 productInfoServiceImpl 默认是单例的,故而会执行 doGetBean() 方法中的如下代码

// bean 的实例化
if (mbd.isSingleton()) {
	// scope为 singleton 的bean创建(新建了一个ObjectFactory,并且重写了getObject方法)
	sharedInstance = getSingleton(beanName, () -> {
		try {
			// 创建Bean实例
			return createBean(beanName, mbd, args);
		}
		catch (BeansException ex) {
			destroySingleton(beanName);
			throw ex;
		}
	});
	// 返回beanName对应的实例对象
	// 这里主要处理实现了FactoryBean的情况,需要调用重写的getObject()方法来获取实际的Bean实例
	bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}

如上的 getSingleton() 方法实现在父类 DefaultSingletonBeanRegistry

public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {

	Assert.notNull(beanName, "'beanName' must not be null");
	synchronized (this.singletonObjects) {
	    // 双重判定从缓存中获取
		Object singletonObject = this.singletonObjects.get(beanName);
		if (singletonObject == null) {
			// 如果当前在destorySingletons中
			if (this.singletonsCurrentlyInDestruction) {
				throw new BeanCreationNotAllowedException(beanName,
						"Singleton bean creation not allowed while the singletons of this factory are in destruction " +
						"(Do not request a bean from a BeanFactory in a destroy method implementation!)");
			}
			if (logger.isDebugEnabled()) {
				logger.debug("Creating shared instance of singleton bean '" + beanName + "'");
			}
			// 创建单例之前的回调,默认实现将单例注册为当前正在创建中
			beforeSingletonCreation(beanName);
			boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
			if (recordSuppressedExceptions) {
				this.suppressedExceptions = new LinkedHashSet<Exception>();
			}
			try {
			    // 调用签名定义的内部类进行创建,内部调用了createBean(String beanName, RootBeanDefinition mbd, Object[] args)
				singletonObject = singletonFactory.getObject();
			}
			catch (BeanCreationException ex) {
				if (recordSuppressedExceptions) {
					for (Exception suppressedException : this.suppressedExceptions) {
						ex.addRelatedCause(suppressedException);
					}
				}
				throw ex;
			}
			finally {
				if (recordSuppressedExceptions) {
					this.suppressedExceptions = null;
				}
				// 创建前置检查,默认实现是移除当前beanName正在注册状态的记录
				afterSingletonCreation(beanName);
			}
			// 将已经完成实例化,属性赋值,相关的初始化的 bean 添加到一级缓存 singletonObjects 中
			addSingleton(beanName, singletonObject);
		}
		return (singletonObject != NULL_OBJECT ? singletonObject : null);
	}
}

注意:addSingleton(beanName, singletonObject) 方法

protected void addSingleton(String beanName, Object singletonObject) {
	synchronized (this.singletonObjects) {
		// 将一个 完整的 bean 添加到一级缓存中
		this.singletonObjects.put(beanName, singletonObject);
		// 移除三级缓存的数据
		this.singletonFactories.remove(beanName);
		// 移除二级缓存的数据
		this.earlySingletonObjects.remove(beanName);
		this.registeredSingletons.add(beanName);
	}
}

如上的 createBean 方法位于 AbstractAutowireCapableBeanFactory

@Override
protected Object createBean(String beanName, RootBeanDefinition mbd, Object[] args) throws BeanCreationException {
	
	if (logger.isDebugEnabled()) {
		logger.debug("Creating instance of bean '" + beanName + "'");
	}
	// 确保对应BeanClass完成解析,具体表现是进行了ClassLoder.loadClass或Class.forName完成了类加载
	resolveBeanClass(mbd, beanName);

	try {
	    // 准备方法覆盖,主要为lookup-method,replace-method等配置准备
		mbd.prepareMethodOverrides();
	}
	catch (BeanDefinitionValidationException ex) {
		throw new BeanDefinitionStoreException(mbd.getResourceDescription(),
				beanName, "Validation of method overrides failed", ex);
	}

	try {
		// 供特定后置处理器拓展,如果直接生成了一个Bean,就直接返回不走正常创建流程。
		// 具体逻辑是判断当前Spring容器是否注册了实现了InstantiationAwareBeanPostProcessor接口的后置处理器
		// 如果有,则依次调用其中的applyBeanPostProcessorsBeforeInstantiation方法,如果中间任意一个方法返回不为null,直接结束调用。
		// 然后依次所有注册的BeanPostProcessor的postProcessAfterInitialization方法(同样如果任意一次返回不为null,即终止调用。
		Object bean = resolveBeforeInstantiation(beanName, mbd);
		// 如果不为空,说明提前生成了实例,直接返回
		if (bean != null) {
			return bean;
		}
	}
	catch (Throwable ex) {
		throw new BeanCreationException(mbd.getResourceDescription(), beanName,
				"BeanPostProcessor before instantiation of bean failed", ex);
	}

    // 具体创建Bean逻辑
	Object beanInstance = doCreateBean(beanName, mbd, args);
	if (logger.isDebugEnabled()) {
		logger.debug("Finished creating instance of bean '" + beanName + "'");
	}
	return beanInstance;
}

doCreateBean(beanName, mbd, args) 具体创建 bean 的逻辑步骤如下(重点

protected Object doCreateBean(final String beanName, final RootBeanDefinition mbd, final @Nullable Object[] args)
			throws BeanCreationException {

	// BeanWrapper封装了具体的Bean实例,然后可以很方便地通过调用getPropertyValue和setPropertyValue等方法反射读写Bean的具体属性
	BeanWrapper instanceWrapper = null;
	if (mbd.isSingleton()) {
		// 先尝试从缓存中取
		instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
	}
	if (instanceWrapper == null) {
		// 调用构造方法创建一个空实例对象,并用BeanWrapper进行包装
		instanceWrapper = createBeanInstance(beanName, mbd, args);
	}
	final Object bean = instanceWrapper.getWrappedInstance();
	Class<?> beanType = instanceWrapper.getWrappedClass();
	if (beanType != NullBean.class) {
		mbd.resolvedTargetType = beanType;
	}

	// 获取所有的后置处理器,如果后置处理器实现了MergedBeanDefinitionPostProcessor接口,则一次调用其postProcessMergedBeanDefinition方法
	synchronized (mbd.postProcessingLock) {
		if (!mbd.postProcessed) {
			try {
				applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName);
			}
			catch (Throwable ex) {
				throw new BeanCreationException(mbd.getResourceDescription(), beanName,
						"Post-processing of merged bean definition failed", ex);
			}
			mbd.postProcessed = true;
		}
	}

	// 如果满足循环依赖缓存条件,先缓存具体对象
	boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
		isSingletonCurrentlyInCreation(beanName));
	if (earlySingletonExposure) {
		if (logger.isDebugEnabled()) {
			logger.debug("Eagerly caching bean '" + beanName +
					"' to allow for resolving potential circular references");
		}
	
	   /**
		* 循环依赖处理逻辑:将已完成实例化,但是未完成属性赋值和相关的初始化的一个不完整的 bean 添加到三级缓存 singletonFactories 中
		* 具体内部会遍历后置处理器,判断是否有SmartInstantiationAwareBeanPostProcessor的实现类,然后调用里面getEarlyBeanReference覆盖当前Bean
		* 默认不做任何操作返回当前Bean,作为拓展,这里比如可以供AOP来创建代理类
		*/
		addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
	}

	// 开始对Bean实例进行初始化
	Object exposedObject = bean;
	try {
		// 对bean进行属性填充,在这里面完成依赖注入的相关内容
		populateBean(beanName, mbd, instanceWrapper);
		// 完成属性依赖注入后,进一步初始化Bean
		// 具体进行了以下操作:
		// 1.若实现了BeanNameAware, BeanClassLoaderAware,BeanFactoryAwareAware等接口,则注入相关对象
		// 2.遍历后置处理器,调用实现的postProcessBeforeInitialization方法,
		// 3.如果实现了initialzingBean,调用实现的 afterPropertiesSet()
		// 4.如果配置了init-mothod,调用相应的init方法
		// 5.遍历后置处理器,调用实现的postProcessAfterInitialization
		exposedObject = initializeBean(beanName, exposedObject, mbd);
	}
	catch (Throwable ex) {
		if (ex instanceof BeanCreationException && beanName.equals(((BeanCreationException) ex).getBeanName())) {
			throw (BeanCreationException) ex;
		}
		else {
			throw new BeanCreationException(
					mbd.getResourceDescription(), beanName, "Initialization of bean failed", ex);
		}
	}

	if (earlySingletonExposure) {
		Object earlySingletonReference = getSingleton(beanName, false);
		if (earlySingletonReference != null) {
			if (exposedObject == bean) {
				exposedObject = earlySingletonReference;
			}
			else if (!this.allowRawInjectionDespiteWrapping && hasDependentBean(beanName)) {
				String[] dependentBeans = getDependentBeans(beanName);
				Set<String> actualDependentBeans = new LinkedHashSet<>(dependentBeans.length);
				for (String dependentBean : dependentBeans) {
					if (!removeSingletonIfCreatedForTypeCheckOnly(dependentBean)) {
						actualDependentBeans.add(dependentBean);
					}
				}
				if (!actualDependentBeans.isEmpty()) {
					throw new BeanCurrentlyInCreationException(beanName,
							"Bean with name '" + beanName + "' has been injected into other beans [" +
							StringUtils.collectionToCommaDelimitedString(actualDependentBeans) +
							"] in its raw version as part of a circular reference, but has eventually been " +
							"wrapped. This means that said other beans do not use the final version of the " +
							"bean. This is often the result of over-eager type matching - consider using " +
							"'getBeanNamesOfType' with the 'allowEagerInit' flag turned off, for example.");
				}
			}
		}
	}

	// 如果实现了Disposable接口,会在这里进行注册,最后在销毁的时候调用相应的destroy方法
	try {
		registerDisposableBeanIfNecessary(beanName, bean, mbd);
	}
	catch (BeanDefinitionValidationException ex) {
		throw new BeanCreationException(
				mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
	}
	return exposedObject;
}

doCreateBean(beanName, mbd, args) 的主要方法流程:(重点

  • createBeanInstance(beanName, mbd, args):实例化 bean
  • addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean)):将已完成实例化,但是未完成属性赋值和相关的初始化的一个不完整的 bean 添加到三级缓存 singletonFactories
  • populateBean(beanName, mbd, instanceWrapper):对 bean 进行属性填充注入
  • initializeBean(beanName, exposedObject, mbd):完成 bean 的属性填充注入后,进一步初始化 bean,在此过程中产生代理对象。此时 bean 的创建工作正式完成,已经可以在项目中使用了
  • registerDisposableBeanIfNecessary(beanName, bean, mbd):如果符合 bean 的销毁条件,则执行单例bean 的销毁工作

至此在 doCreateBean() 方法中完成单例 bean 的创建,代码层面大致过程如下:

  • 调用 AbstractApplicationContextrefresh()方法
  • 调用 refresh() 中的 finishBeanFactoryInitialization 方法
  • finishBeanFactoryInitialization 方法中调用类 DefaultListableBeanFactorypreInstantiateSingletons() 方法
  • preInstantiateSingletons() 方法再调用 getBean(beanName) 方法
  • 进入了 类 AbstractBeanFactorydoGetBean 方法(重点),先从缓存中拿,如果没有,再根据 bean 不同的作用域去创建 bean
  • bean 的具体初始化在类 AbstractAutowireCapableBeanFactorydoCreateBean 方法中

文章疑问解答

doGetBean() 方法单例 bean 的创建关键代码

// bean 的实例化
if (mbd.isSingleton()) {
		// scope为 singleton 的bean创建(新建了一个ObjectFactory,并且重写了getObject方法)
	sharedInstance = getSingleton(beanName, () -> {
		try {
			// 创建Bean实例
			return createBean(beanName, mbd, args);
		}
		catch (BeansException ex) {
			destroySingleton(beanName);
			throw ex;
		}
	});
	// 返回beanName对应的实例对象
	// 这里主要处理实现了FactoryBean的情况,需要调用重写的getObject()方法来获取实际的Bean实例
	bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}

当第 7createBean(beanName, mbd, args) 方法执行完成后,也就是说单例 bean 此时已经完成了创建(已完成实例化,属性填充注入,相关的初始化)操作

此时会执行第 4getSingleton() 方法中的

// 将beanName和singletonObject的映射关系添加到该工厂的单例缓存中
addSingleton(beanName, singletonObject);

进入 addSingleton() 方法

protected void addSingleton(String beanName, Object singletonObject) {
	synchronized (this.singletonObjects) {
		this.singletonObjects.put(beanName, singletonObject);
		this.singletonFactories.remove(beanName);
		this.earlySingletonObjects.remove(beanName);
		this.registeredSingletons.add(beanName);
	}
}

很明显的,在此处添加到了一级缓存 singletonObjects 中(已完成实例化,属性赋值,相关的初始化的一个完整的 bean),故而在案列中执行 getBean() 方法时

 /* 从 spring ioc 容器中获取一个 bean */
ProductInfoService productInfoService = (ProductInfoService) applicationContext.getBean("productInfoServiceImpl");

会从一级缓存 singletonObjects 中获取到单例 bean

故而可以得出结论:单例 bean 的创建是在 IOC 容器初始化启动时就已经创建完成了,同时将一个完整的 bean 添加到了一级缓存 singletonObjects 中了

spring bean 的初始化、依赖注入、缓存更为详细的文章

你可能感兴趣的:(#,源码,spring,spring)