用到的容器有:
- singletonCurrentlyInCreation:当前 bean 正在被创建
finishBeanFactoryInitialization(beanFactory);
AbstractApplicationContext # finishBeanFactoryInitialization
protected void finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory) {
// 设置类型转换器
// Initialize conversion service for this context.
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));
}
// Register a default embedded value resolver if no bean post-processor
// (such as a PropertyPlaceholderConfigurer bean) registered any before:
// at this point, primarily for resolution in annotation attribute values.
if (!beanFactory.hasEmbeddedValueResolver()) {
beanFactory.addEmbeddedValueResolver(strVal -> getEnvironment().resolvePlaceholders(strVal));
}
// Initialize LoadTimeWeaverAware beans early to allow for registering their transformers early.
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);
// 冻结所有的 bean 定义,说明注册的 bean 定义将不被修改或进行任何进一步的处理
beanFactory.freezeConfiguration();
// 初始化剩下的单实例(非延迟加载的 bean)
beanFactory.preInstantiateSingletons();
}
DefaultListableBeanFactory # preInstantiateSingletons
public void preInstantiateSingletons() throws BeansException {
if (logger.isTraceEnabled()) {
logger.trace("Pre-instantiating singletons in " + this);
}
// XML 解析时,把所有 beanName 都缓存到 beanDefinitionNames
List<String> beanNames = new ArrayList<>(this.beanDefinitionNames);
for (String beanName : beanNames) {
// 把父 BeanDefinition 里的属性拿到子 BeanDefinition 中
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
// 如果是 单例、非抽象、非懒加载,就实例化
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
// 判断 bean 是否实现了 FactoryBean 接口
if (isFactoryBean(beanName)) {
// 实例化 bean
/**
*
*
* @Component("factoryBeanA")
* public class FactoryBeanA implements FactoryBean<B> {
* @Override
* public B getObject() throws Exception {
* return new B();
* }
*
* @Override
* public Class<?> getObjectType() {
* return B.class;
* }
* }
*
* // class com.mustang.factoryBean.B
* Object factoryBeanB = context.getBean("factoryBeanA");
* System.out.println(factoryBeanB.getClass());
* // class com.mustang.factoryBean.FactoryBeanA
* Object factoryBeanA = context.getBean("&factoryBeanA");
* System.out.println(factoryBeanA.getClass());
*/
// 实例化 FactoryBean
Object bean = getBean(FACTORY_BEAN_PREFIX + beanName);
if (bean instanceof FactoryBean) {
FactoryBean<?> factory = (FactoryBean<?>) bean;
boolean isEagerInit;
if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
isEagerInit = AccessController.doPrivileged(
(PrivilegedAction<Boolean>) ((SmartFactoryBean<?>) factory)::isEagerInit,
getAccessControlContext());
}
else {
isEagerInit = (factory instanceof SmartFactoryBean &&
((SmartFactoryBean<?>) factory).isEagerInit());
}
if (isEagerInit) {
// 实例化 bean
getBean(beanName);
}
}
}
else {
// 实例化 bean
getBean(beanName);
}
}
}
// Trigger post-initialization callback for all applicable beans...
for (String beanName : beanNames) {
Object singletonInstance = getSingleton(beanName);
if (singletonInstance instanceof SmartInitializingSingleton) {
StartupStep smartInitialize = this.getApplicationStartup().start("spring.beans.smart-initialize")
.tag("beanName", beanName);
SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
if (System.getSecurityManager() != null) {
AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
smartSingleton.afterSingletonsInstantiated();
return null;
}, getAccessControlContext());
}
else {
smartSingleton.afterSingletonsInstantiated();
}
smartInitialize.end();
}
}
}
AbstractBeanFactory # getBean(java.lang.String)
public Object getBean(String name) throws BeansException {
return doGetBean(name, null, null, false);
}
protected <T> T doGetBean(
String name, @Nullable Class<T> requiredType, @Nullable Object[] args, boolean typeCheckOnly)
throws BeansException {
// 提取对应的 beanName
String beanName = transformedBeanName(name);
Object bean;
/**
* 检查缓存中或者实例工厂中是否有对应的实例
* 因为在创建单例 bean 时,会存在依赖注入的情况,为避免循环依赖,Spring 不等 bean 创建完成就会将创建 bean 的 ObjectFactory 提早曝光,
* 也就是将 ObjectFactory 加入缓存中,一旦下个 bean 创建时需要依赖上个 bean 则直接使用 ObjectFactory
*/
// 直接尝试从缓存获取或者 singletonFactories 中的 ObjectFactory 中获取
// 见下面 ### 1
Object sharedInstance = getSingleton(beanName);
// 如果能从缓存中获得已缓存的单例 bean,并且参数 args == null
if (sharedInstance != null && args == null) {
if (logger.isTraceEnabled()) {
if (isSingletonCurrentlyInCreation(beanName)) {
logger.trace("Returning eagerly cached instance of singleton bean '" + beanName +
"' that is not fully initialized yet - a consequence of a circular reference");
} else {
logger.trace("Returning cached instance of singleton bean '" + beanName + "'");
}
}
// 判断是不是 FactoryBean,对 FactoryBean 做处理
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
// 如果不能从缓存中找到单例 bean
else {
// 原型模式下发生循环依赖直接抛出异常 BeanCurrentlyInCreationException;只有单例模式下,才尝试解决循环依赖
if (isPrototypeCurrentlyInCreation(beanName)) {
throw new BeanCurrentlyInCreationException(beanName);
}
// Check if bean definition exists in this factory.
BeanFactory parentBeanFactory = getParentBeanFactory();
// 如果 BeanDefinitionMap(所有已经加载的类)中不包括 beanName,则尝试从 parentBeanFactory 中检测
// !containsBeanDefinition(beanName) 为 true,表示当前加载的 XML 配置文件中不包含 beanName 所对应的设置
if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
// 解析指定的 bean 名称的原始名称
String nameToLookup = originalBeanName(name);
if (parentBeanFactory instanceof AbstractBeanFactory) {
return ((AbstractBeanFactory) parentBeanFactory).doGetBean(
nameToLookup, requiredType, args, typeCheckOnly);
} else if (args != null) {
// Delegation to parent with explicit args.
// 委派父级容器根据指定名称、参数查找
return (T) parentBeanFactory.getBean(nameToLookup, args);
} else if (requiredType != null) {
// No args -> delegate to standard getBean method.
// 委派父级容器根据指定名称、类型查找
return parentBeanFactory.getBean(nameToLookup, requiredType);
} else {
return (T) parentBeanFactory.getBean(nameToLookup);
}
}
// 如果不是仅仅做类型检查,则创建 bean,这里要进行记录
if (!typeCheckOnly) {
// 把指定的 beanName 记录到 alreadyCreated 中,表明该 beanName 已经创建过,或即将创建
markBeanAsCreated(beanName);
}
StartupStep beanCreation = this.applicationStartup.start("spring.beans.instantiate")
.tag("beanName", name);
try {
if (requiredType != null) {
beanCreation.tag("beanType", requiredType::toString);
}
// 父子 BeanDefinition 合并
// 将存储 XML 配置文件的 GenericBeanDefinition 转换成 RootBeanDefinition,若带有 parentName 属性,则将 parentName 对应的 BeanDefinition 属性合并到自己的 BeanDefinition 属性上
// 从 XML 配置文件中读取到的 Bean 信息存储到 GenericBeanDefinition,所有 Bean 后续处理都针对 RootBeanDefinition,所以需要做转换
RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
checkMergedBeanDefinition(mbd, beanName, args);
// Guarantee initialization of beans that the current bean depends on.
// 获取当前 Bean 所依赖的 Bean,因为被依赖的对象要先实例化
String[] dependsOn = mbd.getDependsOn();
if (dependsOn != null) {
// 若存在依赖,则需要递归实例化被依赖的 Bean
for (String dep : dependsOn) {
if (isDependent(beanName, dep)) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
}
// 把 bean 依赖的信息缓存起来
registerDependentBean(dep, beanName);
try {
// 获取被依赖的 bean
getBean(dep);
} catch (NoSuchBeanDefinitionException ex) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"'" + beanName + "' depends on missing bean '" + dep + "'", ex);
}
}
}
// 实例化依赖的 bean 后,便可以实例化 mbd 本身了
// 创建单例模式 Bean 实例对象
if (mbd.isSingleton()) {
// 见 ### 2
sharedInstance = getSingleton(beanName, () -> {
try {
// 调用 AbstractBeanFactory 的实现类 AbstractAutowireCapableBeanFactory 中的 createBean 方法
return createBean(beanName, mbd, args);
} catch (BeansException ex) {
// Explicitly remove instance from singleton cache: It might have been put there
// eagerly by the creation process, to allow for circular reference resolution.
// Also remove any beans that received a temporary reference to the bean.
// 从容器单例模式 Bean 缓存中清除实例对象
destroySingleton(beanName);
throw ex;
}
});
// 获取给定的 Bean 实例对象
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
// 创建原型模式的 bean 实例对象(new)
else if (mbd.isPrototype()) {
// It's a prototype -> create a new instance.
Object prototypeInstance = null;
try {
beforePrototypeCreation(beanName);
// 创建 bean
prototypeInstance = createBean(beanName, mbd, args);
} finally {
afterPrototypeCreation(beanName);
}
// 获取给定 Bean 实例对象
bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
} else {
// 要创建的 bean 既不是单例模式,也不是原型模式
String scopeName = mbd.getScope();
if (!StringUtils.hasLength(scopeName)) {
throw new IllegalStateException("No scope name defined for bean ´" + beanName + "'");
}
Scope scope = this.scopes.get(scopeName);
// BeanDefinition 中没有生命周期的范围,则 bean 定义不合法
if (scope == null) {
throw new IllegalStateException("No Scope registered for scope name '" + scopeName + "'");
}
try {
Object scopedInstance = scope.get(beanName, () -> {
beforePrototypeCreation(beanName);
try {
return createBean(beanName, mbd, args);
} finally {
afterPrototypeCreation(beanName);
}
});
// 获取给定 Bean 实例对象
bean = getObjectForBeanInstance(scopedInstance, name, beanName, mbd);
} catch (IllegalStateException ex) {
throw new ScopeNotActiveException(beanName, scopeName, ex);
}
}
} catch (BeansException ex) {
beanCreation.tag("exception", ex.getClass().toString());
beanCreation.tag("message", String.valueOf(ex.getMessage()));
cleanupAfterBeanCreationFailure(beanName);
throw ex;
} finally {
beanCreation.end();
}
}
// 检查需要的类型是否符合 bean 的实例类型,做类型转换
if (requiredType != null && !requiredType.isInstance(bean)) {
try {
T convertedBean = getTypeConverter().convertIfNecessary(bean, requiredType);
if (convertedBean == null) {
throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
}
return convertedBean;
} catch (TypeMismatchException ex) {
if (logger.isTraceEnabled()) {
logger.trace("Failed to convert bean '" + name + "' to required type '" + ClassUtils.getQualifiedName(requiredType) + "'", ex);
}
throw new BeanNotOfRequiredTypeException(name, requiredType, bean.getClass());
}
}
return (T) bean;
}
1. getSingleton
DefaultSingletonBeanRegistry # getSingleton(java.lang.String)
public Object getSingleton(String beanName) {
// allowEarlyReference 设置为 true,标识允许早期依赖
return getSingleton(beanName, true);
}
实例化的 bean 的缓存:
- singletonObjects:保存 beanName 和创建 bean 实例之间的关系,bean name -> bean instance
- earlySingletonObjects:保存 beanName 和创建 bean 实例之间的关系,与 singletonObjects 不同之处在于,当一个单例 bean 被放到 这里面后,当 bean 还在创建过程中,就可以通过 getBean 方法获取到了,目的是用来检测循环引用
- singletonFactories:保存 beanName 和创建 bean 的工厂之间的关系,bean name -> ObjectFactory
- registeredSingletons:保存当前所有已注册的 bean
DefaultSingletonBeanRegistry # getSingleton(java.lang.String, boolean)
protected Object getSingleton(String beanName, boolean allowEarlyReference) {
// Quick check for existing instance without full singleton lock
// 先从一级缓存拿
Object singletonObject = this.singletonObjects.get(beanName);
// 如果 bean 还正在创建,还没创建完成,其实就是堆内存有了,属性还没有 DI 依赖注入
if (singletonObject == null && isSingletonCurrentlyInCreation(beanName)) {
// 从二级缓存中拿
singletonObject = this.earlySingletonObjects.get(beanName);
// 如果还拿不到,并且允许 bean 提前暴露
if (singletonObject == null && allowEarlyReference) {
synchronized (this.singletonObjects) {
// Consistent creation of early reference within full singleton lock
singletonObject = this.singletonObjects.get(beanName);
if (singletonObject == null) {
singletonObject = this.earlySingletonObjects.get(beanName);
if (singletonObject == null) {
// 从三级缓存中拿到对象工厂
ObjectFactory<?> singletonFactory = this.singletonFactories.get(beanName);
if (singletonFactory != null) {
// 从工厂中拿到对象
singletonObject = singletonFactory.getObject();
// 升级到二级缓存,earlySingletonObjects 和 singletonFactories 互斥
this.earlySingletonObjects.put(beanName, singletonObject);
// 从三级缓存删除
this.singletonFactories.remove(beanName);
}
}
}
}
}
}
return singletonObject;
}
2. getSingleton
此处是用 lambda 表达式实现的 ObjectFactory 接口,在 getSingleton 中会调用 singletonFactory.getObject(),从而调用到 createBean
@FunctionalInterface
public interface ObjectFactory<T> {
T getObject() throws BeansException;
}
DefaultSingletonBeanRegistry # getSingleton(java.lang.String, org.springframework.beans.factory.ObjectFactory<?>)
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
Assert.notNull(beanName, "Bean name must not be null");
// synchronized 说明单例对象可以按照顺序添加到 singletonObjects 中
synchronized (this.singletonObjects) {
// 首先检查对应的 bean 是否已经加载过,如果缓存中有,则直接返回
Object singletonObject = this.singletonObjects.get(beanName);
// 如果为空,才可以进行 singleton 的 bean 初始化
if (singletonObject == null) {
// 在这个单例正在销毁时,不允许单例的创建
if (this.singletonsCurrentlyInDestruction) {
throw new BeanCreationNotAllowedException(beanName,
"Singleton bean creation not allowed while 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 + "'");
}
// 通过 this.singletonsCurrentlyInCreation.add(beanName),将当前正要创建的 bean 记录到缓存 singletonsCurrentlyInCreation 中,这个集合里面的 bean 都是正在实例化的 bean,这样可以对循环依赖进行检测
beforeSingletonCreation(beanName);
boolean newSingleton = false;
boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
if (recordSuppressedExceptions) {
this.suppressedExceptions = new LinkedHashSet<>();
}
try {
// 真正创建 bean 的地方,调用 createBean
// 如果这里有返回值,就代表这个 bean 已经结束创建了,已经完全创建成功
singletonObject = singletonFactory.getObject();
newSingleton = true;
}
catch (IllegalStateException ex) {
// Has the singleton object implicitly appeared in the meantime ->
// if yes, proceed with it since the exception indicates that state.
singletonObject = this.singletonObjects.get(beanName);
if (singletonObject == null) {
throw ex;
}
}
catch (BeanCreationException ex) {
if (recordSuppressedExceptions) {
for (Exception suppressedException : this.suppressedExceptions) {
ex.addRelatedCause(suppressedException);
}
}
throw ex;
}
finally {
if (recordSuppressedExceptions) {
this.suppressedExceptions = null;
}
// 当 bean 创建结束后,移除 singletonsCurrentlyInCreation 缓存中对 bean 的正在创建状态的记录
afterSingletonCreation(beanName);
}
if (newSingleton) {
// 将创建的 bean 放到 singletonObjects 缓存中,并删除创建 bean 过程中的各种辅助状态(提早暴露的类名、提早暴露的单例工厂)
addSingleton(beanName, singletonObject);
}
}
return singletonObject;
}
}
AbstractAutowireCapableBeanFactory # createBean(java.lang.String, org.springframework.beans.factory.support.RootBeanDefinition, java.lang.Object[])
protected Object createBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args)
throws BeanCreationException {
if (logger.isTraceEnabled()) {
logger.trace("Creating instance of bean '" + beanName + "'");
}
RootBeanDefinition mbdToUse = mbd;
// Make sure bean class is actually resolved at this point, and
// clone the bean definition in case of a dynamically resolved Class
// which cannot be stored in the shared merged bean definition.
// 锁定 class,根据设置的 class 属性或者根据 className 来解析 Class
Class<?> resolvedClass = resolveBeanClass(mbd, beanName);
if (resolvedClass != null && !mbd.hasBeanClass() && mbd.getBeanClassName() != null) {
mbdToUse = new RootBeanDefinition(mbd);
mbdToUse.setBeanClass(resolvedClass);
}
// Prepare method overrides.
// 验证、准备 bean 中被覆盖的方法
try {
mbdToUse.prepareMethodOverrides();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(mbdToUse.getResourceDescription(),
beanName, "Validation of method overrides failed", ex);
}
try {
// Give BeanPostProcessors a chance to return a proxy instead of the target bean instance.
// 给 BeanPostProcessors 一个机会返回代理,代替真正的实例
Object bean = resolveBeforeInstantiation(beanName, mbdToUse);
if (bean != null) {
return bean;
}
}
catch (Throwable ex) {
throw new BeanCreationException(mbdToUse.getResourceDescription(), beanName,
"BeanPostProcessor before instantiation of bean failed", ex);
}
try {
// 实例化 Bean 的地方
Object beanInstance = doCreateBean(beanName, mbdToUse, args);
if (logger.isTraceEnabled()) {
logger.trace("Finished creating instance of bean '" + beanName + "'");
}
return beanInstance;
}
catch (BeanCreationException | ImplicitlyAppearedSingletonException ex) {
// A previously detected exception with proper bean creation context already,
// or illegal singleton state to be communicated up to DefaultSingletonBeanRegistry.
throw ex;
}
catch (Throwable ex) {
throw new BeanCreationException(
mbdToUse.getResourceDescription(), beanName, "Unexpected exception during bean creation", ex);
}
}
protected Object doCreateBean(String beanName, RootBeanDefinition mbd, @Nullable Object[] args)
throws BeanCreationException {
// Instantiate the bean.
BeanWrapper instanceWrapper = null;
// 如果是 singleton,先把缓存中的同名 bean 清除
if (mbd.isSingleton()) {
instanceWrapper = this.factoryBeanInstanceCache.remove(beanName);
}
// 实例化 Bean 的地方,即调用 FactoryMethod 或构造函数的地方
if (instanceWrapper == null) {
// 根据指定的 bean 使用对应的策略创建新的实例,如:工厂方法、构造函数自动注入、简单初始化
// 见 ### 3
instanceWrapper = createBeanInstance(beanName, mbd, args);
}
Object bean = instanceWrapper.getWrappedInstance();
// 获取实例化对象的类型
Class<?> beanType = instanceWrapper.getWrappedClass();
if (beanType != NullBean.class) {
mbd.resolvedTargetType = beanType;
}
synchronized (mbd.postProcessingLock) {
if (!mbd.postProcessed) {
try {
/**
* 调用 MergedBeanDefinitionPostProcessor.postProcessMergedBeanDefinition,其中 CommonAnnotationBeanPostProcessor、AutowiredAnnotationBeanPostProcessor 是 MergedBeanDefinitionPostProcessor 的子类实现
* CommonAnnotationBeanPostProcessor 自身收集 @Resource,同时继承 InitDestroyAnnotationBeanPostProcessor,收集 @PostConstruct、@PreDestroy 注解
* AutowiredAnnotationBeanPostProcessor 收集 @Autowired、@Value 注解
* 收集的注解包装成 InjectionMetadata,放到 injectionMetadataCache 中
*/
applyMergedBeanDefinitionPostProcessors(mbd, beanType, beanName);
}
catch (Throwable ex) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Post-processing of merged bean definition failed", ex);
}
mbd.postProcessed = true;
}
}
// Eagerly cache singletons to be able to resolve circular references
// even when triggered by lifecycle interfaces like BeanFactoryAware.
// 是否需要提早曝光:单例 & 允许循环依赖 & 当前 bean 正在创建中
boolean earlySingletonExposure = (mbd.isSingleton() && this.allowCircularReferences &&
isSingletonCurrentlyInCreation(beanName));
if (earlySingletonExposure) {
if (logger.isTraceEnabled()) {
logger.trace("Eagerly caching bean '" + beanName +
"' to allow for resolving potential circular references");
}
// 为避免后期循环依赖,可以在 bean 初始化完成前将创建实例的 ObjectFactory 加入工厂
// getEarlyBeanReference:对 bean 再一次依赖引用,主要应用 SmartInstantiationAwareBeanPostProcessor,其中 AOP 就是在这里将
// advice 动态织入 bean 中,若没有则直接返回 bean,不做任何处理
addSingletonFactory(beanName, () -> getEarlyBeanReference(beanName, mbd, bean));
}
// bean 属性依赖注入、初始化方法的调用
// exposedObject 在初始化处理完成后会返回依赖注入完成后的 bean
// 见 ### 5
Object exposedObject = bean;
try {
// 主要完成 Bean 中属性的依赖注入,包括 @Autowired、<bean><property name="username" value="Jack"/></bean> 2 种方式
populateBean(beanName, mbd, instanceWrapper);
// 完成 Aware 接口的调用、Bean 的初始化方法的调用(@PostConstruct、afterPropertiesSet、XML 中 init-method 方法)
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) {
// 获取指定名称的已注册的且提早暴露的单例模式 bean 实例
Object earlySingletonReference = getSingleton(beanName, false);
// earlySingletonReference 只有在检测到有循环依赖情况下才会不为空
if (earlySingletonReference != null) {
// 如果 exposedObject 没有在初始化方法中被改变,也就是没有被增强,直接将提早暴露的 earlySingletonReference 赋值给 exposedObject
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);
}
}
// 因为 bean 创建后其所依赖的 bean 一定是已经创建的,actualDependentBeans 不为空,
// 表示当前 bean 创建后其依赖的 bean 没有全部要创建完,也就是存在循环依赖
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 " +
"'getBeanNamesForType' with the 'allowEagerInit' flag turned off, for example.");
}
}
}
}
// Register bean as disposable.
try {
// 根据 scope 注册 bean
registerDisposableBeanIfNecessary(beanName, bean, mbd);
}
catch (BeanDefinitionValidationException ex) {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Invalid destruction signature", ex);
}
return exposedObject;
}
3:创建 Bean 的不同策略:工厂方法、Bean 的构造函数
实例化方式有:
- Bean 中有 factoryMethod 方法
- Bean 中有 @Autowired 注解的有参构造函数,如果有多个这种构造函数的话,需要 required = false,否则会报错,在 required = false时,Spring 会排序,选择排序后的第一个构造函数
- Bean 中只有有参构造函数,且无 @Autowired,如果有多个这种构造函数的话,且没有无参构造函数时,会报错
- Bean 中只有无参构造函数
AbstractAutowireCapableBeanFactory # createBeanInstance
protected BeanWrapper createBeanInstance(String beanName, RootBeanDefinition mbd, @Nullable Object[] args) {
// Make sure bean class is actually resolved at this point.
// 解析 class
Class<?> beanClass = resolveBeanClass(mbd, beanName);
if (beanClass != null && !Modifier.isPublic(beanClass.getModifiers()) && !mbd.isNonPublicAccessAllowed()) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Bean class isn't public, and non-public access not allowed: " + beanClass.getName());
}
Supplier<?> instanceSupplier = mbd.getInstanceSupplier();
if (instanceSupplier != null) {
return obtainFromSupplier(instanceSupplier, beanName);
}
// 如果工厂方法不为空,则使用工厂方法初始化策略,有 FactoryMethodName 属性、@Bean
if (mbd.getFactoryMethodName() != null) {
return instantiateUsingFactoryMethod(beanName, mbd, args);
}
// Shortcut when re-creating the same bean...
boolean resolved = false;
boolean autowireNecessary = false;
if (args == null) {
synchronized (mbd.constructorArgumentLock) {
// 一个类有多个构造函数,每个构造函数都有不同的参数,所以调用前需要先根据参数锁定构造函数、对应的工厂方法
if (mbd.resolvedConstructorOrFactoryMethod != null) {
resolved = true;
autowireNecessary = mbd.constructorArgumentsResolved;
}
}
}
// 如果已经解析过,则使用解析好的构造函数方法不需要再次锁定
if (resolved) {
if (autowireNecessary) {
// 构造函数自动注入
return autowireConstructor(beanName, mbd, null, null);
}
else {
// 使用默认构造函数构造,不带参数的
return instantiateBean(beanName, mbd);
}
}
// Candidate constructors for autowiring?
// 寻找当前正在实例化的 bean 中有 @Autowired 注解的构造函数
Constructor<?>[] ctors = determineConstructorsFromBeanPostProcessors(beanClass, beanName);
if (ctors != null || mbd.getResolvedAutowireMode() == AUTOWIRE_CONSTRUCTOR ||
mbd.hasConstructorArgumentValues() || !ObjectUtils.isEmpty(args)) {
// 构造函数自动注入,如果 ctors 不为空,就说明构造函数上有 @Autowired 注解
return autowireConstructor(beanName, mbd, ctors, args);
}
// Preferred constructors for default construction?
ctors = mbd.getPreferredConstructors();
if (ctors != null) {
return autowireConstructor(beanName, mbd, ctors, null);
}
// 使用默认构造函数构造
return instantiateBean(beanName, mbd);
}
5. populateBean、initializeBean
AbstractAutowireCapableBeanFactory # populateBean
protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable BeanWrapper bw) {
if (bw == null) {
// 获取在 BeanDefinition 中设置的 property 的值
if (mbd.hasPropertyValues()) {
throw new BeanCreationException(
mbd.getResourceDescription(), beanName, "Cannot apply property values to null instance");
}
else {
// Skip property population phase for null instance.
// 没有任何属性可以填充,直接返回
return;
}
}
// Give any InstantiationAwareBeanPostProcessors the opportunity to modify the
// state of the bean before properties are set. This can be used, for example,
// to support styles of field injection.
// 这里可以控制哪些 Bean 能够对属性依赖注入,哪些不能
if (!mbd.isSynthetic() && hasInstantiationAwareBeanPostProcessors()) {
for (InstantiationAwareBeanPostProcessor bp : getBeanPostProcessorCache().instantiationAware) {
if (!bp.postProcessAfterInstantiation(bw.getWrappedInstance(), beanName)) {
return;
}
}
}
PropertyValues pvs = (mbd.hasPropertyValues() ? mbd.getPropertyValues() : null);
int resolvedAutowireMode = mbd.getResolvedAutowireMode();
// 根据注入类型(byName、byType),提取依赖的 bean,并统一存入 PropertyValues 中
if (resolvedAutowireMode == AUTOWIRE_BY_NAME || resolvedAutowireMode == AUTOWIRE_BY_TYPE) {
MutablePropertyValues newPvs = new MutablePropertyValues(pvs);
// Add property values based on autowire by name if applicable.
// 根据 Bean 名称自动装配注入
if (resolvedAutowireMode == AUTOWIRE_BY_NAME) {
autowireByName(beanName, mbd, bw, newPvs);
}
// Add property values based on autowire by type if applicable.
// 根据 Bean 类型自动装配注入
if (resolvedAutowireMode == AUTOWIRE_BY_TYPE) {
autowireByType(beanName, mbd, bw, newPvs);
}
pvs = newPvs;
}
// 检查容器是否持有 InstantiationAwareBeanPostProcessors 实例化后置处理器,InstantiationAwareBeanPostProcessors 早在 registerBeanPostProcessors() 中已经初始化
boolean hasInstAwareBpps = hasInstantiationAwareBeanPostProcessors();
// 是否需要依赖检查
boolean needsDepCheck = (mbd.getDependencyCheck() != AbstractBeanDefinition.DEPENDENCY_CHECK_NONE);
PropertyDescriptor[] filteredPds = null;
if (hasInstAwareBpps) {
if (pvs == null) {
pvs = mbd.getPropertyValues();
}
for (InstantiationAwareBeanPostProcessor bp : getBeanPostProcessorCache().instantiationAware) {
// 对 @Autowired 进行依赖注入
PropertyValues pvsToUse = bp.postProcessProperties(pvs, bw.getWrappedInstance(), beanName);
if (pvsToUse == null) {
if (filteredPds == null) {
// 从实例对象中提取属性描述符
filteredPds = filterPropertyDescriptorsForDependencyCheck(bw, mbd.allowCaching);
}
// 之前 Spring 版本对 @Autowired 进行依赖注入
pvsToUse = bp.postProcessPropertyValues(pvs, filteredPds, bw.getWrappedInstance(), beanName);
if (pvsToUse == null) {
return;
}
}
pvs = pvsToUse;
}
}
if (needsDepCheck) {
if (filteredPds == null) {
filteredPds = filterPropertyDescriptorsForDependencyCheck(bw, mbd.allowCaching);
}
checkDependencies(beanName, mbd, filteredPds, pvs);
}
if (pvs != null) {
// 对 xml 中 <property name="username" value="Jack"/> 进行依赖注入
applyPropertyValues(beanName, mbd, bw, pvs);
}
}
initializeBean 中关于 Bean 的初始化方法,调用顺序为:
- @PostConstruct
- InitializingBean.afterPropertiesSet
- XML 中配置的 init-method
AbstractAutowireCapableBeanFactory # initializeBean(java.lang.String, java.lang.Object, org.springframework.beans.factory.support.RootBeanDefinition)
protected Object initializeBean(String beanName, Object bean, @Nullable RootBeanDefinition mbd) {
if (System.getSecurityManager() != null) {// JDK 的安全机制验证权限
AccessController.doPrivileged((PrivilegedAction<Object>) () -> {
invokeAwareMethods(beanName, bean);
return null;
}, getAccessControlContext());
}
else {
// 一个 Bean implements Aware 接口,其实现的 Aware 接口中的方法在这里调用:BeanNameAware、BeanClassLoaderAware、BeanFactoryAware
invokeAwareMethods(beanName, bean);
}
Object wrappedBean = bean;
if (mbd == null || !mbd.isSynthetic()) {
// 调用 BeanPostProcessor.postProcessBeforeInitialization,是 before
// 其中 Bean 初始化中的 @PostConstruct 是在这里调用
wrappedBean = applyBeanPostProcessorsBeforeInitialization(wrappedBean, beanName);
}
try {
// 调用 InitializingBean.afterPropertiesSet()
// 调用 XML 中配置的 init-method
invokeInitMethods(beanName, wrappedBean, mbd);
}
catch (Throwable ex) {
throw new BeanCreationException(
(mbd != null ? mbd.getResourceDescription() : null),
beanName, "Invocation of init method failed", ex);
}
if (mbd == null || !mbd.isSynthetic()) {
// 调用 BeanPostProcessor.postProcessAfterInitialization(),是 after
wrappedBean = applyBeanPostProcessorsAfterInitialization(wrappedBean, beanName);
}
return wrappedBean;
}