Spring源码分析：IOC之分析各scope的bean创建

本文作者：chenssy

出处：http://cmsblogs.com/?p=2839

在学习Spring源码的过程中发现的好站+好贴，感谢作者。Spring版本：Spring 5.0.6.RELEASE

singleton Spring 的 scope 默认为 singleton，其初始化的代码如下：

if (mbd.isSingleton()) {
  sharedInstance = getSingleton(beanName, () -> {
    try {
      return createBean(beanName, mbd, args);
    }
    catch (BeansException ex) {
      destroySingleton(beanName);
      throw ex;
    }
  });
  bean = getObjectForBeanInstance(sharedInstance, name, beanName, mbd);
}

第一部分分析了从缓存中获取单例模式的 bean，但是如果缓存中不存在呢？

则需要从头开始加载 bean，这个过程由 getSingleton() 实现。

public Object getSingleton(String beanName, ObjectFactory<?> singletonFactory) {
  Assert.notNull(beanName, "Bean name must not be null");

  // 全局加锁
  synchronized (this.singletonObjects) {
    // 从缓存中检查一遍
    // 因为 singleton 模式其实就是复用已经创建的 bean 所以这步骤必须检查
    Object singletonObject = this.singletonObjects.get(beanName);
    //  为空，开始加载过程
    if (singletonObject == null) {
      // 省略 部分代码

      // 加载前置处理
      beforeSingletonCreation(beanName);
      boolean newSingleton = false;
      // 省略代码
      try {
        // 初始化 bean
        // 这个过程其实是调用 createBean() 方法
        singletonObject = singletonFactory.getObject();
        newSingleton = true;
      }
      // 省略 catch 部分
    }
    finally {
      // 后置处理
      afterSingletonCreation(beanName);
    }
    // 加入缓存中
    if (newSingleton) {
      addSingleton(beanName, singletonObject);
    }
  }
  // 直接返回
  return singletonObject;
}

其实这个过程并没有真正创建 bean，仅仅只是做了一部分准备和预处理步骤，真正获取单例 bean 的方法其实是由 singletonFactory.getObject() 这部分实现，而 singletonFactory 由回调方法产生。

那么这个方法做了哪些准备呢？

再次检查缓存是否已经加载过，如果已经加载了则直接返回，否则开始加载过程。
调用 beforeSingletonCreation() 记录加载单例 bean 之前的加载状态，即前置处理。
调用参数传递的 ObjectFactory 的 getObject() 实例化 bean。
调用 afterSingletonCreation() 进行加载单例后的后置处理。
将结果记录并加入值缓存中，同时删除加载 bean 过程中所记录的一些辅助状态。

流程中涉及的三个方法 beforeSingletonCreation() 与 afterSingletonCreation() 在博客 IOC 之缓存中获取单例 bean 中分析过了，所以这里不再阐述了，我们看另外一个方法 addSingleton()。

protected void addSingleton(String beanName, Object singletonObject) {
  synchronized (this.singletonObjects) {
    this.singletonObjects.put(beanName, singletonObject);
    this.singletonFactories.remove(beanName);
    this.earlySingletonObjects.remove(beanName);
    this.registeredSingletons.add(beanName);
  }
}

一个 put、一个 add、两个 remove。

singletonObjects 单例 bean 的缓存
singletonFactories 单例 bean Factory 的缓存
earlySingletonObjects “早期”创建的单例 bean 的缓存
registeredSingletons 已经注册的单例缓存。

加载了单例 bean 后，调用 getObjectForBeanInstance() 从 bean 实例中获取对象。该方法已经在 IOC 之缓存中获取单例 bean 详细分析了。

原型模式

else if (mbd.isPrototype()) {
  Object prototypeInstance = null;
  try {
    beforePrototypeCreation(beanName);
    prototypeInstance = createBean(beanName, mbd, args);
  }
  finally {
    afterPrototypeCreation(beanName);
  }
  bean = getObjectForBeanInstance(prototypeInstance, name, beanName, mbd);
}

原型模式的初始化过程很简单：直接创建一个新的实例就可以了。

过程如下：

调用 beforeSingletonCreation() 记录加载原型模式 bean 之前的加载状态，即前置处理。
调用 createBean() 创建一个 bean 实例对象。
调用 afterSingletonCreation() 进行加载原型模式 bean 后的后置处理。
调用 getObjectForBeanInstance() 从 bean 实例中获取对象。

其他作用域

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);
}

核心流程和原型模式一样，只不过获取 bean 实例是由 scope.get() 实现，如下：

public Object get(String name, ObjectFactory<?> objectFactory) {
  // 获取 scope 缓存
  Map<String, Object> scope = this.threadScope.get();
  Object scopedObject = scope.get(name);
  if (scopedObject == null) {
    scopedObject = objectFactory.getObject();
    // 加入缓存
    scope.put(name, scopedObject);
  }
  return scopedObject;
}

对于上面三个模块，其中最重要的有两个方法： createBean() 和getObjectForBeanInstance()。

这两个方法在上面三个模块都有调用，createBean() 后续详细说明，getObjectForBeanInstance() 在博客IOC 之缓存中获取单例 bean 中有详细讲解，这里再次阐述下（此段内容来自《Spring 源码深度解析》）：这个方法主要是验证以下我们得到的 bean 的正确性，其实就是检测当前 bean 是否是 FactoryBean 类型的 bean，如果是，那么需要调用该 bean 对应的 FactoryBean 实例的 getObject() 作为返回值。无论是从缓存中获得到的 bean 还是通过不同的 scope 策略加载的 bean 都只是最原始的 bean 状态，并不一定就是我们最终想要的 bean。

举个例子，加入我们需要对工厂 bean 进行处理，那么这里得到的其实是工厂 bean 的初始状态，但是我们真正需要的是工厂 bean 中定义 factory-method 方法中返回的 bean，而 getObjectForBeanInstance() 就是完成这个工作的。