Spring源码学习(五) 创建Bean过程中的扩展点

936 阅读4分钟

引言

上班挺累
事事都烦
写篇文章
兑现诺言

一图胜所有

getbean的扩展点
getbean的扩展点

绿色的部一般用于Spring内部扩展,黄色的部分可用于自定义实例化。 本文仅仅聊聊InitializingBean,对于绿色部分,建议您查看,其他人写的blog my.oschina.net/xiaolyuh/bl…

InitializingBean接口

接口注释

/**
 * 1. 实现的接口是个Bean,BeanFactory设置它所有的属性后触发。
 * 2. 可用于执行自定义实例化或校验必要的属性是否被设置。
 * 注:实现InitializingBean的另外一种方式是,
 *    制定一个自定义的init method,
 *    通过<bean> 元素的 init-method或者,使用@PostConstruct注解
*/
public interface InitializingBean {
   void afterPropertiesSet() throws Exception;
}

应用举例

找具体例子时,我鬼使神差的找到了mybatis与Spring结合的时候用到的SqlSessionFactoryBean类,实现如下:

public class SqlSessionFactoryBean implements 
FactoryBean<SqlSessionFactory>, 
InitializingBean, ApplicationListener<ApplicationEvent> {
    public void afterPropertiesSet() throws Exception {
      notNull(dataSource, "Property 'dataSource' is required");
      notNull(sqlSessionFactoryBuilder, "Property 'sqlSessionFactoryBuilder' is required");
      state((configuration == null && configLocation == null) 
      || !(configuration != null && configLocation != null),
  "Property 'configuration' and 'configLocation' can not specified with together");
  this.sqlSessionFactory = buildSqlSessionFactory();
}
    
   //省略其他实现 ...
   }

afterPropertiesSet的实现很简单,就是创建了SqlSessionFactory。比起afterPropertiesSet,FactoryBean接口更令我好奇,待我仔细阅读了FactoryBean的注释,发现上边的图少了一个重要扩展点。

另一个重要扩展FactoryBean

解决实例化Bean过程比较复杂的问题,可以实现该FactoryBean接口定制实例化Bean的逻辑.
尽管FactoryBean以bean的风格定义,但是它总是对外暴露getObject()创建的对象。 -- 温安适总结于 20191013

FactoryBean的编程契约如下

  1. 它的实现不应该依赖注解注入或者其他反射工具
  2. getObjectType(),getObject()的调用早于服务启动,甚至早于任何 post-processor
  3. 如果你需要获取其他的Bean,你需要实现BeanFactoryAware接口,并手动编程获取其他bean。
  4. 最后FactoryBean对象参与BeanFactory的同步创建bean的过程,通常不需要内部同步,除了懒加载FactoryBean本身时。

注释翻译

/**
 *  1. 实现这个接口的是个bean,与BeanFactory结合使用。
 *  2. 它自己是单个对象的工厂。
 *  3.FactoryBean 支持单例和原形,并能按需提供懒加载或启动时提前暴露。
 *  4. SmartFactoryBean允许暴露更多细粒度行为元数据
 *  5.Spring框架本身大量使用这个接口,
 *   例如{@link org.springframework.aop.framework.ProxyFactoryBean},
 * {@link org.springframework.jndi.JndiObjectFactoryBean}。
 */
public interface FactoryBean<T> {

   /**
    * 返回一个被当前工厂管理的实例(可能共享或独立)
    * 与BeanFactory结合,支持单例,原形模式。
    * 如果FactoryBean在被调用时没有完全的加载(例如存在循环引用)
    * 将抛出FactoryBeanNotInitializedException。
    * Spring 2.0以后,FactoryBeans允许返回null,
    * 返回null时,不在抛出FactoryBeanNotInitializedException,
    * FactoryBean的实现会视情况而定,
    *是否抛出FactoryBeanNotInitializedException
    * BeanFactory的实现必须考虑这种情况.
    */
   @Nullable
   T getObject() throws Exception;

   /**
    * 返回FactoryBean创建对象的类型,如果事先不知道返回null
    *允许在实例化对象时检查特定类型的bean(例如用于自动装配时)。
    *在创建单例对象的实现时,该方法应尽量避免单例创建,它应该提前估计类型。
    *在创建原形类型的object时,也建议返回有意义的类型信息。
    *这个方法,可以在FactoryBean完全实例化之前调用。它不能依赖于初始化。
    *注意:自动注入将简单忽略factoryBean,这个方法会返回null。
    *因此,强烈建议使用factorybean的当前状态正确地实现此方法。
    */
   @Nullable
   Class<?> getObjectType();

   /**
    * 返回true时, getobject()
    * 将始终返回相同的对象。
    * 注意:如果一个factorybean保存一个单例对象,
    * 从 getObject()返回的对象
    * 可能被拥有它的BeanFaFactory缓存。
    * factorybean本身的单例状态通常是由拥有它的BeanFactory确定;
    */
   default boolean isSingleton() {
      return true;
   }

}

BeanFactory与FactoryBean区别

接口名称 BeanFactory FactoryBean
用途 BeanFactory是IOC容器的顶层接口。它的职责包括:实例化、定位、配置应用程序中的对象及建立这些对象间的依赖 解决实例化Bean过程比较复杂的问题。通过实现该接口定制实例化Bean的逻辑
管理的对象 所有bean getObject方法创建的对象