Spring FactoryBean接口

说明:

  1. 本文基于Spring-Framework 5.1.x版本讲解

  2. 建议读者对Mybatis有基本的使用经验

概述

这一篇我们讲讲org.springframework.beans.factory.FactoryBean接口，这个接口功能非常强大，可以集成不同的中间件或组件到Spring容器中来，可以说该接口是打通Spring与外界沟通的重要桥梁，是Spring非常重要的一个拓展点。 不少人会拿BeanFactory与FactoryBean做比较，其实这两个接口根本就没有可比性，完全不是一个’层次‘的产物。废话不多说，让我们开始吧。

FactoryBean

先看下FatoryBean接口在源码中的定义

/** * Interface to be implemented by objects used within a {@link BeanFactory} which * are themselves factories for individual objects. If a bean implements this * interface, it is used as a factory for an object to expose, not directly as a * bean instance that will be exposed itself. * * 
NB: A bean that implements this interface cannot be used as a normal bean. * A FactoryBean is defined in a bean style, but the object exposed for bean * references ({@link #getObject()}) is always the object that it creates. * * 
FactoryBeans can support singletons and prototypes, and can either create * objects lazily on demand or eagerly on startup. The {@link SmartFactoryBean} * interface allows for exposing more fine-grained behavioral metadata. * * 
This interface is heavily used within the framework itself, for example for * the AOP {@link org.springframework.aop.framework.ProxyFactoryBean} or the * {@link org.springframework.jndi.JndiObjectFactoryBean}. It can be used for * custom components as well; however, this is only common for infrastructure code. * * 
{@code FactoryBean} is a programmatic contract. Implementations are not * supposed to rely on annotation-driven injection or other reflective facilities. * {@link #getObjectType()} {@link #getObject()} invocations may arrive early in the * bootstrap process, even ahead of any post-processor setup. If you need access to * other beans, implement {@link BeanFactoryAware} and obtain them programmatically. * * 
The container is only responsible for managing the lifecycle of the FactoryBean * instance, not the lifecycle of the objects created by the FactoryBean. Therefore, * a destroy method on an exposed bean object (such as {@link java.io.Closeable#close()} * will not be called automatically. Instead, a FactoryBean should implement * {@link DisposableBean} and delegate any such close call to the underlying object. * * 
Finally, FactoryBean objects participate in the containing BeanFactory's * synchronization of bean creation. There is usually no need for internal * synchronization other than for purposes of lazy initialization within the * FactoryBean itself (or the like). * * @author Rod Johnson * @author Juergen Hoeller * @since 08.03.2003 * @param  the bean type * @see org.springframework.beans.factory.BeanFactory * @see org.springframework.aop.framework.ProxyFactoryBean * @see org.springframework.jndi.JndiObjectFactoryBean */public interface FactoryBean {T getObject() throws Exception;Class getObjectType();default boolean isSingleton() {return true; }}

从接口描述信息中我们可以得到以下几点关键信息：

1. 实现了BeanFactory接口的Bean，实际上对外暴露的是getObject方法返回的对象；

2. FactoryBean支持创建单例和原型Bean，可以通过懒加载或容器启动时加载的方式创建Bean，可以实现SmartFactoryBean接口来控制更多的Bean创建方式；

3. Spring只会管理FactoryBean对象本身，通过FactoryBean#getObject创建出来的对象的生命周期则不会由Spring管理。 也就是说通过getObject返回的对象本身即使实现了生命周期接口，也不会被调用；

第2、3点不在我们的讨论范围之内，也比较好理解，我们把关注点放在第1点这上。 通过getObject方法来创建对象？ 我直接用@Bean的方式不行吗？ 其实是可以的，在创建简单对象的场景中，直接使用@Bean甚至比使用BeanFactory的方式更合理、更简单。 那BeanFactory的使用场景到底是什么？ 如果实现一个需求，@Bean与BeanFactory两种创建Bean的方式如何选择？

提供下我的思路供参考：

1. 如果你已经明确了要创建的Bean对象的Class的时候，这时候直接使用@Bean即可，如果无法拿到Class，则使用BeanFactory的方式。例如，你作为一个框架编写者，创建哪些Bean往往是由上层的框架使用者来决定的，这种情况下使用@Bean肯定是不行的，所以一定要用BeanFactory

2. 假设你可以拿到要创建的Bean对象的Class，但是不想暴露太多的Bean对象创建细节，如复杂的Bean创建过程，这种情况也可以使用BeanFactory 。但是什么才是复杂的Bean？如何不暴露创建细节？这个就需要你自己有非常足够多的说服力了。

所以个人认为，第一点才是决策的关键

我们在来简单解释下为什么说文中开始部分提到的BeanFactory与FactoryBean不是同一个层次的产物，相信你大概有所体会： BeanFactory 是Bean工厂、是容器，我们创建的Bean都在BeanFactory 中；而FactoryBean 只是容器创建Bean提供的一种方式而已， 可以说FactoryBean就是为BeanFactory 服务的。

好，我们下面再来举个Spring集成Mybatis的例子加深下对FactoryBean 的理解

Spring集成Mybatis

我们的业务代码中操作数据库，少不了使用@Resource、@Autowired等注解注入Mybatis的Mapper对象的场景， 这就说明这些Mapper对象的实例一定在Spring容器的管理之中，再往下想想，这些Mapper对象是如何被Spring纳入其中的？ 其实就少不了 FactoryBean 接口的功劳， 想象一下你站在Mybatis框架实现者的角度，使用@Bean注解知否能实现？

我们看下框架实际是如何集成的，这里免不了贴一下源码，大家耐心看。

一、我们要知道Mapper文件的位置, Spring才能绑我们扫描, 但是光扫描还不行，因为Spring只会把扫描出来的Class转换为beanDefinition并放在DefaultListableBeanFactory#beanDefinitionMap容器中，Spring就是根据beanDefinitionMap的内容来帮我们创建Bean的， 可是现阶段我们只有Mapper的Class，直接把Mapper的Class放到beanDefinitionMap中，Spring只会创建该Class的实例，那结果肯定是无法实例化的。我们需要找到一种类似于’占位符‘的机制，先把这个’占位符‘放入beanDefinitionMap 中，在实际使用时，在通过’占位符‘把实际的Bean对象构建出来

这时候FactoryBean 就登场了，FactoryBean类似于上述中的’占位符‘， 由于FactoryBean 的特性，我们完全可以把FactoryBean 先注册到beanDefinitionMap中，在实际使用阶段，我们可以通过getObject方法从SqlSessionFactory中拿到Mybatis为我们创建好的的Mapper代理对象了

package org.mybatis.spring.mapper;public class ClassPathMapperScanner extends ClassPathBeanDefinitionScanner {      private String sqlSessionFactoryBeanName;  // MapperFactoryBean 实现了FactoryBean接口  private MapperFactoryBean mapperFactoryBean = new MapperFactoryBean