还以为要写好几篇,没想到两篇就结束了。毕竟是简单分析 。spring mvc源码分析虽然也想尝试但是没有多余的时间了,所以就先这样吧。
本篇的主要内容:从finishBeanFactoryInitialization(ConfigurableListableBeanFactory beanFactory)
方法debug到getSingleton
方法
由于学艺不精,如果出了一些差错,还望见谅。
简单描述本篇博客要做的事,分四步 :
-
打上第四个断点:
beanFactory.preInstantiateSingletons();
-
打上第五个断点:
doGetBean(name, null, null, false);
-
打上第六个断点:
getSingleton(beanName, new ObjectFactory<Object>());
-
打上第七个断点:
singletonObject = singletonFactory.getObject();
结论:
1. DefaultSingletonBeanRegistry
类中的singletonFactory.getObject();
方法才是真正创建单实例bean的地方。
2. 创建好的单实例bean最终会保存到DefaultSingletonBeanRegistry
类中singletonObjects
这个map中。
开始debug调试(逐层分析第4-7断点)
进入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.
// 如果没有bean后处理器,注册一个默认的嵌入式值解析器
if (!beanFactory.hasEmbeddedValueResolver()) {
beanFactory.addEmbeddedValueResolver(new StringValueResolver() {
@Override
public String resolveStringValue(String strVal) {
return getEnvironment().resolvePlaceholders(strVal);
}
});
}
// Initialize LoadTimeWeaverAware beans early to allow for registering their transformers early.
// 尽早初始化autoaware 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);
// Allow for caching all bean definition metadata, not expecting further changes.
// 冻结配置
beanFactory.freezeConfiguration();
// Instantiate all remaining (non-lazy-init) singletons.
// 初始化所有单实例bean
beanFactory.preInstantiateSingletons();
}
一遍Step Over,一边观察注释和控制台,在执行完beanFactory.preInstantiateSingletons();
方法后,可以观察到控制台打印构造器里的输出语句。
给该方法打上断点,重新debug。通过Resume执行到该断点后,点击step into进入该方法。
在DefaultListableBeanFactory
类中的preInstantiateSingletons()
方法:
@Override
public void preInstantiateSingletons() throws BeansException {
// 日志
if (this.logger.isDebugEnabled()) {
this.logger.debug("Pre-instantiating singletons in " + this);
}
// Iterate over a copy to allow for init methods which in turn register new bean definitions.
// While this may not be part of the regular factory bootstrap, it does otherwise work fine.
// 拿到所有要创建bean的名
List<String> beanNames = new ArrayList<String>(this.beanDefinitionNames);
// Trigger initialization of all non-lazy singleton beans...
// 按照顺序创建bean
for (String beanName : beanNames) {
// 根据beanid拿到bean对应的定义信息
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
// 判断这个bean不是抽象的并且是单实例并且不是懒加载
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
// 判断是否实现factory接口
if (isFactoryBean(beanName)) {
final FactoryBean<?> factory = (FactoryBean<?>) getBean(FACTORY_BEAN_PREFIX + beanName);
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) {
getBean(beanName);
}
}
else {
// 根据bean名初始化bean
getBean(beanName);
}
}
}
// Trigger post-initialization callback for all applicable beans...
for (String beanName : beanNames) {
Object singletonInstance = getSingleton(beanName);
if (singletonInstance instanceof SmartInitializingSingleton) {
final SmartInitializingSingleton smartSingleton = (SmartInitializingSingleton) singletonInstance;
if (System.getSecurityManager() != null) {
AccessController.doPrivileged(new PrivilegedAction<Object>() {
@Override
public Object run() {
smartSingleton.afterSingletonsInstantiated();
return null;
}
}, getAccessControlContext());
}
else {
smartSingleton.afterSingletonsInstantiated();
}
}
}
}
一遍Step Over,一边观察注释和控制台,在执行到List<String> beanNames = new ArrayList<String>(this.beanDefinitionNames);
语句时,鼠标放在beanDefinitionNames
上可以看到所有bean的名字。
继续Step Over,进入第一个大增强for循环,在第一行语句:RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
,根据方法名初步判断该语句是根据bean名拿到bean的定义信息并赋值给bd。继续Step Over执行完RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
,鼠标放在bd上,可以看到确实bd包含了person01的所有定义信息。
来到第一个if判断if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit())
,通过方法名可判断出,这个if条件判断是判断这个bean不是抽象的并且是单实例的并且不是懒加载的,由于我们配置的person bean只是一个普通的java bean,并且默认是单实例、默认不懒加载的,所以可以进入这个if语句。继续Step Over。
来到第二个if判断if (isFactoryBean(beanName))
,通过方法名可以判断这个方法是根据bean名检测该bean是否是FactoryBean,即实现了FactoryBean接口。我们的bean很明显并没有实现FactoryBean接口,所以这个方法返回false。继续Step Over。
可以看到,进入分支else语句中。可以看到有一个getBean(beanName);
方法。继续Step Over,并仔细观察控制台。
可以看到,在执行完getBean(beanName);
方法后,控制台打印了构造器被调用。给该方法打上断点,并点击Resume,观察到每执行一次getBean(beanName);
方法,构造器每打印一次,即每初始化一个bean。执行完剩下的部分后,再重新debug,通过Resume执行到该断点后,点击step into进入该方法。
来到AbstractBeanFactory
类中getBean(String name)
的方法:
@Override
public Object getBean(String name) throws BeansException {
// 所有的getBean,调用的是它
return doGetBean(name, null, null, false);
}
发现所有的getBean
方法,其实都是在调用doGetBean
方法:
点击step into进入该方法。来到AbstractBeanFactory
类中doGetBean(String name)
的方法:
@SuppressWarnings("unchecked")
protected <T> T doGetBean(
final String name, final Class<T> requiredType, final Object[] args, boolean typeCheckOnly)
throws BeansException {
// 拿到bean名字
final String beanName = transformedBeanName(name);
Object bean;
// Eagerly check singleton cache for manually registered singletons.
// 从已经注册的单实例bean缓存里检查,第一次创建是没有的
Object sharedInstance = getSingleton(beanName);
if (sharedInstance != null && args == null) {
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 + "'");
}
}
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
}
else {
// Fail if we're already creating this bean instance:
// We're assumably within a circular reference.
// 从Prototype检查?(不重要)
if (isPrototypeCurrentlyInCreation(beanName)) {
throw new BeanCurrentlyInCreationException(beanName);
}
// Check if bean definition exists in this factory.
// 检查此工厂中是否存在该bean的定义。
BeanFactory parentBeanFactory = getParentBeanFactory();
if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
// Not found -> check parent.
String nameToLookup = originalBeanName(name);
if (args != null) {
// Delegation to parent with explicit args.
return (T) parentBeanFactory.getBean(nameToLookup, args);
}
else {
// No args -> delegate to standard getBean method.
return parentBeanFactory.getBean(nameToLookup, requiredType);
}
}
if (!typeCheckOnly) {
// 标记bean已经创建
markBeanAsCreated(beanName);
}
try {
// 获取到当前bean的定义信息
final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
checkMergedBeanDefinition(mbd, beanName, args);
// Guarantee initialization of beans that the current bean depends on.
// 拿到创建当前bean之前需要创建bean的信息,即xml中depend-on属性,如果有就循环创建
String[] dependsOn = mbd.getDependsOn();
if (dependsOn != null) {
for (String dependsOnBean : dependsOn) {
if (isDependent(beanName, dependsOnBean)) {
throw new BeanCreationException(mbd.getResourceDescription(), beanName,
"Circular depends-on relationship between '" + beanName + "' and '" + dependsOnBean + "'");
}
registerDependentBean(dependsOnBean, beanName);
getBean(dependsOnBean);
}
}
// Create bean instance.
if (mbd.isSingleton()) {
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
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.
destroySingleton(beanName);
throw ex;
}
}
});
bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}
else if (mbd.isPrototype()) {
// It's a prototype -> create a new instance.
Object prototypeInstance = null;
try {
beforePrototypeCreation(beanName);
prototypeInstance = createBean(beanName, mbd, args);
}
finally {
afterPrototypeCreation(beanName);
}
bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
}
else {
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 {
Object scopedInstance = scope.get(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
beforePrototypeCreation(beanName);
try {
return createBean(beanName, mbd, args);
}
finally {
afterPrototypeCreation(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) {
cleanupAfterBeanCreationFailure(beanName);
throw ex;
}
}
// Check if required type matches the type of the actual bean instance.
if (requiredType != null && bean != null && !requiredType.isAssignableFrom(bean.getClass())) {
try {
return getTypeConverter().convertIfNecessary(bean, requiredType);
}
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;
}
第一条语句final String beanName = transformedBeanName(name);
,拿到bean名字。继续Step Over,来到Object sharedInstance = getSingleton(beanName);
方法,根据注释可以判断该方法是从缓存的单实例bean中根据bean名拿到bean实例。来到if (sharedInstance != null && args == null)
语句,因为是一次创建personbean,所以缓存中没有,表达式结果为false,进入else分支语句。
继续Step Over,仔细观察控制台和阅读注释及方法名,在执行完BeanFactory parentBeanFactory = getParentBeanFactory();
语句后,发现parentBeanFactory 值为null,所以不进入下面的if分支。
来到下一个if判断,由于调用doGetBean(name, null, null, false);
方法传过来的typeCheckOnly
值是false,所以进入该if语句执行方法markBeanAsCreated(beanName);
,从方法名可以判断出这个方法是用来标记bean已经创建的。继续Step Over,观察到控制台并没有打印任何信息。
来到final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
,从方法名可以看出该语句是根据bean名字获取bean的定义信息并赋值给mbd。点击Step Over,执行完该语句后,观察mbd的值:
继续Step Over,来到String[] dependsOn = mbd.getDependsOn();
语句。从注释和方法名可以判断这个方法是拿到创建当前bean之前需要创建bean的信息,即xml中depend-on属性,而这条语句下面的增强for循环则是如果有就循环创建。继续Step Over。
来到if (mbd.isSingleton())-else if (mbd.isPrototype())-else
语句,根据注释可以得到:这段分支语句就是真正用来创建bean的地方。继续Step Over。因为bean是单实例的,进入if (mbd.isSingleton())
语句。来到sharedInstance = getSingleton(beanName, new ObjectFactory<Object>(){......}
:
sharedInstance = getSingleton(beanName, new ObjectFactory<Object>() {
@Override
public Object getObject() throws BeansException {
try {
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.
destroySingleton(beanName);
throw ex;
}
}
});
不断的Step Into和Step Return进入该方法,来到,DefaultSingletonBeanRegistry
类中的getSingleton()
方法:
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
Assert.notNull(beanName, "'beanName' must not be null");
synchronized (this.singletonObjects) {
// 从singletonObjects根据beanName获取这个单实例bean
Object singletonObject = this.singletonObjects.get(beanName);
if (singletonObject == null) {
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 newSingleton = false;
boolean recordSuppressedExceptions = (this.suppressedExceptions == null);
if (recordSuppressedExceptions) {
this.suppressedExceptions = new LinkedHashSet<Exception>();
}
try {
// 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创建
afterSingletonCreation(beanName);
}
if (newSingleton) {
addSingleton(beanName, singletonObject);
}
}
return (singletonObject != NULL_OBJECT ? singletonObject : null);
}
}
观察整个方法,发现Object singletonObject = this.singletonObjects.get(beanName);
这条语句,应该是从this.singletonObject
中根据beanName获取这个bean对象。点击tthis.singletonObject
,发现这个singletonObjects其实是一个map。
/** Cache of singleton objects: bean name --> bean instance */
// 缓存所有的单实例对象,按照bean名字 --> bean实例
private final Map<String, Object> singletonObjects = new ConcurrentHashMap<String, Object>(256);
继续Step Over,由于是第一次创建,所以singletonObjects
是null,进入第一个if语句:
继续Step Over,并观察控制台,发现当执行singletonObject = singletonFactory.getObject();
后,控制台打印构造器被调用,查看singletonObjects
的属性:
所以,bean的真正初始化就是在调用singletonFactory.getObject();
方法时,完成的。
继续Step Over,但执行到if (newSingleton) {addSingleton(beanName, singletonObject);}
语句时,根据方法名可以得出这个方法是用来添加单实例bean的,Step Into这个方法。
在DefaultSingletonBeanRegistry
类中的addSingleton
方法:
protected void addSingleton(String beanName, Object singletonObject) {
synchronized (this.singletonObjects) {
// 这创建好的bean实例和bean名放在singletonObjects这个map中
this.singletonObjects.put(beanName, (singletonObject != null ? singletonObject : NULL_OBJECT));
this.singletonFactories.remove(beanName);
this.earlySingletonObjects.remove(beanName);
this.registeredSingletons.add(beanName);
}
}
继续Step Over,在执行完this.singletonObjects.put(beanName, (singletonObject != null ? singletonObject : NULL_OBJECT));
,点开singletonObjects,发现里面确实有了新创建的person01。
最后可以得出一个结论:所以创建好的单实例bean最终会保存到DefaultSingletonBeanRegistry
类中singletonObjects
这个map中。
最近有点虚,总结就先这么写了,后面会画出一整个流程图方便理解的~