Spring拓展接口之FactoryBean
1、是什么
FactoryBean的源码比较简单，大家可以细读下其注释。
/**
* 实现此接口的bean不能用作普通bean。此bean暴露的对象是通过getObject()创建的对象，而不是它自身
*/
public interface FactoryBean {
/**
* 返回此工厂管理的对象的实例（可能是共享的或独立的，取决于isSingleton()的返回值）
*/
@Nullable
T getObject() throws Exception;
/**
* 返回此FactoryBean创建的对象类型,
*/
@Nullable
Class getObjectType();
/**
* 该工厂管理的对象是否为单例?
* 如果是(return true),getObject()总是返回同一个共享的实例，该对象会被BeanFactory缓存起来
* 如果是(return false),getObject()返回独立的实例
* 一般情况下返回true
*/
default boolean isSingleton() {
return true;
}
}
说的简单点，FactoryBean是BeanFactory支持的、用来暴露bean实例的接口
2、有什么用
平常比较常用的配置bean方式有哪几种？
1、基于XML的配置方式
在xml文件中配置，例如
spring的发布的第一版就支持，这个大家都知道
2、基于注解的配置方式
spring2.5开始支持，例如：@Compoment、@Repository、@Controller、@Service等，平时我们用的挺多的
3、基于Java类的配置方式
spring3.0开始支持，也是目前spring推荐的方式，@Configuration结合@Bean，springboot中用的非常多
一般情况下，Spring通过反射机制利用
xml配置
UserFactoryBean
public class UserFactoryBean implements FactoryBean {
@Override
public User getObject() throws Exception {
// 假设User的实例化过程比较复杂，在此处进行User的实例化
return new User();
}
@Override
public Class getObjectType() {
return User.class;
}
@Override
public boolean isSingleton() {
return true;
}
} spring2.5之前，只能通过xml的配置方式将Bean注册到spring管理，但是xml的配置方式又不够灵活，配置实例化过程比较复杂的Bean比较麻烦，所有结合FactoryBean，既能采用编码的方式构建实例化过程比较复杂的Bean，也能将Bean交由Spring管理；spring2.5之后，特别是spring3.0之后，注册实例化过程比较复杂的Bean到spring容器的方式就比较多了（可采用的编码方式比较多），FactoryBean的方式也一直被spring支持。
说的再简单点，通过FactoryBean可以创建实例化过程比较复杂的Bean，至于我们以何种方式将FactoryBean的实例注册到Spring容器，在不同的spring版本，可以采用不同的方式
怎么用
UserFactoryBean
@Component("user") // beanName = user
public class UserFactoryBean implements FactoryBean {
@Override
public User getObject() throws Exception {
// 假设User的实例化过程比较复杂，在此处进行User的实例化
return new User();
}
@Override
public Class getObjectType() {
return User.class;
}
@Override
public boolean isSingleton() {
return true;
}
} User
public class User { private Integer id; private String name; private Integer age; }FactoryBeanTest
@SpringBootTest
public class FactoryBeanTest {
@Autowired
private BeanFactory beanFactory;
@Test
public void test() {
Object user = beanFactory.getBean("user");
System.out.println(user.getClass().getName());
Object bean = beanFactory.getBean("&user");
System.out.println(bean.getClass().getName());
}
}
//输出
com.king.kingoeop.domain.User
com.king.kingoeop.factorybean.UserFactoryBean我们运行测试用例，发现输出的结果是：User，而不是：UserFactoryBean
为什么
具体问题应该是这样的：上述示例中，为什么从spring容器获取的name为user的实例，其类型是User，而不是UserFactoryBean；抽象的问题：根据FactoryBean实例的name获取的为什么不是FactoryBean实例，而是FactoryBean实例的getObject()返回的对象？
我们就以beanFactory.getBean("user");为断点入口进行源码分析，发现一开始从spring容器获取名为user的bean，类型确实是：UserFactoryBean，但是后面又经过getObjectForBeanInstance来真正获取我们需要的对象。
bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
/**
* 获取实例对象
* 可能是beanInstance自身，也可能是beanInstance创建的对象(如果beanInstance是FactoryBean类型)
*/
protected Object getObjectForBeanInstance(
Object beanInstance, String name, String beanName, @Nullable RootBeanDefinition mbd) {
// name以工厂引用(&)开头，可以跟下isFactoryDereference方法
if (BeanFactoryUtils.isFactoryDereference(name)) {
if (beanInstance instanceof NullBean) {
return beanInstance;
}
// 如果name以&开头，而beanInstance不是FactoryBean类型，则抛异常（我们没按spring规则来使用）
if (!(beanInstance instanceof FactoryBean)) {
throw new BeanIsNotAFactoryException(transformedBeanName(name), beanInstance.getClass());
}
}
// 如果beanInstance不是FactoryBean类型，则直接返回beanInstance
// 或者name以&开头，也直接返回beanInstance，说明我们就想获取FactoryBean实例
if (!(beanInstance instanceof FactoryBean) || BeanFactoryUtils.isFactoryDereference(name)) {
return beanInstance;
}
Object object = null;
if (mbd == null) {
object = getCachedObjectForFactoryBean(beanName);
}
if (object == null) {
// 此时beanInstance是FactoryBean类型，而name又不是以&开头; 这是我们示例工程的情况，也是最普通、用的最多的情况
// 将beanInstance强转成FactoryBean类型
FactoryBean factory = (FactoryBean) beanInstance;
// 从缓存中获取我们需要的实例对象
if (mbd == null && containsBeanDefinition(beanName)) {
mbd = getMergedLocalBeanDefinition(beanName);
}
boolean synthetic = (mbd != null && mbd.isSynthetic());
// 调用FactoryBean的getObject方法创建我们需要的实例对象；大家自行跟下getObjectFromFactoryBean
object = getObjectFromFactoryBean(factory, beanName, !synthetic);
}
return object;
}根据name从spring容器获取实例，如果该实例不是FactoryBean类型，则直接返回该实例，这也是我们平时用的最多的、最普通的情况；如果该实例是FactoryBean类型，而name又是以&开头，也直接返回该实例，说明我们想要的就是FactoryBean实例；如果name不是以&开头，而该实例又是FactoryBean类型，则会调用该实例的getObject()来创建我们需要的目标实例。
总结
- FactoryBean是BeanFactory支持的、用来暴露bean实例的接口，可以实现此接口来完成实例化过程比较复杂的bean的创建；
- 通过beanName从spring容器获取bean实例时，一开始获取的是beanName直接关联的bean实例，后续spring容器会根据此bean实例返回我们需要的对象实例；如果bean实例不是FactoryBean类型，则直接返回bean实例，如果bean实例是FactoryBean类型，而beanName又是以&开头，直接返回bean实例，如果bean实例是FactoryBean类型，而beanName不是以&开头，则返回bean实例的getObject()方法获取的对象实例（一般getObject中就是我们需要的实例对象的创建过程）；
- 对于创建过程比较复杂的对象的创建，目前spring其实有很多实现方式了，而FactoryBean只是其中一种，也许我们不会采用此种方式来实现实例对象的创建，但我们需要能够看懂此种方式，知道有这种实现方式；很多第三方都沿用了此种方式，我们去追源码的时候，很容易就能碰到；
- 相比普通bean的创建，FactoryBean的方式会在spring容器中多存在一个FactoryBean的实例，若想获取FactoryBean实例对象，只需要在FactoryBean的beanName加&即可；