【Spring】Bean：不同作用域原理

以你之姓@ 2022-10-31 05:25 118阅读 0赞

## 五种作用域 ##

![在这里插入图片描述][20210222002612569.png]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNDYwNw_size_16_color_FFFFFF_t_70][]

## 源码 doGetBean ##

@SuppressWarnings("unchecked")
    	// 真正实现向IOC容器获取Bean的功能，也是触发依赖注入功能的地方
    	protected <T> T doGetBean(final String name, @Nullable final Class<T> requiredType,
    			@Nullable final Object[] args, boolean typeCheckOnly) throws BeansException { 
    
    		// 根据指定的名称获取被管理Bean的名称，剥离指定名称中对容器的相关依赖
    		// 如果指定的是别名，将别名转换为规范的Bean名称
    		final String beanName = transformedBeanName(name);
    		Object bean;
    
    		// Eagerly check singleton cache for manually registered singletons.
    		// 先从缓存中取是否已经有被创建过的单态类型的Bean
    		// 对于单例模式的Bean整个IOC容器中只创建一次，不需要重复创建
    		Object sharedInstance = getSingleton(beanName);
    		// IOC容器创建单例模式Bean实例对象
    		if (sharedInstance != null && args == null) { 
    			if (logger.isDebugEnabled()) { 
    				// 如果指定名称的Bean在容器中已有单例模式的Bean被创建直接返回已经创建的Bean
    				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的实例对象，主要是完成FactoryBean的相关处理
    			// 注意：BeanFactory是管理容器中Bean的工厂，而FactoryBean是创建创建对象的工厂Bean，两者之间有区别
    			bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
    		}
    
    		else { 
    			// Fail if we're already creating this bean instance:
    			// We're assumably within a circular reference.
    			// 缓存没有正在创建的单例模式Bean
    			// 缓存中已经有已经创建的原型模式Bean，但是由于循环引用的问题导致实例化对象失败
    			if (isPrototypeCurrentlyInCreation(beanName)) { 
    				throw new BeanCurrentlyInCreationException(beanName);
    			}
    
    			// Check if bean definition exists in this factory.
    			// 对IOC容器中是否存在指定名称的BeanDefinition进行检查
    			// 首先检查是否能在当前的BeanFactory中获取的所需要的Bean，如果不能则委托当前容器的父级容器去查找
    			// 如果还是找不到则沿着容器的继承体系向父级容器查找
    			BeanFactory parentBeanFactory = getParentBeanFactory();
    			// 当前容器的父级容器存在，且当前容器中不存在指定名称的Bean
    			if (parentBeanFactory != null && !containsBeanDefinition(beanName)) { 
    				// Not found -> check parent.
    				// 解析指定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 { 
    					// No args -> delegate to standard getBean method.
    					// 委派父级容器根据指定名称和类型查找
    					return parentBeanFactory.getBean(nameToLookup, requiredType);
    				}
    			}
    
    			// 创建的Bean是否需要进行类型验证，一般不需要
    			if (!typeCheckOnly) { 
    				// 向容器标记指定的Bean已经被创建
    				markBeanAsCreated(beanName);
    			}
    
    			try { 
    				// 根据指定Bean名称获取其父级的Bean定义。主要解决Bean继承时子类合并父类公共属性问题
    				final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
    				checkMergedBeanDefinition(mbd, beanName, args);
    
    				// Guarantee initialization of beans that the current bean depends on.
    				// 获取当前Bean所有依赖Bean的名称
    				String[] dependsOn = mbd.getDependsOn();
    				// 如果当前Bean有依赖Bean
    				if (dependsOn != null) { 
    					for (String dep : dependsOn) { 
    						if (isDependent(beanName, dep)) { 
    							throw new BeanCreationException(mbd.getResourceDescription(), beanName,
    									"Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
    						}
    						// 递归调用getBean方法，获取当前Bean的依赖Bean
    						registerDependentBean(dep, beanName);
    						// 把被依赖Bean注册给当前依赖的Bean
    						getBean(dep);
    					}
    				}
    
    				// Create bean instance.
    				// 创建单例模式Bean的实例对象
    				if (mbd.isSingleton()) { 
    					// 这里使用了一个匿名内部类，创建Bean实例对象，并且注册给所依赖的对象
    					sharedInstance = getSingleton(beanName, () -> { 
    						try { 
    							// 创建一个指定Bean实例对象，如果有父级继承，则合并子类和父类的定义
    							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);
    				}
    
    				// IOC容器创建原型模式Bean实例对象
    				else if (mbd.isPrototype()) { 
    					// It's a prototype -> create a new instance.
    					// 原型模式(Prototype)是每次都会创建一个新的对象
    					Object prototypeInstance = null;
    					try { 
    						// 回调beforePrototypeCreation方法，默认的功能是注册当前创建的原型对象
    						beforePrototypeCreation(beanName);
    						// 创建指定Bean对象实例
    						prototypeInstance = createBean(beanName, mbd, args);
    					}
    					finally { 
    						// 回调afterPrototypeCreation方法，默认的功能告诉IOC容器指定Bean的原型对象不再创建
    						afterPrototypeCreation(beanName);
    					}
    					// 获取给定Bean的实例对象
    					bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
    				}
    
    				// 要创建的Bean既不是单例模式，也不是原型模式，则根据Bean定义资源中配置的生命周期范围，选择实例化Bean的合适方法
    				// 这种在Web应用程序中比较常用，如：request、session、application等生命周期
    				else { 
    					String scopeName = mbd.getScope();
    					final Scope scope = this.scopes.get(scopeName);
    					// Bean定义资源中没有配置生命周期范围，则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 BeanCreationException(beanName,
    								"Scope '" + scopeName + "' is not active for the current thread; consider " 
    						+ "defining a scoped proxy for this bean if you intend to referto it from a singleton",
    								ex);
    					}
    				}
    			}
    			catch (BeansException ex) { 
    				cleanupAfterBeanCreationFailure(beanName);
    				throw ex;
    			}
    		}
    
    		// Check if required type matches the type of the actual bean instance.
    		// 对创建的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.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;
    	}

关于作用域核心的地方

// Create bean instance.
    				// 创建单例模式Bean的实例对象
    				if (mbd.isSingleton()) { 
    					// 这里使用了一个匿名内部类，创建Bean实例对象，并且注册给所依赖的对象
    					sharedInstance = getSingleton(beanName, () -> { 
    						try { 
    							// 创建一个指定Bean实例对象，如果有父级继承，则合并子类和父类的定义
    							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);
    				}
    
    				// IOC容器创建原型模式Bean实例对象
    				else if (mbd.isPrototype()) { 
    					// It's a prototype -> create a new instance.
    					// 原型模式(Prototype)是每次都会创建一个新的对象
    					Object prototypeInstance = null;
    					try { 
    						// 回调beforePrototypeCreation方法，默认的功能是注册当前创建的原型对象
    						beforePrototypeCreation(beanName);
    						// 创建指定Bean对象实例
    						prototypeInstance = createBean(beanName, mbd, args);
    					}
    					finally { 
    						// 回调afterPrototypeCreation方法，默认的功能告诉IOC容器指定Bean的原型对象不再创建
    						afterPrototypeCreation(beanName);
    					}
    					// 获取给定Bean的实例对象
    					bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
    				}
    
    				// 要创建的Bean既不是单例模式，也不是原型模式，则根据Bean定义资源中配置的生命周期范围，选择实例化Bean的合适方法
    				// 这种在Web应用程序中比较常用，如：request、session、application等生命周期
    				else { 
    					String scopeName = mbd.getScope();
    					final Scope scope = this.scopes.get(scopeName);
    					// Bean定义资源中没有配置生命周期范围，则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 BeanCreationException(beanName,
    								"Scope '" + scopeName + "' is not active for the current thread; consider " 
    						+ "defining a scoped proxy for this bean if you intend to referto it from a singleton",
    								ex);
    					}
    				}

## 总结 ##

如果非 web 环境的话就只有 singleton（默认） 和 prototype （多例）

对于 web 的话还有 request，session，golabSession

我们还可以实现 scope 接口自己定义作用域。

这么多种作用域，核心区别就在 doGetBean 方法里

*  对于任何一种模式，一进 doGetBean ，都会先去 singletonObjects 中获取单例 singleton ，但是除了 singleton 模式，其他模式肯定获取不到，因为放入 singletonObjects 是在 getSingleton 方法返回 null 并且 beandefition 中的模式是 singleton ，然后会调用 getSingleton 的重载方法（即 第二个参数是一个 ObjectFactory 对象，该对象只要有一个方法 getObject ，该对象的创建是通过 lamda 表达式实现的，里面就会调用 createBean，在这个重载的 getSingle 中调用 factory.getObject 后，会把返回的 beanInstance 用 addSingleton 方法放入 singletonObjects），而且在一开始的 getSingleton 方法里面，还有一个参数 allowEarlyReference，这个参数对于原型模式是 false 的，所以也不会再去查存放半成品 bean 的 earlySingletonObjects 和 singletonFactories，所以说原型模式碰见循环依赖是无法解决的。
 *  下面接着说，在判断完不是 beanDefition不是 singleton 之后会判断是否是 prototype，如果是的话就直接调用 createBean 然后返回
 *  如果也不是 prototype，那么就是其余模式，例如上面说的 request、session 这些，会从 beanDefiton 获得 scopeName ，然后从 socpes 中拿到 scopeName 对应的 Socpe 对象，然后调用该 Socpe 对象的 get 方法（其第一个参数是 beanName ， 第二个参数于是 objectFactory 对象，即只有一个 getObject 方法，然后对于 ObjectFacotry 的实现也是用 lamda ，操作也是直接 return createBean）

[20210222002612569.png]: /images/20221024/47032505b342488384425fcb55c0343c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MzkzNDYwNw_size_16_color_FFFFFF_t_70]: /images/20221024/3e97f7f23f944229989d96dcc20dbb96.png