在晕车晕了N遍之后,终于打算开始写关于spring源码学习的总结了,在真正看spring源码之前,还是要对spring的一些东西做一些理解,这个在之前已经总结过很多了,这个可以参看之前的博客总结。这篇文章会参考某些大牛的博客,这里先贴出来,有些博客确实写的让本菜鸟拜服:IOC大牛解读。
在阅读spring源码的时候,需要对spring的基本使用还是要熟悉的。对spring中的一些基本概念也是要了解的,针对FactoryBean和BeanFactory两者的区别还是要熟悉的,针对这个问题在上一篇博客中作出了总结:BeanFactory和FactoryBean的区别。
在阅读源码的时候,同时也会不断去维护不同类之间的实例关系图。
IOC的过程大体上分为三步。1、定位,2、加载,3、注册
由于大部分资料均是以XML为切入点来进行bean的解析和注册,正常在XML中配置bean的过程如下:
在获取bean的时候,是这样的,下述实例使用了数组的方式构造ClassPathXmlApplicationContext。
package com.learn.test;
import com.learn.service.MessageService;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;
import org.springframework.context.support.FileSystemXmlApplicationContext;
/**
* autor:liman
* createtime:2019/5/30
* comment:
*/
public class MainTest {
public static void main(String[] args) {
String[] applicationFiles = new String[2];
applicationFiles[0] = "classpath:applicationContext.xml";
ApplicationContext applicationContext = new ClassPathXmlApplicationContext(applicationFiles);
System.out.println("context,启动成功");
MessageService messageService = (MessageService) applicationContext.getBean("message");
System.out.println(messageService.getMessage());
}
}
从ClassPathXmlApplicationContext说开去。ClassPathXmlApplicationContext.java 137行,后续的表述都会说明类名已经代码所在的行。
public ClassPathXmlApplicationContext(
String[] configLocations, boolean refresh, @Nullable ApplicationContext parent)
throws BeansException {
super(parent);
//TODO:根据提供的路径,处理成配置文件数组(以分号、逗号、空格、tab、换行符分割)
setConfigLocations(configLocations);
if (refresh) {
refresh();
}
}
这里的supe(parent)只是给ApplicationContext设置了一个路径解析器,没什么特别的,第二行,setConfigLocations方法只是将传入的configLocations数组 处理成配置文件数组,这个也并不复杂。真正的入口是refresh方法。
refresh方法其实是父类AbstractApplicationContext中的方法,AbstractApplicationContext.java 515行。
@Override
public void refresh() throws BeansException, IllegalStateException {
//TODO:容器的初始化需要同步,不然多个人同时创建,就会乱套了
synchronized (this.startupShutdownMonitor) {
// Prepare this context for refreshing.
//TODO:容器启动前的准备:记录启动时间,处理启动文件中的特殊字符
prepareRefresh();
// Tell the subclass to refresh the internal bean factory.
/**
这一步是关键,这一步完成了在xml中的配置就变成了Bean,并注册到了BeanFactory中
这里并没有初始化,初始化是在后面的getBean完成的。
*/
ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();
// Prepare the bean factory for use in this context.
//手动注册几个特殊的bean,这里会用到BeanPostProcessor
prepareBeanFactory(beanFactory);
try {
// Allows post-processing of the bean factory in context subclasses.
postProcessBeanFactory(beanFactory);
// Invoke factory processors registered as beans in the context.
invokeBeanFactoryPostProcessors(beanFactory);
// Register bean processors that intercept bean creation.
registerBeanPostProcessors(beanFactory);
// Initialize message source for this context.
initMessageSource();
// Initialize event multicaster for this context.
initApplicationEventMulticaster();
// Initialize other special beans in specific context subclasses.
onRefresh();
// Check for listener beans and register them.
registerListeners();
//初始化所有的 singleton beans
// Instantiate all remaining (non-lazy-init) singletons.
finishBeanFactoryInitialization(beanFactory);
// Last step: publish corresponding event.
finishRefresh();
}
catch (BeansException ex) {
if (logger.isWarnEnabled()) {
logger.warn("Exception encountered during context initialization - " +
"cancelling refresh attempt: " + ex);
}
// Destroy already created singletons to avoid dangling resources.
destroyBeans();
// Reset 'active' flag.
cancelRefresh(ex);
// Propagate exception to caller.
throw ex;
}
finally {
// Reset common introspection caches in Spring's core, since we
// might not ever need metadata for singleton beans anymore...
resetCommonCaches();
}
}
}
目前的类关系图:
下面详细说明obtainFreshBeanFactory的操作。AbstractApplicationContext.java中的633行。
protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
//关闭旧的 BeanFactory (如果有),创建新的 BeanFactory,加载 Bean 定义、注册 Bean 等等
refreshBeanFactory();
//返回刚刚创建的 BeanFactory
ConfigurableListableBeanFactory beanFactory = getBeanFactory();
if (logger.isDebugEnabled()) {
logger.debug("Bean factory for " + getDisplayName() + ": " + beanFactory);
}
return beanFactory;
}
其中的refreshBeanFactory方法是一个抽象方法,这个方法的具体实现是在AbstractRefreshableApplicationContext中。这时的类之间的关系图如下
在refreshBeanFactory中,创建了一个DefaultListableBeanFactory实体对象,初始化了beanFactory属性,同时也设置了BeanFactory的两个属性(customizeBeanFactory方法中完成),是否允许Bean定义覆盖和是否允许Bean间的循环依赖,这个后续再详细探讨。
AbstractRefreshableApplicationContext.java 124行。
@Override
protected final void refreshBeanFactory() throws BeansException {
if (hasBeanFactory()) {
destroyBeans();
closeBeanFactory();
}
try {
//初始化一个 DefaultListableBeanFactory,为什么用这个,我们马上说。
DefaultListableBeanFactory beanFactory = createBeanFactory();
beanFactory.setSerializationId(getId());
//设置 BeanFactory 的两个配置属性:是否允许 Bean 覆盖、是否允许循环引用
customizeBeanFactory(beanFactory);
//加载 Bean 到 BeanFactory 中
loadBeanDefinitions(beanFactory);
synchronized (this.beanFactoryMonitor) {
this.beanFactory = beanFactory;
}
}
catch (IOException ex) {
throw new ApplicationContextException("I/O error parsing bean definition source for " + getDisplayName(), ex);
}
}
customizeBeanFactory(beanFactory)的具体实现:
protected void customizeBeanFactory(DefaultListableBeanFactory beanFactory) {
if (this.allowBeanDefinitionOverriding != null) {
//是否允许 Bean 定义覆盖
beanFactory.setAllowBeanDefinitionOverriding(this.allowBeanDefinitionOverriding);
}
if (this.allowCircularReferences != null) {
//是否允许 Bean 间的循环依赖
beanFactory.setAllowCircularReferences(this.allowCircularReferences);
}
}
DefaultListableBeanFactory出现,DefaultListableBeanFactory是BeanFactory容器的一种默认的具体实现,之前的ApplicationContext其实也是一种BeanFactory,目前各自类的关系如下所示:
DefaultListableBeanFactory目前来看就是比较全面的一个BeanFactory了,如果我们想动态注册一个Bean到容器,就需要用到这个类,但是我们实际在使用的过程中都用的是ApplicationContext,而不是BeanFactory,但是,其实在ApplicationContext中嗨有一个getAutowireCapableBeanFactory的方法,而DefaultListableBeanFactory其实实现了AutowireCapableBeanFactory这个接口,所以ApplicationContext也是能获取到DefaultListableBeanFactory的
其实BeanDefinition只是一个描述Bean的定义,xml配置的Bean实体,都会转换成BeanDefinition,这个BeanDefinition中定义了关于Bean的所有的属性,下述属性是从大牛的博客中拷贝过来的,具体都说明了BeanDefinition的关键属性。
public interface BeanDefinition extends AttributeAccessor, BeanMetadataElement {
// 我们可以看到,默认只提供 sington 和 prototype 两种,
// 很多读者可能知道还有 request, session, globalSession, application, websocket 这几种,
// 不过,它们属于基于 web 的扩展。
String SCOPE_SINGLETON = ConfigurableBeanFactory.SCOPE_SINGLETON;
String SCOPE_PROTOTYPE = ConfigurableBeanFactory.SCOPE_PROTOTYPE;
// 比较不重要,直接跳过吧
int ROLE_APPLICATION = 0;
int ROLE_SUPPORT = 1;
int ROLE_INFRASTRUCTURE = 2;
// 设置父 Bean,这里涉及到 bean 继承,
// 一句话就是:继承父 Bean 的配置信息而已
void setParentName(String parentName);
// 获取父 Bean
String getParentName();
// 设置 Bean 的类名称,将来是要通过反射来生成实例的
void setBeanClassName(String beanClassName);
// 获取 Bean 的类名称
String getBeanClassName();
// 设置 bean 的 scope
void setScope(String scope);
String getScope();
// 设置是否懒加载
void setLazyInit(boolean lazyInit);
boolean isLazyInit();
// 设置该 Bean 依赖的所有的 Bean,注意,这里的依赖不是指属性依赖(如 @Autowire 标记的),
// 是 depends-on="" 属性设置的值。
void setDependsOn(String... dependsOn);
// 返回该 Bean 的所有依赖
String[] getDependsOn();
// 设置该 Bean 是否可以注入到其他 Bean 中,只对根据类型注入有效,
// 如果根据名称注入,即使这边设置了 false,也是可以的
void setAutowireCandidate(boolean autowireCandidate);
// 该 Bean 是否可以注入到其他 Bean 中
boolean isAutowireCandidate();
// 主要的。同一接口的多个实现,如果不指定名字的话,Spring 会优先选择设置 primary 为 true 的 bean
void setPrimary(boolean primary);
// 是否是 primary 的
boolean isPrimary();
// 如果该 Bean 采用工厂方法生成,指定工厂名称。
// 一句话就是:有些实例不是用反射生成的,而是用工厂模式生成的
void setFactoryBeanName(String factoryBeanName);
// 获取工厂名称
String getFactoryBeanName();
// 指定工厂类中的 工厂方法名称
void setFactoryMethodName(String factoryMethodName);
// 获取工厂类中的 工厂方法名称
String getFactoryMethodName();
// 构造器参数
ConstructorArgumentValues getConstructorArgumentValues();
// Bean 中的属性值,后面给 bean 注入属性值的时候会说到
MutablePropertyValues getPropertyValues();
// 是否 singleton
boolean isSingleton();
// 是否 prototype
boolean isPrototype();
// 如果这个 Bean 是被设置为 abstract,那么不能实例化,
// 常用于作为 父bean 用于继承,其实也很少用......
boolean isAbstract();
int getRole();
String getDescription();
String getResourceDescription();
BeanDefinition getOriginatingBeanDefinition();
}
走到这里之后,我们也只是完成了容器对象的一些设置而已,还没有真正开始解析Bean,refreshBeanFactory方法中,设置完成了BeanFactory的两个属性之后,就开始调用loadBeanDefinitions方法了。
AbstractXmlApplicationContext.java 81行。
@Override
protected void loadBeanDefinitions(DefaultListableBeanFactory beanFactory) throws BeansException, IOException {
// Create a new XmlBeanDefinitionReader for the given BeanFactory.
//给这个 BeanFactory 实例化一个 XmlBeanDefinitionReader
XmlBeanDefinitionReader beanDefinitionReader = new XmlBeanDefinitionReader(beanFactory);
// Configure the bean definition reader with this context's
// resource loading environment.
beanDefinitionReader.setEnvironment(this.getEnvironment());
beanDefinitionReader.setResourceLoader(this);
beanDefinitionReader.setEntityResolver(new ResourceEntityResolver(this));
// Allow a subclass to provide custom initialization of the reader,
// then proceed with actually loading the bean definitions.
//初始化 BeanDefinitionReader,其实这个是提供给子类覆写的
initBeanDefinitionReader(beanDefinitionReader);
//T重点来了,继续往下
loadBeanDefinitions(beanDefinitionReader);
}
这里实例化了XmlBeanDefintionReader,这个对象就是去负责读取配置文件,并将Bean解析成BeanDefinition。目前类之间的关系图如下所示:
XmlBeanDefinitionReader是在AbstractXmlApplicationContext中直接实例化的一个实例。之后调用在AbstractXmlApplicationContext.java的124行,loadBeanDefinitions方法调用了reader对象的loadBeanDefinitions方法,这个方法就是加载Bean的定义。
protected void loadBeanDefinitions(XmlBeanDefinitionReader reader) throws BeansException, IOException {
Resource[] configResources = getConfigResources();
if (configResources != null) {
reader.loadBeanDefinitions(configResources);
}
String[] configLocations = getConfigLocations();
if (configLocations != null) {
reader.loadBeanDefinitions(configLocations);
}
}
上述两个方法殊途同归,都是调用AbstractBeanDefinitionReader中的loadBeanDefinitions的方法,AbstractBeanDefinitionReader.java中的183行。这里是有for循环的,也就是每一个配置文件对应一个resources。
public int loadBeanDefinitions(Resource... resources) throws BeanDefinitionStoreException {
Assert.notNull(resources, "Resource array must not be null");
int counter = 0;
//注意这里是个 for 循环,也就是每个文件是一个 resource
for (Resource resource : resources) {
counter += loadBeanDefinitions(resource);
}
//最后返回 counter,表示总共加载了多少的 BeanDefinition
return counter;
}
看到这里的时候,我几乎快无语了,还是没有到loadBeanDefinitions方法的实现类,下一步就到了XmlBeanDefinitionReader中,XmlBeanDefinitionReader.java的第302行
public int loadBeanDefinitions(Resource resource) throws BeanDefinitionStoreException {
return loadBeanDefinitions(new EncodedResource(resource));
}
继续吧:调用的这个方法还是在这个类中
XmlBeanDefinitionReader.java的313行。
public int loadBeanDefinitions(EncodedResource encodedResource) throws BeanDefinitionStoreException {
Assert.notNull(encodedResource, "EncodedResource must not be null");
if (logger.isInfoEnabled()) {
logger.info("Loading XML bean definitions from " + encodedResource.getResource());
}
//TODO:用一个 ThreadLocal 来存放配置文件资源
Set currentResources = this.resourcesCurrentlyBeingLoaded.get();
if (currentResources == null) {
currentResources = new HashSet<>(4);
this.resourcesCurrentlyBeingLoaded.set(currentResources);
}
if (!currentResources.add(encodedResource)) {
throw new BeanDefinitionStoreException(
"Detected cyclic loading of " + encodedResource + " - check your import definitions!");
}
try {
InputStream inputStream = encodedResource.getResource().getInputStream();
try {
InputSource inputSource = new InputSource(inputStream);
if (encodedResource.getEncoding() != null) {
inputSource.setEncoding(encodedResource.getEncoding());
}
//TODO:这个就是调用底层的读取BeanDefinition
return doLoadBeanDefinitions(inputSource, encodedResource.getResource());
}
finally {
inputStream.close();
}
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(
"IOException parsing XML document from " + encodedResource.getResource(), ex);
}
finally {
currentResources.remove(encodedResource);
if (currentResources.isEmpty()) {
this.resourcesCurrentlyBeingLoaded.remove();
}
}
}
吐血,还是没到具体的实现,上述看到,开始调用doLoadBeanDefinitions方法,这个方法也在这个类中——XmlBeanDefinitioinReader.java第388行。
protected int doLoadBeanDefinitions(InputSource inputSource, Resource resource)
throws BeanDefinitionStoreException {
try {
//TODO:这里就不看了,将 xml 文件转换为 Document 对象
Document doc = doLoadDocument(inputSource, resource);
return registerBeanDefinitions(doc, resource);
}
catch (BeanDefinitionStoreException ex) {
throw ex;
}
catch (SAXParseException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"Line " + ex.getLineNumber() + " in XML document from " + resource + " is invalid", ex);
}
catch (SAXException ex) {
throw new XmlBeanDefinitionStoreException(resource.getDescription(),
"XML document from " + resource + " is invalid", ex);
}
catch (ParserConfigurationException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Parser configuration exception parsing XML from " + resource, ex);
}
catch (IOException ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"IOException parsing XML document from " + resource, ex);
}
catch (Throwable ex) {
throw new BeanDefinitionStoreException(resource.getDescription(),
"Unexpected exception parsing XML document from " + resource, ex);
}
}
上述代码的第一步就是将xml配置文件转换为Document对象,然后调用registerBeanDefinitions方法注册BeanDefinition,这个方法依旧是在XmlBeanDefinitionReader.java中——XmlBeanDefinitionReader第507行
public int registerBeanDefinitions(Document doc, Resource resource) throws BeanDefinitionStoreException {
BeanDefinitionDocumentReader documentReader = createBeanDefinitionDocumentReader();
int countBefore = getRegistry().getBeanDefinitionCount();
//TODO:真正的注册Bean
documentReader.registerBeanDefinitions(doc, createReaderContext(resource));
return getRegistry().getBeanDefinitionCount() - countBefore;
}
这个将会返回多少个Bean注册到容器中了。之后就开始调用registerBeanDefinitions,这个方法是在XmlBeanDefinitionReader的父类——DefaultBeanDefinitionDocumentReader中,如下所示:DefaultBeanDefinitionDocumentReader第94行。
public void registerBeanDefinitions(Document doc, XmlReaderContext readerContext) {
this.readerContext = readerContext;
logger.debug("Loading bean definitions");
Element root = doc.getDocumentElement();
//TODO: 从 xml 根节点开始解析文件
doRegisterBeanDefinitions(root);
}
历经千辛万苦,我总算看到了spring将配置文件读取成了Document对象目前的类图如下所示:
已经开始慢慢庞大起来了,其中其实Reader部分我们可以不用太关心。
doRegisterBeanDefinitions——DefaultBeanDefinitionDocumentReader中的第124行。
protected void doRegisterBeanDefinitions(Element root) {
// Any nested elements will cause recursion in this method. In
// order to propagate and preserve default-* attributes correctly,
// keep track of the current (parent) delegate, which may be null. Create
// the new (child) delegate with a reference to the parent for fallback purposes,
// then ultimately reset this.delegate back to its original (parent) reference.
// this behavior emulates a stack of delegates without actually necessitating one.
//TODO:我们看名字就知道,BeanDefinitionParserDelegate 必定是一个重要的类,它负责解析 Bean 定义,这里为什么要定义一个 parent? 看到后面就知道了,是递归问题,
//TODO:因为 内部是可以定义 的,所以这个方法的 root 其实不一定就是 xml 的根节点,也可以是嵌套在里面的 节点,从源码分析的角度,我们当做根节点就好了
BeanDefinitionParserDelegate parent = this.delegate;
this.delegate = createDelegate(getReaderContext(), root, parent);
if (this.delegate.isDefaultNamespace(root)) {
//TODO: 这块说的是根节点 中的 profile 是否是当前环境需要的,
//TODO: 如果当前环境配置的 profile 不包含此 profile,那就直接 return 了,不对此 解析
//TODO: profile就是指定不同的环境,使用不同的配置
String profileSpec = root.getAttribute(PROFILE_ATTRIBUTE);
if (StringUtils.hasText(profileSpec)) {
String[] specifiedProfiles = StringUtils.tokenizeToStringArray(
profileSpec, BeanDefinitionParserDelegate.MULTI_VALUE_ATTRIBUTE_DELIMITERS);
if (!getReaderContext().getEnvironment().acceptsProfiles(specifiedProfiles)) {
if (logger.isInfoEnabled()) {
logger.info("Skipped XML bean definition file due to specified profiles [" + profileSpec +
"] not matching: " + getReaderContext().getResource());
}
return;
}
}
}
preProcessXml(root);//钩子
parseBeanDefinitions(root, this.delegate);
postProcessXml(root);//钩子
this.delegate = parent;
}
看到这里,我的内心已经快奔溃了,依旧还没有进入到正儿八经的解析过程,parseBeanDefinition才是对指定标签的解析:
这个方法依旧在DefaultBeanDefinitionDocumentReader类中——DefaultBeanDefinitionDocumentReader第176行。
protected void parseBeanDefinitions(Element root, BeanDefinitionParserDelegate delegate) {
if (delegate.isDefaultNamespace(root)) {
NodeList nl = root.getChildNodes();
for (int i = 0; i < nl.getLength(); i++) {
Node node = nl.item(i);
if (node instanceof Element) {
Element ele = (Element) node;
if (delegate.isDefaultNamespace(ele)) {
//TODO: 解析 default namespace 下面的几个元素
parseDefaultElement(ele, delegate);
}
else {
//TODO: 解析其他 namespace 的元素
delegate.parseCustomElement(ele);
}
}
}
}
else {
delegate.parseCustomElement(root);
}
}
这里逻辑也就分为两个,一个是解析默认的标签,如果不是默认的标签,就调用delegate对象的parseCustomElement方法去解析指定的标签。默认的标签就是spring中常用的,比如我们常说的
、
、
、
,
parseDefaultElement——解析默认标签这个方法,依旧位于DefaultBeanDefinitionDocumentReader类中——DefaultBeanDefinitionDocumentReader类第199行
private void parseDefaultElement(Element ele, BeanDefinitionParserDelegate delegate) {
if (delegate.nodeNameEquals(ele, IMPORT_ELEMENT)) {
//TODO: 处理 标签
importBeanDefinitionResource(ele);
}
else if (delegate.nodeNameEquals(ele, ALIAS_ELEMENT)) {
//TODO:处理 标签定义
processAliasRegistration(ele);
}
else if (delegate.nodeNameEquals(ele, BEAN_ELEMENT)) {
//TODO:处理 标签定义,这也算是我们的重点吧
processBeanDefinition(ele, delegate);
}
else if (delegate.nodeNameEquals(ele, NESTED_BEANS_ELEMENT)) {
// recurse
//TODO:如果碰到的是嵌套的 标签,需要递归
doRegisterBeanDefinitions(ele);
}
}
我们这里就看一下怎么解析Bean标签的吧。
processBeanDefinition这个方法依旧在DefaultBeanDefinitionDocumentReader类中——DefaultBeanDefinitionDocumentReader类第319行。
protected void processBeanDefinition(Element ele, BeanDefinitionParserDelegate delegate) {
//TODO:将标签转换成BeanDefinitionHolder对象
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
if (bdHolder != null) {
//TODO:如果有自定义属性的话,进行相应的解析,先忽略
bdHolder = delegate.decorateBeanDefinitionIfRequired(ele, bdHolder);
try {
// Register the final decorated instance.
//TODO:注册Bean
BeanDefinitionReaderUtils.registerBeanDefinition(bdHolder, getReaderContext().getRegistry());
}
catch (BeanDefinitionStoreException ex) {
getReaderContext().error("Failed to register bean definition with name '" +
bdHolder.getBeanName() + "'", ele, ex);
}
// Send registration event.
getReaderContext().fireComponentRegistered(new BeanComponentDefinition(bdHolder));
}
}
一个比较完整的bean的配置,如下所示:
上述代码,我们最需要关心的就是下面这一行,其他的可以暂时不用看。
BeanDefinitionHolder bdHolder = delegate.parseBeanDefinitionElement(ele);
这一行代码就是将
可以看到一个BeanDefinitionHolder其中就有一个BeanDefinition属性,二者是一一对应的关系。我们继续往下跟中,其实BeanDefinitionHolder只是对BeanDefinition进行了一个封装,其中的具体属性如下:
只是保存了BeanDefinition属性,外加对应的beanName和aliases属性。
parseBeanDefinitionElement方法是在BeanDefinitionParserDelegate中。BeanDefinitionParserDelegate类404行。具体实现在414行。
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele) {
return parseBeanDefinitionElement(ele, null);
}
public BeanDefinitionHolder parseBeanDefinitionElement(Element ele, @Nullable BeanDefinition containingBean) {
String id = ele.getAttribute(ID_ATTRIBUTE);
String nameAttr = ele.getAttribute(NAME_ATTRIBUTE);
List aliases = new ArrayList<>();
/**
* TODO:将name属性的定义按照逗号,分号,空格切分,形成一个别名列表数组
*/
if (StringUtils.hasLength(nameAttr)) {
String[] nameArr = StringUtils.tokenizeToStringArray(nameAttr, MULTI_VALUE_ATTRIBUTE_DELIMITERS);
aliases.addAll(Arrays.asList(nameArr));
}
String beanName = id;
//TODO:如果没有指定id,则别名列表中的第一个就是beanName
if (!StringUtils.hasText(beanName) && !aliases.isEmpty()) {
beanName = aliases.remove(0);
if (logger.isDebugEnabled()) {
logger.debug("No XML 'id' specified - using '" + beanName +
"' as bean name and " + aliases + " as aliases");
}
}
if (containingBean == null) {
checkNameUniqueness(beanName, aliases, ele);
}
//TODO:创建BeanDefinitioin,这行代码结束,一个BeanDefinitioin就形成了
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
//TODO:到这里,一个BeanDefinition就形成了,
if (beanDefinition != null) {//TODO:如果没有设置name,则id和name就为null,如果为null,就做如下处理
if (!StringUtils.hasText(beanName)) {
try {
if (containingBean != null) {
beanName = BeanDefinitionReaderUtils.generateBeanName(
beanDefinition, this.readerContext.getRegistry(), true);
}
else {
beanName = this.readerContext.generateBeanName(beanDefinition);
// Register an alias for the plain bean class name, if still possible,
// if the generator returned the class name plus a suffix.
// This is expected for Spring 1.2/2.0 backwards compatibility.
String beanClassName = beanDefinition.getBeanClassName();
if (beanClassName != null &&
beanName.startsWith(beanClassName) && beanName.length() > beanClassName.length() &&
!this.readerContext.getRegistry().isBeanNameInUse(beanClassName)) {
aliases.add(beanClassName);
}
}
if (logger.isDebugEnabled()) {
logger.debug("Neither XML 'id' nor 'name' specified - " +
"using generated bean name [" + beanName + "]");
}
}
catch (Exception ex) {
error(ex.getMessage(), ele);
return null;
}
}
String[] aliasesArray = StringUtils.toStringArray(aliases);
//TODO:返回BeanDefinitionHolder
return new BeanDefinitionHolder(beanDefinition, beanName, aliasesArray);
}
return null;
}
真正产生BeanDefinition的是如下的代码:
//TODO:创建BeanDefinitioin,这行代码结束,一个BeanDefinitioin就形成了
AbstractBeanDefinition beanDefinition = parseBeanDefinitionElement(ele, beanName, containingBean);
这个方法具体的实现也在BeanDefinitionParserDelegate类中,如下所示:
public AbstractBeanDefinition parseBeanDefinitionElement(
Element ele, String beanName, @Nullable BeanDefinition containingBean) {
this.parseState.push(new BeanEntry(beanName));
String className = null;
if (ele.hasAttribute(CLASS_ATTRIBUTE)) {
className = ele.getAttribute(CLASS_ATTRIBUTE).trim();
}
String parent = null;
if (ele.hasAttribute(PARENT_ATTRIBUTE)) {
parent = ele.getAttribute(PARENT_ATTRIBUTE);
}
try {
//TODO:创建一个BeanDefinition实例
AbstractBeanDefinition bd = createBeanDefinition(className, parent);
parseBeanDefinitionAttributes(ele, beanName, containingBean, bd);
bd.setDescription(DomUtils.getChildElementValueByTagName(ele, DESCRIPTION_ELEMENT));
// 解析
parseMetaElements(ele, bd);
// 解析
parseLookupOverrideSubElements(ele, bd.getMethodOverrides());
// 解析
parseReplacedMethodSubElements(ele, bd.getMethodOverrides());
// 解析
parseConstructorArgElements(ele, bd);
// 解析
parsePropertyElements(ele, bd);
// 解析
parseQualifierElements(ele, bd);
bd.setResource(this.readerContext.getResource());
bd.setSource(extractSource(ele));
return bd;
}
catch (ClassNotFoundException ex) {
error("Bean class [" + className + "] not found", ele, ex);
}
catch (NoClassDefFoundError err) {
error("Class that bean class [" + className + "] depends on not found", ele, err);
}
catch (Throwable ex) {
error("Unexpected failure during bean definition parsing", ele, ex);
}
finally {
this.parseState.pop();
}
return null;
}
到这里,我们就得到了一个BeanDefinition,解析Bean的过程可以说结束了,我们也看到了,在上面的DefaultBeanDefinitionDocumentReader类第329行,就有Bean的注册,这个就在Bean的注册部分进行总结,这个是由BeanDefinitionUtils完成的。
前面经过一连串晕车的操作之后,总算得到了BeanDefinition,下面就是要将BeanDefinition注册到容器中,注册这一步,看代码是在BeanDefinitionUtils中完成。BeanDefinitionUtils.java第144行。
public static void registerBeanDefinition(
BeanDefinitionHolder definitionHolder, BeanDefinitionRegistry registry)
throws BeanDefinitionStoreException {
// Register bean definition under primary name.
String beanName = definitionHolder.getBeanName();
//TODO:注册这个Bean
registry.registerBeanDefinition(beanName, definitionHolder.getBeanDefinition());
// Register aliases for bean name, if any.
//TODO:如果还有别名的话,也要根据别名全部注册一遍,不然根据别名就会找不到 Bean 了
String[] aliases = definitionHolder.getAliases();
if (aliases != null) {
for (String alias : aliases) {
//TODO:alias -> beanName 保存它们的别名信息,这个很简单,用一个 map 保存一下就可以了,
//TODO:获取的时候,会先将 alias 转换为 beanName,然后再查找
registry.registerAlias(beanName, alias);
}
}
}
真正的注册是调用BeanDefinitionRegistry中的registerBeanDefinition完成的。到这里,我们再梳理一下类之间的关系,局部图如下:这里我们发现一个点,我们之前的最牛的BeanFactory居然继承了BeanDefinitionRegistry。
之后我们进入到对应的注册方法,发现这个是BeanDefinitionRegistry中的一个抽象方法,其具体实现,就在DefaultListableBeanFactory中,如下图所示:(ps:在idea中找到一个接口方法的实现类,可以用快捷键ctrl+alt+b),绕了一圈,终于回到了BeanFactory中。
于是我们进入到DefaultListableBeanFactory中,看到有一个registerBeanDefinition方法,只有两个参数,一个是BeanName,一个就是BeanDefinition,DefaultListableBeanFactory类798行如下所示:
public void registerBeanDefinition(String beanName, BeanDefinition beanDefinition)
throws BeanDefinitionStoreException {
Assert.hasText(beanName, "Bean name must not be empty");
Assert.notNull(beanDefinition, "BeanDefinition must not be null");
if (beanDefinition instanceof AbstractBeanDefinition) {
try {
((AbstractBeanDefinition) beanDefinition).validate();
}
catch (BeanDefinitionValidationException ex) {
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Validation of bean definition failed", ex);
}
}
BeanDefinition oldBeanDefinition;
//TODO:IOC 容易的真面目,其实就是一个Map集合
oldBeanDefinition = this.beanDefinitionMap.get(beanName);
if (oldBeanDefinition != null) {
if (!isAllowBeanDefinitionOverriding()) {//TODO:不允许覆盖,则抛出异常
throw new BeanDefinitionStoreException(beanDefinition.getResourceDescription(), beanName,
"Cannot register bean definition [" + beanDefinition + "] for bean '" + beanName +
"': There is already [" + oldBeanDefinition + "] bound.");
}
else if (oldBeanDefinition.getRole() < beanDefinition.getRole()) {
// e.g. was ROLE_APPLICATION, now overriding with ROLE_SUPPORT or ROLE_INFRASTRUCTURE
if (this.logger.isWarnEnabled()) {
this.logger.warn("Overriding user-defined bean definition for bean '" + beanName +
"' with a framework-generated bean definition: replacing [" +
oldBeanDefinition + "] with [" + beanDefinition + "]");
}
}
else if (!beanDefinition.equals(oldBeanDefinition)) {
if (this.logger.isInfoEnabled()) {
this.logger.info("Overriding bean definition for bean '" + beanName +
"' with a different definition: replacing [" + oldBeanDefinition +
"] with [" + beanDefinition + "]");
}
}
else {
if (this.logger.isDebugEnabled()) {
this.logger.debug("Overriding bean definition for bean '" + beanName +
"' with an equivalent definition: replacing [" + oldBeanDefinition +
"] with [" + beanDefinition + "]");
}
}
//TODO:覆盖掉原有的Bean
this.beanDefinitionMap.put(beanName, beanDefinition);
}
else {
//TODO:注意这里只是注册,并没有初始化bean,spring容器启动后,会与初始化所有的单例模式的bean
//TODO:在 Spring 容器启动的最后,会 预初始化 所有的 singleton beans
if (hasBeanCreationStarted()) {//TODO:判断是否有其他的Bean开始初始化了
// Cannot modify startup-time collection elements anymore (for stable iteration)
synchronized (this.beanDefinitionMap) {
this.beanDefinitionMap.put(beanName, beanDefinition);
List updatedDefinitions = new ArrayList<>(this.beanDefinitionNames.size() + 1);
updatedDefinitions.addAll(this.beanDefinitionNames);
updatedDefinitions.add(beanName);
this.beanDefinitionNames = updatedDefinitions;
if (this.manualSingletonNames.contains(beanName)) {
Set updatedSingletons = new LinkedHashSet<>(this.manualSingletonNames);
updatedSingletons.remove(beanName);
this.manualSingletonNames = updatedSingletons;
}
}
}
else {
//TODO:正常流程会进入到这个分支
// Still in startup registration phase
this.beanDefinitionMap.put(beanName, beanDefinition);
//TODO:这是一个ArrayList,所以会按照bean配置的顺序保存每一个注册的Bean的名字。
this.beanDefinitionNames.add(beanName);
// TODO:这是个 LinkedHashSet,代表的是手动注册的 singleton bean,
// TODO:注意这里是 remove 方法,到这里的 Bean 当然不是手动注册的
// TODO:手动指的是通过调用以下方法注册的 bean :
// TODO: registerSingleton(String beanName, Object singletonObject)
// TODO:这不是重点,解释只是为了不让大家疑惑。Spring 会在后面"手动"注册一些 Bean,
// TODO:如 "environment"、"systemProperties" 等 bean,我们自己也可以在运行时注册 Bean 到容器中的
this.manualSingletonNames.remove(beanName);
}
this.frozenBeanDefinitionNames = null;
}
if (oldBeanDefinition != null || containsSingleton(beanName)) {
resetBeanDefinition(beanName);
}
}
到这里我们发下一个特别耀眼的数据结构——beanDefinitionMap,这个就是存放所有BeanDefinition的容器
/** Map of bean definition objects, keyed by bean name */
private final Map beanDefinitionMap = new ConcurrentHashMap<>(256);
这个也是为什么registerBeanDefinition方法只需要两个参数的原因,毕竟这个数据结构就是一个Map。至此spring就算真正的完成了Bean的注册
其实总体一句话可概括bean的注册过程,spring先定位配置文件,然后加载配置文件,解析其中的bean,将其转换成对应的BeanDefinition对象,然后在我们熟悉的DefaultListableBeanFactory中完成Bean的注册,常说的IOC容器,其实就是一个ConcurrentHashMap。
这篇博客书写的过程中,其实大部分都参考了大牛的内容,有些注解几乎是原封不动的搬过来了,大牛对spring的理解真的很深入,我只是在阅读大牛文章的过程中,不断利用idea的便捷,不断丰富了类关系图,这样一定程度上避免了晕车的过程,下面来一张疯狂的类关系图。下一篇博客总结IOC中的getBean操作。