spring application 之 BeanFactory

时间 2019-11-17

标签 spring application beanfactory 栏目 Spring 繁體版

原文原文链接

org.springframework.core.AliasRegistry

给Bean取别名，能够用多个名称对应同一个Bean
默认实现:org.springframework.core.SimpleAliasRegistry
这个有个小技巧:
	/** Map from alias to canonical name */
	private final Map<String, String> aliasMap = new ConcurrentHashMap<>(16);
咱们知道一个Bean的名称能够有多个别名，这里把key看成别名，value看成bean的名称

org.springframework.beans.factory.support.BeanDefinitionRegistry

继承自:AliasRegistry
获取BeanDefinition，注册BeanDefinition
默认实现:org.springframework.beans.factory.support.SimpleBeanDefinitionRegistry
里面就一个Map:private final Map<String, BeanDefinition> beanDefinitionMap = new ConcurrentHashMap(64);

org.springframework.beans.factory.config.SingletonBeanRegistry

老接口：注册单例Bean的
默认实现:org.springframework.beans.factory.support.DefaultSingletonBeanRegistry
管理单例Bean的依赖，建立，销毁

org.springframework.beans.factory.support.DefaultSingletonBeanRegistry

//直接注册单例
public void registerSingleton(String beanName, Object singletonObject) throws IllegalStateException;

//建立完毕后，缓存到Map
protected void addSingleton(String beanName, Object singletonObject);

//解决单例循环依赖的问题，建立过程当中会将还未彻底初始化的Bean放入ObjectFactory中
protected void addSingletonFactory(String beanName, ObjectFactory<?> singletonFactory);

//获取单例Bean,解决循环依赖
protected Object getSingleton(String beanName, boolean allowEarlyReference);

//建立单例Bean时，会将Bean包装成ObjectFactory，调用该类进行获取
public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory);

org.springframework.beans.factory.support.FactoryBeanRegistrySupport

解决FatoryBean的问题

org.springframework.beans.factory.BeanFactory

获取Bean

org.springframework.beans.factory.HierarchicalBeanFactory

父BeanFactoryjava

org.springframework.beans.factory.config.ConfigurableBeanFactory

对BeanFactory进行配置
默认支持两种做用域:单例，原型 
void setBeanExpressionResolver(@Nullable BeanExpressionResolver resolver);
设置EL表达式，解析属性值  #{....}
void setConversionService(@Nullable ConversionService conversionService);
转换器
void addPropertyEditorRegistrar(PropertyEditorRegistrar registrar);
属性解析器
void registerCustomEditor(Class<?> requiredType, Class<? extends PropertyEditor> propertyEditorClass);
自定义属性解析，与上面的属性解析器是同一个东西

void setTypeConverter(TypeConverter typeConverter);
与ConversionService同一个东西

void addEmbeddedValueResolver(StringValueResolver valueResolver);
字符属性处理器，对字符进行加工

void addBeanPostProcessor(BeanPostProcessor beanPostProcessor);
Bean的后置处理器，在建立实例后

org.springframework.beans.factory.support.AbstractBeanFactory

主要是对ConfigurableBeanFactory的实现spring

