Spring FactoryBean

FactoryBean 是 Spring 框架中的一个高级接口，用于声明一个 Spring bean，它本身作为一个工厂可以创建其他的对象。这个机制常用于框架集成，例如用来创建复杂的第三方库实例，或者创建需要大量配置的对象。

实现 FactoryBean 接口的类允许你将复杂的初始化逻辑封装在工厂类中，而工厂产生的对象就像普通的 Spring beans 一样，可以被注入到其他 beans 中。

FactoryBean 接口

FactoryBean 接口定义了三个主要的方法：

public interface FactoryBean<T> {

    T getObject() throws Exception; // 返回由 FactoryBean 创建的 bean 实例

    Class<?> getObjectType(); // 返回 FactoryBean 创建的 bean 类型

    boolean isSingleton(); // 该 FactoryBean 创建的 bean 实例是否是单例

    // 其他方法...
}

FactoryBean 使用示例

在深入源码之前，让我们先看一个 FactoryBean 的简单示例：

public class ToolFactoryBean implements FactoryBean<Tool> {

    private int factoryId;
    private int toolId;

    public void setFactoryId(int factoryId) {
        this.factoryId = factoryId;
    }

    public void setToolId(int toolId) {
        this.toolId = toolId;
    }

    @Override
    public Tool getObject() throws Exception {
        return new Tool(toolId);
    }

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

    @Override
    public boolean isSingleton() {
        return true; // 该例子中，每次都返回同一个 Tool 实例（单例）
    }
}

在这个例子中，通过实现 FactoryBean 接口，ToolFactoryBean 类能够在 Spring 容器中生产 Tool 类型的对象。

FactoryBean 在 Spring 中的处理

FactoryBean 的处理主要在 BeanFactory 的实现类中，如 AbstractBeanFactory 类。以下是一个简化版本的源码：

public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport implements ConfigurableBeanFactory {

    @Override
    protected Object doGetBean(final String name, final Class<?> requiredType, final Object[] args, boolean typeCheckOnly)
            throws BeansException {

        // 其他代码省略...

        // 检查缓存中或实例化 Singleton
        Object sharedInstance = getSingleton(beanName);
        if (sharedInstance != null) {
            // 返回对象实例，如果是 FactoryBean，则返回其创建的对象
            bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);
        } else {
            // 如果是非 Singleton 或需要新创建，则处理创建逻辑
            // 代码省略...
        }

        // 其他代码省略...
    }
    
    protected Object getObjectForBeanInstance(Object beanInstance, String name, String beanName, RootBeanDefinition mbd) {
        // 如果是 FactoryBean，则调用 getObject 从 FactoryBean 获取对象
        if (beanInstance instanceof FactoryBean) {
            Object object = getCachedObjectForFactoryBean(beanName);
            if (object == null) {
                FactoryBean<?> factory = (FactoryBean<?>) beanInstance;
                // 判断是否是用户定义的 FactoryBean，而不是系统的内部 FactoryBean
                boolean isUserDefinedFactoryBean = (mbd == null || !mbd.isSynthetic());
                
                object = getObjectFromFactoryBean(factory, beanName, !isUserDefinedFactoryBean);
            }
            return object;
        } else {
            return beanInstance;
        }
    }
    
    // 其他代码省略...
}

在 AbstractBeanFactory 中，doGetBean 方法负责获取 bean 实例。如果获取的是 FactoryBean 的实例，它会调用 getObjectForBeanInstance 方法，后者会检查缓存或者通过 FactoryBean 实例的 getObject 方法来获取实际的对象。

FactoryBeanRegistrySupport 类

FactoryBeanRegistrySupport 类是对 FactoryBean 的注册和缓存管理的实现。

public abstract class FactoryBeanRegistrySupport extends DefaultSingletonBeanRegistry {

    private final ConcurrentMap<String, Object> factoryBeanObjectCache = new ConcurrentHashMap<>();

    protected Object getCachedObjectForFactoryBean(String beanName) {
        Object object = this.factoryBeanObjectCache.get(beanName);
        return (object != NULL_OBJECT ? object : null);
    }

    protected Object getObjectFromFactoryBean(FactoryBean<?> factory, String beanName, boolean shouldPostProcess) {
        if (factory.isSingleton() && containsSingleton(beanName)) {
            synchronized (getSingletonMutex()) {
                Object object = this.factoryBeanObjectCache.get(beanName);
                if (object == null) {
                    object = doGetObjectFromFactoryBean(factory, beanName);
                    this.factoryBeanObjectCache.put(beanName, (object != null ? object : NULL_OBJECT));
                }
                return (object != NULL_OBJECT ? object : null);
            }
        } else {
            return doGetObjectFromFactoryBean(factory, beanName);
        }
    }

    private Object doGetObjectFromFactoryBean(final FactoryBean<?> factory, final String beanName) {
        try {
            return factory.getObject();
        } catch (Exception ex) {
            throw new BeanCreationException(beanName, "FactoryBean threw exception on object creation", ex);
        }
    }

    // 其他代码省略...
}

在 FactoryBeanRegistrySupport 类中，getObjectFromFactoryBean 方法处理了单例模式下 FactoryBean 的缓存逻辑，单例的 FactoryBean 创建的对象会被缓存起来。

总结

FactoryBean 提供了一种封装复杂对象创建逻辑的方式，并且能够整合到 Spring 容器的生命周期和依赖注入过程中。当你使用 FactoryBean 时，Spring 容器会调用 getObject 方法来创建实例，这个实例可以是单例也可以是非单例，取决于 isSingleton 方法的返回值。

深入理解 FactoryBean 的处理流程，有助于在涉及到复杂对象创建或需要与第三方库集成时，有效地使用 Spring 的高级特性。