Spring中接口FactoryBean作用及说明

简述

在Spring容器里，Bean其实分两种：一种是普普通通的Bean，另一种是工厂Bean。前者靠反射机制，用Class属性直接实例化扔进容器；后者实现的是FactoryBean接口——当Bean的创建过程比较复杂，用XML配一堆细节实在不划算，编码的方式反而更清爽。说白了，FactoryBean就是让你自己定制Bean的实例化流程。

这个接口在Spring框架里地位不低，Spring自己就提供了好几十个实现，把那些复杂Bean的创建细节藏得严严实实，上层调用的时候省心不少。从Spring 3.0开始，FactoryBean也支持了泛型，接口声明变成了FactoryBean的形式，用起来更顺手。

Spring 官方文档中对 FactoryBean介绍

官方文档地址：https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#beans-factory-extension-factorybean

原文是这么说的：你可以为那些自身就是工厂的对象实现org.springframework.beans.factory.FactoryBean接口。这个接口实际上是Spring IoC容器实例化逻辑的一个可插拔点。如果你的初始化代码比较复杂，用Ja va写比用一长串XML配置更合适，那就自己写个FactoryBean，把那些复杂初始化逻辑塞进去，然后插到容器里就行。

FactoryBean接口提供了三个方法：

• T getObject()：返回工厂创建的对象实例。这个实例可能是单例也可能是原型，看具体实现。
• boolean isSingleton()：返回true表示单例，反之则否。默认实现返回true。
• Class getObjectType()：返回getObject()方法返回的对象类型，如果事先不知道类型可以返回null。

官方文档还提到，Spring框架内部有好多地方用到了FactoryBean的概念和接口，光Spring自带的实现就有50多个。另外，当你需要从容器里拿FactoryBean本身、而不是它产出的Bean时，只要在调用getBean()的时候给Bean的id前面加个&符号就行。比如，一个id为myBean的FactoryBean，getBean("myBean")返回的是它创建的产品，getBean("&myBean")返回的是FactoryBean实例本身。

简单概括一下：

1. Spring提供FactoryBean接口让你实现它来创建复杂Bean，避免繁琐的XML配置。
2. 三个方法：getObject()返回真正创建的Bean（不是FactoryBean本身）；isSingleton()决定单例还是原型，默认单例；getObjectType()返回getObject()的Class。
3. Spring框架内部有50多个FactoryBean实现。
4. 获取对象时，拿产品用getBean("myBean")，拿工厂本身用getBean("&myBean")。

实战

MySqlSession类：后续交与 MySqlSessionFactory 初始化

package com.lot.learn.spring.factorybean;

import lombok.Data;

@Data
public class MySqlSession {

    private Long id;

    public MySqlSession(Long id) {
        this.id = id;
    }
}

MySqlSessionFactory 实现 FactoryBean， 用于创建 MySqlSession

package com.lot.learn.spring.factorybean;

import lombok.Data;
import org.springframework.beans.factory.FactoryBean;

@Data
public class MySqlSessionFactory implements FactoryBean {

    private Long id;

    private Long sessionId;


    @Override
    public MySqlSession getObject() {
        return new MySqlSession(sessionId);
    }

    @Override
    public Class getObjectType() {
        return MySqlSession.class;
    }

    @Override
    public boolean isSingleton() {
        return true;
    }
    
}

spring-factorybean.xml

Ma ven 配置 dependencies

    
      org.springframework
      spring-context
      5.2.9.RELEASE
    
    
      org.springframework
      spring-jdbc
      5.2.9.RELEASE
    
    
      org.springframework
      spring-test
      5.2.9.RELEASE
    
  

测试类： TestFactoryBean

package factorybean;

import com.lot.learn.spring.factorybean.MySqlSession;
import com.lot.learn.spring.factorybean.MySqlSessionFactory;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = { "classpath*:spring-factorybean.xml" })
public class TestFactoryBean {


    @Autowired
    private MySqlSessionFactory userFactory1;

    @Autowired
    private MySqlSession mySqlSession1;

    @Autowired
    private ApplicationContext context;

    @Test
    public void test() {
        System.out.println("factory.getId() = " + userFactory1.getId());
        // 我们并没有配置 MySqlSession 仍可以注入
        System.out.println("mySqlSession.getId() = " + mySqlSession1.getId());

        // by Type
        MySqlSession mySqlSession2 = context.getBean(MySqlSession.class);
        MySqlSessionFactory userFactory2 = context.getBean(MySqlSessionFactory.class);

        // by name
        MySqlSession mySqlSession3 = (MySqlSession) context.getBean("mySqlSession");
        MySqlSessionFactory userFactory3 = (MySqlSessionFactory) context.getBean("&mySqlSession");

		// 以下都是 true
        System.out.println("mySqlSession1 == mySqlSession2 :" + (mySqlSession1 == mySqlSession1));
        System.out.println("userFactory1 == userFactory2 :" + (userFactory1 == userFactory1));

        System.out.println("mySqlSession2 == mySqlSession3 :" + (mySqlSession2 == mySqlSession3));
        System.out.println("userFactory2 == userFactory3 :" + (userFactory2 == userFactory3));
    }
}

测试类执行结果

从打印结果看，上面说的那些特性都验证了：

factory.getId() = 9999
mySqlSession.getId() = 1
mySqlSession1 == mySqlSession2 :true
userFactory1 == userFactory2 :true
mySqlSession2 == mySqlSession3 :true
userFactory2 == userFactory3 :true

代替方案

说实话，现在用FactoryBean创建对象的场景越来越少了，因为有了更方便的替代方式：

• @Configuration配合@Bean注解，作用跟FactoryBean差不多，但功能更强——支持懒加载、可以设置作用域等等。
• @Component也够用，简单场景直接注解就行。

总结

关于FactoryBean，核心就几点：它帮你把复杂Bean的创建逻辑从XML挪到Ja va代码里，通过三个方法控制创建过程，容器获取时用&前缀区分工厂本身和产品。虽然现在有了更现代的注解方式，但理解FactoryBean对深入掌握Spring IoC容器还是很有帮助的。