protected <T> T doGetBean(final String name, @Nullable final Class<T> requiredType,
			@Nullable final Object[] args, boolean typeCheckOnly) throws BeansException {
		//转换beanName去掉前面的&,而且解决Bean的别名问题
		final String beanName = transformedBeanName(name);
		Object 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 + "'");
				}
			}
			//是获取FacotryBean,仍是获取FacotryBean中的Bean
			bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
		}

		else {
			// 原型模式，不容许循环依赖，缘由是没有缓该Bean
			if (isPrototypeCurrentlyInCreation(beanName)) {
				throw new BeanCurrentlyInCreationException(beanName);
			}

			// 从父BeanFactory中获取
			BeanFactory parentBeanFactory = getParentBeanFactory();
			if (parentBeanFactory != null && !containsBeanDefinition(beanName)) {
				// Not found -> check parent.
				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);
				}
			}
			//是否只进行类型检查，而不获取实例
			if (!typeCheckOnly) {
				//标记已被建立
				markBeanAsCreated(beanName);
			}

			try {
				//检查是否抽像Bean
				final RootBeanDefinition mbd = getMergedLocalBeanDefinition(beanName);
				checkMergedBeanDefinition(mbd, beanName, args);

				//获取该Bean所依赖的beanName,先初始化依赖Bean
				String[] dependsOn = mbd.getDependsOn();
				if (dependsOn != null) {
					for (String dep : dependsOn) {
						//经过DependOn设置的依赖，不容许循环依赖
						if (isDependent(beanName, dep)) {
							throw new BeanCreationException(mbd.getResourceDescription(), beanName,
									"Circular depends-on relationship between '" + beanName + "' and '" + dep + "'");
						}
						registerDependentBean(dep, beanName);
						try {
							getBean(dep);
						}
						catch (NoSuchBeanDefinitionException ex) {
							throw new BeanCreationException(mbd.getResourceDescription(), beanName,
									"'" + beanName + "' depends on missing bean '" + dep + "'", ex);
						}
					}
				}

				// Create bean instance.
				 if (mbd.isSingleton()) {
					sharedInstance = getSingleton(beanName, () -> {
						try {
							//调用AbstractAutowireCapableBeanFactory类建立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.
							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, () -> {
							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;
			}
		}

		//类型不匹配，进行转换
		if (requiredType != null && !requiredType.isInstance(bean)) {
			try {
			//先获取自定义的TypeConverter,没有就获取系统默认的
				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;
	}

org.springframework.beans.factory.config.AutowireCapableBeanFactory

固名思义：装配可用的Bean 包含建立，前置处理，后置处理，依赖Bean的解决数组

AbstractAutowireCapableBeanFactory.AbstractAutowireCapableBeanFactory

建立Bean的实现类缓存

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

		if (logger.isDebugEnabled()) {
			logger.debug("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<?> resolvedClass = resolveBeanClass(mbd, beanName);
		if (resolvedClass != null && !mbd.hasBeanClass() && mbd.getBeanClassName() != null) {
			mbdToUse = new RootBeanDefinition(mbd);
			mbdToUse.setBeanClass(resolvedClass);
		}

		// 是否须要lookup replacMethod
		try {
			mbdToUse.prepareMethodOverrides();
		}
		catch (BeanDefinitionValidationException ex) {
			throw new BeanDefinitionStoreException(mbdToUse.getResourceDescription(),
					beanName, "Validation of method overrides failed", ex);
		}

		try {
			// 是否能够经过后置处理器直接建立Bean
			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 {
			//建立
			Object beanInstance = doCreateBean(beanName, mbdToUse, args);
			if (logger.isDebugEnabled()) {
				logger.debug("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);
		}
	}

建立过程以下：不贴代码了app

1 可否经过后置处理器建立Bean,执行InstantiationAwareBeanPostProcessor.postProcessBeforeInstantiation方法，若是能够建立，执行后置初始化方法BeanPostProcessor.postProcessAfterInitialization
2 第一步若是返回不为空的Bean,结束建立过程。不然进入流程3。
3 BeanDefinition中是否有instanceSupplier，若是有经过该函数建立Bean。并返回Bean的包装类BeanWrapper，进入流程8。不然进入流程4。
4 BeanDifinition中是否含有facotryMethod。若是有，经过工厂方法建立，该方法支持参数,instantiateUsingFactoryMethod(beanName, mbd, args)，进入流程8。若是无，进入流程5。
5 获取Bean的构造器，经过SmartInstantiationAwareBeanPostProcessor.determineCandidateConstructors,这里没有也关系，有的话就用这些指定的构造器。若是构造器不为空，或者BeanDifinition须要经过构造器注入，或者建立Bean传递的参数不空，则进入流程6，有参建立实例，不然进行流程7，无参建立实例。
6 配置合适的构造器与参数，若是含有MethodOverride（LookupOverrideMethodInterceptor，ReplaceOverrideMethodInterceptor）。则采用cglib建立实例，由于须要代理，不然直接建立对象。
7 若是含有MethodOverride（LookupOverrideMethodInterceptor，ReplaceOverrideMethodInterceptor）。则采用cglib建立实例，由于须要代理，不然直接建立对象。
8 合并BeanDinition，若是须要。MergedBeanDefinitionPostProcessor.postProcessMergedBeanDefinition。进入流程9。
9 set注入，循环依赖解决。暴露一个已经建立好的对象，未设置属性与执行初始化。这里若是有SmartInstantiationAwareBeanPostProcessor.getEarlyBeanReference(exposedObject, beanName);能够进一步加工。进入流程10。
10 执行后置处理器:InstantiationAwareBeanPostProcessor..postProcessAfterInstantiation(bw.getWrappedInstance(), beanName)，进入流程11。
11 若是是byName或byType的注入方式。经过PropertyDescripter获取Bean，将这些属性设置到BeanDifintion的PropertyValues中。进入流程12。
12 执行后置处理器,InstantiationAwareBeanPostProcessor.postProcessPropertyValues。该处理器主要解决属性注入的问题。
13 设置属性，进入流程14。
14 注入BeanNameAware,BeanClassLoaderAware,BeanFactoryAware。进入流程15。
15 执行后置处理器，BeanPostProcessor.postProcessBeforeInitialization(result, beanName);postDestruct()就是在这里处理的。进入流程16。
16 执行初始化方法。若是有实现InitializingBean接口，就执行afterPropertiesSet（）方法。进入流程17。
17 执行后置处理器,BeanPostProcessor.postProcessAfterInitialization。进入流程18
18 注册销毁Bean的方法，包括destroy,close,shutdown方法，只会注册一个，优先级依次下降。只有单例模式会注册，其它须要从scope中注册。结束流程。

org.springframework.beans.factory.ListableBeanFactory

BeanFactory的补充接口，都是一些获取Bean的扩展方法。ide

org.springframework.beans.factory.config.ConfigurableListableBeanFactory

辅助接口函数

org.springframework.beans.factory.support.DefaultListableBeanFactory

BeanFactory的最终实现类，核心方法 resolveDependency,Bean里面的属性注入，就是靠该方法来生成具体的Bean的。post

public Object resolveDependency(DependencyDescriptor descriptor, @Nullable String requestingBeanName,
			@Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException {

		descriptor.initParameterNameDiscovery(getParameterNameDiscoverer());
		//支持jdk8 Optional
		if (Optional.class == descriptor.getDependencyType()) {
			return createOptionalDependency(descriptor, requestingBeanName);
		}
		//支持ObjectFactory,ObjectProvider
		else if (ObjectFactory.class == descriptor.getDependencyType() ||
				ObjectProvider.class == descriptor.getDependencyType()) {
			return new DependencyObjectProvider(descriptor, requestingBeanName);
		}
		else if (javaxInjectProviderClass == descriptor.getDependencyType()) {
			return new Jsr330ProviderFactory().createDependencyProvider(descriptor, requestingBeanName);
		}
		else {
		//支持懒加载
			Object result = getAutowireCandidateResolver().getLazyResolutionProxyIfNecessary(
					descriptor, requestingBeanName);
			//获取具体的Bean的实现方法
			if (result == null) {
				result = doResolveDependency(descriptor, requestingBeanName, autowiredBeanNames, typeConverter);
			}
			return result;
		}
	}


@Nullable
	public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable String beanName,
			@Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException {

		InjectionPoint previousInjectionPoint = ConstructorResolver.setCurrentInjectionPoint(descriptor);
		try {
			Object shortcut = descriptor.resolveShortcut(this);
			if (shortcut != null) {
				return shortcut;
			}

			Class<?> type = descriptor.getDependencyType();
			//搞定@Value 注解
			Object value = getAutowireCandidateResolver().getSuggestedValue(descriptor);
			if (value != null) {
				if (value instanceof String) {
					String strVal = resolveEmbeddedValue((String) value);
					BeanDefinition bd = (beanName != null && containsBean(beanName) ? getMergedBeanDefinition(beanName) : null);
					value = evaluateBeanDefinitionString(strVal, bd);
				}
				TypeConverter converter = (typeConverter != null ? typeConverter : getTypeConverter());
				return (descriptor.getField() != null ?
						converter.convertIfNecessary(value, type, descriptor.getField()) :
						converter.convertIfNecessary(value, type, descriptor.getMethodParameter()));
			}
			//搞定属性是数组，Map,List等类型的注入
			Object multipleBeans = resolveMultipleBeans(descriptor, beanName, autowiredBeanNames, typeConverter);
			if (multipleBeans != null) {
				return multipleBeans;
			}
			//存在多个符合要求的类型的解决
			Map<String, Object> matchingBeans = findAutowireCandidates(beanName, type, descriptor);
			if (matchingBeans.isEmpty()) {
				if (isRequired(descriptor)) {
					raiseNoMatchingBeanFound(type, descriptor.getResolvableType(), descriptor);
				}
				return null;
			}

			String autowiredBeanName;
			Object instanceCandidate;

			if (matchingBeans.size() > 1) {
				autowiredBeanName = determineAutowireCandidate(matchingBeans, descriptor);
				if (autowiredBeanName == null) {
					if (isRequired(descriptor) || !indicatesMultipleBeans(type)) {
						return descriptor.resolveNotUnique(type, matchingBeans);
					}
					else {
						// In case of an optional Collection/Map, silently ignore a non-unique case:
						// possibly it was meant to be an empty collection of multiple regular beans
						// (before 4.3 in particular when we didn't even look for collection beans).
						return null;
					}
				}
				instanceCandidate = matchingBeans.get(autowiredBeanName);
			}
			else {
				// We have exactly one match.
				Map.Entry<String, Object> entry = matchingBeans.entrySet().iterator().next();
				autowiredBeanName = entry.getKey();
				instanceCandidate = entry.getValue();
			}

			if (autowiredBeanNames != null) {
				autowiredBeanNames.add(autowiredBeanName);
			}
			if (instanceCandidate instanceof Class) {
				instanceCandidate = descriptor.resolveCandidate(autowiredBeanName, type, this);
			}
			Object result = instanceCandidate;
			if (result instanceof NullBean) {
				if (isRequired(descriptor)) {
					raiseNoMatchingBeanFound(type, descriptor.getResolvableType(), descriptor);
				}
				result = null;
			}
			if (!ClassUtils.isAssignableValue(type, result)) {
				throw new BeanNotOfRequiredTypeException(autowiredBeanName, type, instanceCandidate.getClass());
			}
			return result;
		}
		finally {
			ConstructorResolver.setCurrentInjectionPoint(previousInjectionPoint);
		}
	}