【Spring源码】14.IOC之FactoryBean接口

image

1. FactoryBean接口介绍

1.1 FactoryBean接口源码

public interface FactoryBean<T> {

   String OBJECT_TYPE_ATTRIBUTE = "factoryBeanObjectType";

   @Nullable
   T getObject() throws Exception;

   default boolean isSingleton() {
      return true;
   }
}

1.2 作用

如果需要注册到Spring容器的Bean的类 实现了FactoryBean接口,实现了 该接口的 getObject()的方法的话,除了会注册当前类实例外,还会把额外的 getObject()返回的对象也注册到Spring容器中。

并且获取该Bean有以下规则:

  • beanName : 获取的是 getObject()返回的bean
  • &+beanName : 获取的是 该类 原生bean

1.2.1 测试

OriginalBean 类 实现 FactoryBean 接口, getObject() 返回 的是 ExposeBean类的对象。

@Data
@Component
public class OriginalBean implements FactoryBean {
    @Override
    public Object getObject() throws Exception {
        return new ExposeBean();
    }

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

测试获取bean

image

输出结果

image

可以看到 常规beanName 获取到的 对象 是 getObject()方法返回的 ExposeBean类的实例

&+beanName 获取到的 是 原生的 OriginalBean类实例

1.2.2 应用

在Mybatis集成Spring中, 扫描Mapper接口 ,实际注册的BeanClass是 MapperFactoryBean 类, MapperFactoryBean 类实现FactoryBean 接口

public class MapperFactoryBean<T> extends SqlSessionDaoSupport implements FactoryBean<T> {
   @Override
  public T getObject() throws Exception {
    return getSqlSession().getMapper(this.mapperInterface);
  }
}  

在 getObject()方法 返回实际的bean : Mapper 接口的代理对象。 所以后续可以直接注入 Mapper 接口类型的对象,进行数据库操作。

2. 实现FactoryBean接口 的bean创建 源码解析

2.1 原生实例 的 实例化

还是以上面的测试代码 为例,看看 OriginalBean 类的实例是如何初始化的

进入Spring遍历beanDefinitionNames,实例化bean的核心代码:

遍历到originalBean 这个beanName

image

2.1.1 判断该beanName 对应的类 是否是 FactoryBean 接口类型

首先 isFactoryBean(String name) 方法会判断该bean 的类型是否是FactoryBean 接口类型

首先看单例缓存 里是否有该BeanName对应的bean ,有直接返回

image

,第一次实例化肯定没有, 那么 就 从beanName对应的BeanDefinition对象里,取出 isFactoryBean 属性 看是否为true,true就是FactoryBean 接口类型

image

这里这个bean第一次实例化的时候 ,他的 BeanDefinition对象里,isFactoryBean 属性 就已经是 !=null 了

2.1.1.1. 第一次判断是否是 FactoryBean 接口类型,并赋值BeanDefinition对象.isFactoryBean 属性

如果==null ,就会根据beanClass,判断该类是否是FactoryBean 接口子类,并把结果赋值给 mbd.isFactoryBean。

这个判断并赋值操作 在该bean实例化之前就已经 做好了: 是在ApplicationContext 的 核心方法 refresh()里的invokeBeanFactoryPostProcessors(beanFactory)方法里,根据BeanDefinitionRegistryPostProcessor类型获取该类型的beanName集合的时候 完成的。

会判断所有的beanName对应的class是否是 FactoryBean 接口类型,并赋值给 mbd.isFactoryBean属性。

image
image

在这里就会先遍历容器里所有的beanNames, 执行isFactoryBean方法,

image

判断该beanName对应的 beanClass是否是 FactoryBean接口,并赋值

image

所有下次bean实例的话时候,直接根据BeanDefinition对象.isFactoryBean 属性 来判断是否是 FactoryBean 接口类型就行了。

2.1.2. 是FactoryBean 接口类型,创建原生bean

代码 回到 isFactoryBean返回结果之后,如果true,就会 &+ beanName去创建bean。

image
image

进入创建bean的流程,此时传进来的name = &+beanName,

会先对name 进行处理,去掉 &前缀 ,去缓存里获取beanName对应的bean,第一次缓存里没有

image

以beanName去创建bean

image

这里是创建bean 的方法 是个匿名接口,getSingleton 方法的ObjectFactory 接口的匿名实现类,创建出来的是原生bean,对应的beanName是 原生beanName

image

然后该方法的后续会 以beanName 和原生bean 作为映射,加入到 spring容器的单例池中

image
image

至此 原生bean 创建结束,加入单例缓存池中的 是 原生beanName -> 原生bean。

2.2. FactoryBean接口的getObject返回的bean注册

我们可以看到,直到所有的beanNames对应的bean都实例完成, 首先创建的 都是原生对象。

FactoryBean接口的getObject方法至今还没有调用,该方法返回的bean并没有注册,而是要等到 显示的 根据 原生beanName去获取该bean才会 注册。

这里我们 用代码测试一下,去根据原生beanName获取一下

image
image

又回到doGetBean()方法, 上次是 容器启动注册bean,这里是我们显式调用getBean调进来的。

这里 beanName是原生beanName,没有&前缀的,传进来的 beanName和name是完全相等的、

image

根据原生bean去单例缓存池 获取bean,刚才容器启动的时候 已经注册了 原生beanName和 原生bean的 缓存了,所以这里可以获取到bean,并且获取到的bean是原生bean。

接下来调用到 getObjectForBeanInstance方法,

image

2.2.1. 如果要获取原生bean

这里会进行name的判断,如果name含&前缀,说明是要返回原生bean,那么直接就返回 单例缓存池,根据原生beanName获取到的 bean

