13. Spring 中的 FactoryBean 是什么？

PangHu大约 2 分钟

在Spring中，FactoryBean是一个特殊的Bean，它用于创建复杂对象或根据特定条件动态生成Bean实例。FactoryBean接口可以让你控制Spring容器中Bean的实例化逻辑，这对于需要创建复杂对象或在运行时决定Bean类型的场景非常有用。

如何定义`FactoryBean`

要定义一个FactoryBean，你需要实现FactoryBean接口。该接口主要包含三个方法：

Object getObject()：返回创建的Bean实例。
Class<?> getObjectType()：返回创建的Bean的类型。
boolean isSingleton()：返回创建的Bean是否是单例（singleton）。

下面是一个简单的示例，展示如何定义一个FactoryBean。

import org.springframework.beans.factory.FactoryBean;

// 自定义的FactoryBean，用于创建复杂的对象
public class MyFactoryBean implements FactoryBean<MyBean> {

    @Override
    public MyBean getObject() throws Exception {
        // 在这里自定义创建MyBean对象的逻辑
        MyBean myBean = new MyBean();
        myBean.setName("Factory Bean Example");
        return myBean;
    }

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

    @Override
    public boolean isSingleton() {
        return true; // 表示这个Bean是单例的
    }
}

如何使用`FactoryBean`

在Spring配置文件中，或者使用注解配置的时候，你可以像正常的Bean一样使用FactoryBean。使用&符号可以获取FactoryBean本身，而不是由FactoryBean生成的对象。

XML配置示例

<bean id="myFactoryBean" class="com.example.MyFactoryBean" />

通过myFactoryBean注入的对象实际上是MyBean的实例，而不是MyFactoryBean的实例。

注解配置示例

@Configuration
public class AppConfig {

    @Bean
    public MyFactoryBean myFactoryBean() {
        return new MyFactoryBean();
    }
}

获取`FactoryBean`本身

MyFactoryBean factoryBean = (MyFactoryBean) context.getBean("&myFactoryBean");

这里通过在Bean的ID前加上&，可以获取到FactoryBean本身，而不是它生产的Bean。

使用场景

创建复杂对象：有些对象的创建过程比较复杂，例如需要读取配置文件、依赖多个组件或其他复杂的初始化逻辑。
动态Bean：在运行时根据条件决定实例化的对象类型。例如，可以通过FactoryBean动态生成某个接口的不同实现类。

示例项目中的应用

假设你有一个应用程序需要根据不同的环境配置生成不同的数据库连接器对象，可以使用FactoryBean根据环境变量返回不同的数据库连接器实例。

public class DatabaseConnectorFactoryBean implements FactoryBean<DatabaseConnector> {
    
    private String dbType;

    public DatabaseConnectorFactoryBean(String dbType) {
        this.dbType = dbType;
    }

    @Override
    public DatabaseConnector getObject() throws Exception {
        if ("MYSQL".equalsIgnoreCase(dbType)) {
            return new MySQLDatabaseConnector();
        } else if ("POSTGRES".equalsIgnoreCase(dbType)) {
            return new PostgresDatabaseConnector();
        }
        return new DefaultDatabaseConnector();
    }

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

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

在这个例子中，DatabaseConnectorFactoryBean可以根据dbType来决定创建哪种类型的DatabaseConnector。

总结

FactoryBean提供了一种灵活的方法来控制Bean的创建过程，适用于需要复杂初始化逻辑或动态生成Bean实例的场景。通过实现FactoryBean接口，可以自定义Bean的创建逻辑，并且在Spring容器中以普通Bean的形式使用它。