Spring Bean 的实例化_02

你的赞是我最大的动力,期待与你共同进步

  在上篇文章中提到 Object sharedInstance = getSingleton(beanName); 这一行代码,在容器初始化的时候返回的对象为null。 但是,今天这篇文章中,我要先来处理 sharedInstance 不为null的情况,看看Spring做了什么样的处理。对应下述流程图中的方法:

getObjectForBeanInstance

protected Object getObjectForBeanInstance(
        Object beanInstance, String name, String beanName, @Nullable RootBeanDefinition mbd) {

    // Don't let calling code try to dereference the factory if the bean isn't a factory.
    /**
     * 如果指定的name是工厂相关(以 & 为前缀)
     * 且beanInstance又不是 FactoryBean类型 则验证不通过
     */
    if (BeanFactoryUtils.isFactoryDereference(name)) {
        if (beanInstance instanceof NullBean) {
            return beanInstance;
        }
        if (!(beanInstance instanceof FactoryBean)) {
            throw new BeanIsNotAFactoryException(beanName, beanInstance.getClass());
        }
    }

    /**
     * 有了bean的实例,这个实例通常是 bean 或者是 FactoryBean
     * 如果是 FactoryBean 使用它创建实例,如果用户想要直接获取工厂实例
     * 而不是工厂的 getObject() 方法对应的实例,那么传入的name 应该加前缀 &
     */
    if (!(beanInstance instanceof FactoryBean) || BeanFactoryUtils.isFactoryDereference(name)) {
        return beanInstance;
    }

    // 加载 FactoryBean
    Object object = null;
    if (mbd == null) {
        // 尝试从缓存中加载bean
        object = getCachedObjectForFactoryBean(beanName);
    }
    if (object == null) {
        // beanInstance 一定是 FactoryBean
        FactoryBean<?> factory = (FactoryBean<?>) beanInstance;
        // Caches object obtained from FactoryBean if it is a singleton.
        if (mbd == null && containsBeanDefinition(beanName)) {
            /**
             * 将存储Xml配置文件的 GenericBeanDefinition 转换为 RootBeanDefinition
             * 如果指定BeanName是子 Bean 的话同时会合并父类的相关属性
             */
            mbd = getMergedLocalBeanDefinition(beanName);
        }
        // 是否用户定义的,而不是应用程序本身定义的
        boolean synthetic = (mbd != null && mbd.isSynthetic());
        object = getObjectFromFactoryBean(factory, beanName, !synthetic);
    }
    return object;
}
复制代码

  该方法是个高频使用的方法,无论是存缓存中获得bean 还是根据不同的 scope 策略加载bean。总之得到bean的实例之后要做的第一步就是 调用这个方法来检测一下正确性,其实就是检测当前的bean是否是FactoryBean类型的bean,如果是,那么需要调用该bean对应的FactoryBean实例中的getObject() 作为返回值。

protected Object getObjectFromFactoryBean(FactoryBean<?> factory, String beanName, boolean shouldPostProcess) {
    // 如果是单例模式
    if (factory.isSingleton() && containsSingleton(beanName)) {
        synchronized (getSingletonMutex()) {
            Object object = this.factoryBeanObjectCache.get(beanName);
            if (object == null) {
                /** 通过FactoryBean获取对象*/
                object = doGetObjectFromFactoryBean(factory, beanName);
                // Only post-process and store if not put there already during getObject() call above
                // (e.g. because of circular reference processing triggered by custom getBean calls)
                Object alreadyThere = this.factoryBeanObjectCache.get(beanName);
                if (alreadyThere != null) {
                    object = alreadyThere;
                }
                else {
                    if (shouldPostProcess) {
                        if (isSingletonCurrentlyInCreation(beanName)) {
                            // Temporarily return non-post-processed object, not storing it yet..
                            return object;
                        }
                        beforeSingletonCreation(beanName);
                        try {
                            /**
                             * 调用 ObjectFactory的后置处理器
                             * AbstractAutowireCapableBeanFactory#postProcessObjectFromFactoryBean()
                             * 尽可能保证所有的bean初始化之后都会调用注册的
                             * BeanPostProcessor 的 postProcessAfterInitialization 方法
                             */
                            object = postProcessObjectFromFactoryBean(object, beanName);
                        }
                        catch (Throwable ex) {
                            throw new BeanCreationException(beanName,
                                    "Post-processing of FactoryBean's singleton object failed", ex);
                        }
                        finally {
                            afterSingletonCreation(beanName);
                        }
                    }
                    if (containsSingleton(beanName)) {
                        this.factoryBeanObjectCache.put(beanName, object);
                    }
                }
            }
            return object;
        }
    }
    else {
        Object object = doGetObjectFromFactoryBean(factory, beanName);
        if (shouldPostProcess) {
            try {
                object = postProcessObjectFromFactoryBean(object, beanName);
            }
            catch (Throwable ex) {
                throw new BeanCreationException(beanName, "Post-processing of FactoryBean's object failed", ex);
            }
        }
        return object;
    }
}
复制代码