    public static boolean isFactoryDereference(@Nullable String name) {
        return (name != null && name.startsWith(BeanFactory.FACTORY_BEAN_PREFIX));
    }
image

2.2.2. 如果是获取没有FactoryBean接口的bean

再判断缓存池里获取到的bean 是不是FactoryBean接口 类型,不是的话,直接返回,我们平常没有实现FactoryBean接口的bean的获取,走的就是这个分支。

image

2.2.3. 如果是根据 原生beanName获取 actoryBean接口的getObject()返回的对象

这里我们是FactoryBean接口类型的实例 , 说明是要获取 FactoryBean接口的getObject()返回的对象

这里先从当前类BeanFactory的 factoryBeanObjectCache缓存里拿,这里又是一个缓存,不是 单例bean缓存池,存 原生beanName -> FactoryBean接口的getObject()返回的对象

image
image

BeanFactory类的 factoryBeanObjectCache成员变量

image

第一次根据原生beanName 从缓存里 获取FactoryBean接口的getObject()返回的对象 肯定没有值

所以把原生bean强转成FactoryBean接口类型,调用该接口的getObject()方法,返回bean

image

调用原实例的getObject方法

image
image

最后放入FactoryBean的缓存中 : 原生bean -> FactoryBean接口的getObject()返回的对象

下次根据原生bean 直接从缓存里获取并返回。
image

3. SmartFactoryBean 接口

SmartFactoryBean接口会继承 FactoryBean接口,会多提供一个isEagerInit 方法,用于决定是否提前 实例化 getObject方法返回的bean。

public interface SmartFactoryBean<T> extends FactoryBean<T> {

   default boolean isPrototype() {
      return false;
   }

   default boolean isEagerInit() {
      return false;
   }

如果是SmartFactoryBean接口类型,并且isEagerInit()方法 返回的是true,提前利用 原生bean 去getBean,触发 FactoryBean的getObject方法,注册该方法返回的bean.

image

4.总结

  1. 实现FactoryBean接口的类的bean要注册,除了该类原生的对象之外, 还会额外注册 FactoryBean接口的getObject()返回的bean。

  2. 在容器 实例化所有bean的时候,只会注册原生bean,FactoryBean接口的getObject()返回的bean 必要等到根据原生beanName显示getBean才会调用并注册。

  3. getBean方法获取bean时,传入name参数, beanName 始终 = 前缀&去掉的name参数,根据beanName去单例池获取原生bean。

    1. 如果name含有&,说明要获取的是原生bean, 直接返回原生bean。
    2. 如果name不包含&,原生bean 不是 FactoryBean接口实例,直接返回原生bean。
    3. 如果name不包含&,并且原生bean 是 FactoryBean接口实例,那么从 BeanFactory的FactoryBean.getObject实例缓存factoryBeanObjectCache里根据beanName拿,第一次缓存里没有, 调用 原生bean 实现至FactoryBean接口的getObject方法 ,返回 getObject()返回的bean,存入该缓存,下次直接从缓存里拿
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,657评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,889评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,057评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,509评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,562评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,443评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,251评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,129评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,561评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,779评论 3 335
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,902评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,621评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,220评论 3 328
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,838评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,971评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,025评论 2 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,843评论 2 354