通过FactoryBean 获取对象

private Object doGetObjectFromFactoryBean(final FactoryBean<?> factory, final String beanName)
        throws BeanCreationException {

    Object object;
    try {
        // 这里是权限验证,不重要
        if (System.getSecurityManager() != null) {
            AccessControlContext acc = getAccessControlContext();
            try {
                object = AccessController.doPrivileged((PrivilegedExceptionAction<Object>) factory::getObject, acc);
            }
            catch (PrivilegedActionException pae) {
                throw pae.getException();
            }
        }
        else {
            // 直接调用 getObject()方法
            object = factory.getObject();
        }
    }
    catch (FactoryBeanNotInitializedException ex) {
        throw new BeanCurrentlyInCreationException(beanName, ex.toString());
    }
    catch (Throwable ex) {
        throw new BeanCreationException(beanName, "FactoryBean threw exception on object creation", ex);
    }

    // Do not accept a null value for a FactoryBean that's not fully
    // initialized yet: Many FactoryBeans just return null then.
    if (object == null) {
        if (isSingletonCurrentlyInCreation(beanName)) {
            throw new BeanCurrentlyInCreationException(
                    beanName, "FactoryBean which is currently in creation returned null from getObject");
        }
        object = new NullBean();
    }
    return object;
}
复制代码

  上述代码中最重要的一行就是 object = factory.getObject();。可以看到,这里的 factory 就是我们传入的 beanInstance。 在 getObjectForBeanInstance 中做了转换FactoryBean<?> factory = (FactoryBean<?>) beanInstance; 。 回到最初的起点,getBean(beanName) 通过 beanName 获取对象,最终得到的是调用 FactoryBeangetObject() 方法返回的对象。

何为 FactoryBean

  FactoryBean是一个工厂Bean,可以生成某一个类型Bean实例。通过使用 FactoryBean 我们可以自定义 Bean 的创建。在Spring中 FactoryBean 支持泛型。当在IOC容器中的Bean实现了FactoryBean后,通过getBean(String BeanName)获取到的Bean对象并不是FactoryBean 的实现类对象,而是这个实现类中的getObject()方法返回的对象。要想获取FactoryBean的实现类,就要getBean(&BeanName),在BeanName之前加上"&"。

public interface FactoryBean<T> {

 /**
  * 返回由FactoryBean创建的bean实例,如果 isSingleton返回true,则该实例会放置到spring容器中单实例缓存池中
  */
 @Nullable
 T getObject() throws Exception;

 /**
  * 返回FactoryBean 创建的实例Bean的类型
  */
 @Nullable
 Class<?> getObjectType();

 /**
  * 用来判断有FactoryBean创建的是bean的作用域
  */
 default boolean isSingleton() {
  return true;
 }
}
复制代码

  上述的 FactoryBean<T>接口, 就是Spring中定义好的接口。从上述接口中的方法我们可以看出:FactoryBean中定义了一个Spring Bean的很重要的三个特性:是否单例、Bean类型、Bean实例。下面我们就简单的使用一下 FactoryBean

FactoryBean接口的实现类

@Component
public class FactoryBeanTest implements FactoryBean<User> {
 @Override
 public User getObject() throws Exception {
  return new User();
 }

 @Override
 public Class<?> getObjectType() {
  return User.class;
 }

 @Override
 public boolean isSingleton() {
  return true;
 }
}
复制代码

  在上面的重写方法getObject() 方法中,我采用了 new 的方式来控制 Bean 的创建过程。

对象类

public class User {

 private String name;

 private int age;

 public String getName() {
  return name;
 }

 public void setName(String name) {
  this.name = name;
 }

 public int getAge() {
  return age;
 }

 public void setAge(int age) {
  this.age = age;
 }
}
复制代码

测试方法

public class FactoryBeanTest {
 public static void main(String[] args) {
  ApplicationContext ann = new AnnotationConfigApplicationContext(MyConfig.class);
  // 方式一
  FactoryBeanTest beanTest = ann.getBean(FactoryBeanTest.class);
  System.out.println(beanTest);
  // 方式二
  Object user = ann.getBean("factoryBeanTest");
  System.out.println(user);
  // 方式三
  Object user2 = ann.getBean("&factoryBeanTest");
  System.out.println(user2);
 }
}
复制代码

  程序运行结果如下:   从结果我们可以看出,通过类型 FactoryBeanTest.class 与通过使用 "&"+beanName 的方式(&factoryBeanTest);获取到的对象 是同一个,这个对象是就是 FactoryBean的实现类。而通过beanName 获取到的对象,就是通过 FactoryBeangetObject() 方法返回的对象。