究竟FactoryBean是什么？深入理解Spring的工厂神器

文章目录

- 前言
- 什么是FactoryBean？
- 如何使用FactoryBean？
- 我们常见的FactoryBean
- BeanFactory 和 FactoryBean？
- FactoryBean后续？MapperFactoryBean

前言

在Spring框架中，bean的创建通常交由Spring IoC容器负责，它提供了丰富的方式来创建和管理bean的生命周期。在众多的功能中，FactoryBean 以一种特别的方式出现，不仅让我们能够控制bean的创建过程，还使得更复杂的初始化逻辑变得简洁清晰。接下来，让我们一步步地走进FactoryBean的世界，并通过案例解析来透彻理解它在Spring应用中的使用。

什么是FactoryBean？

FactoryBean 是Spring提供的一种特殊的bean，使用它可以生成某些需要复杂初始化过程的bean对象。当配置某个bean实现了FactoryBean接口时，该bean返回的对象不是FactoryBean本身，而是FactoryBean#getObject()方法返回的对象，这就提供了一种扩展的可能，我们可以在这个方法里定制创建逻辑。

它与Spring其他bean的主要区别在于，FactoryBean负责产生其他bean实例。也即当我们从IOC容器中获取一个FactoryBean时，我们得到的是它创建的那个bean的实例，而不是FactoryBean的实例本身。

如何使用FactoryBean？

使用FactoryBean的情况一般是：

当我们注册的bean需要一系列复杂的初始化步骤。
我们需要创建一个非单例的bean，并且需要在运行时彻底实现某些操作，或者我们需要对bean实例进行精细控制。

实现FactoryBean非常简单，只需要：

声明一个类实现FactoryBean接口。
实现getObject()方法来定义创建对象的逻辑。
实现getObjectType()方法返回创建对象的类型。
通过实现isSingleton()方法来决定你的bean是原型还是单例。

假设我们有一个UserService类，它的创建过程比较复杂，需要从数据库中获取一些配置信息。我们可以使用FactoryBean来简化这个过程。

实现UserServiceFactoryBean类：

public class UserServiceFactoryBean implements FactoryBean<UserService> {private String config;// getter and setter methods...@Overridepublic UserService getObject() throws Exception {// 这里可以放一些复杂的逻辑，比如和其他系统交互，或者执行一些耗时操作UserService userService = new UserService();userService.setConfig(this.config);return userService;}@Overridepublic Class<?> getObjectType() {return UserService.class;}@Overridepublic boolean isSingleton() {return true;}
}

配置UserServiceFactoryBean：

<bean id="userService" class="com.example.UserServiceFactoryBean"><property name="config" value="some config"/>
</bean>

使用UserServiceFactoryBean：这里会通过UserServiceFactoryBean获取得到UserService

ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml");
UserService userService = (UserService) context.getBean("userService");

我们常见的FactoryBean

FactoryBean 的常见使用场景包括但不限于：

创建复杂的Bean，例如涉及到复杂配置和初始化流程的Bean。
延迟初始化资源或对象，因为getObject将在实际需要时被调用—比如解决循环依赖时，使用三级缓存存放的ObjectFactory用于提前AOP。
返回不同实例的代理，基于调用的上下文—ProxyFactoryBean创建代理对象。

其实很多场景的FactoryBean 可能都见过，只是可能没去总结归纳。我给小伙伴们举几个例子。

在 SSM 项目中，如果我们要配置 MyBatis 到项目中，一般需要配置下面这个 Bean：

<bean class="org.mybatis.spring.SqlSessionFactoryBean" id="sqlSessionFactoryBean"><property name="dataSource" ref="dataSource"/><property name="typeAliasesPackage" value="com.apple"/><property name="mapperLocations"><list><value>classpath*:com/apple/mapper/*.xml</value></list></property>
</bean>

我们在配置 Shiro 的时候，一般都要配置如下 Bean：

<bean class="org.apache.shiro.spring.web.ShiroFilterFactoryBean" id="shiroFilter"><property name="securityManager" ref="securityManager"/><property name="loginUrl" value="/login"/><property name="successUrl" value="/index"/><property name="unauthorizedUrl" value="/unauthorizedUrl"/><property name="filterChainDefinitions"><value>/index=anon/doLogin=anon/hello=user/**=authc</value></property>
</bean>

如果我们前端传递的参数是 key-value 格式，并且有一个日期，那么小伙伴们知道，服务端 SpringMVC 默认无法处理这个日期，需要配置一个日期转换器，一般我们在 Spring 容器中添加如下 Bean

<bean class="org.springframework.format.support.FormattingConversionServiceFactoryBean" id="conversionService"><property name="converters"><set><ref bean="myDateConverter"/></set></property>
</bean>
<mvc:annotation-driven conversion-service="conversionService"/>

我们观察上面三个 Bean 有一个共同的特点，那就是 Bean 的名字都是 xxxFactoryBean。

为什么要用 xxxFactoryBean 而不直接把需要的 Bean 注入到 Spring 容器中去呢？以 MyBatis 为例：

手动配置过 MyBatis 的小伙伴应该都知道，MyBatis 有两个重要的类，一个是 SqlSessionFactory，还有一个是 SqlSession，通过 SqlSessionFactory 可以获取到一个 SqlSession。

SqlSessionFactoryBean核心代码如下：其创建SqlSessionFactory复杂逻辑都在 afterPropertiesSet()

public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {private SqlSessionFactory sqlSessionFactory;@Overridepublic SqlSessionFactory getObject() throws Exception {if (this.sqlSessionFactory == null) {afterPropertiesSet();}return this.sqlSessionFactory;}@Overridepublic Class<? extends SqlSessionFactory> getObjectType() {return this.sqlSessionFactory == null ? SqlSessionFactory.class : this.sqlSessionFactory.getClass();}@Overridepublic boolean isSingleton() {return true;}
}

大家看一下，SqlSessionFactoryBean 需要实现 FactoryBean 接口，并且在实现接口的时候指定泛型是 SqlSessionFactory，也就是 SqlSessionFactoryBean 最终产出的 Bean 是 SqlSessionFactory。

这就是 FactoryBean 的特点，由于某一个 Bean 的初始化过于复杂，那么就可以通过 FactoryBean 来帮助注册到 Spring 容器中去。

BeanFactory 和 FactoryBean？

BeanFactory 是 Spring 框架的核心接口之一，用于管理和获取应用程序中的 Bean 实例。它是一个工厂模式的实现，负责创建、配置和管理 Bean 对象。BeanFactory 是 Spring IoC 容器的基础，它可以从配置元数据（如 XML 文件）中读取 Bean 的定义，并在需要时实例化和提供这些 Bean。
FactoryBean 是一个特殊的 Bean，它是一个工厂对象，用于创建和管理其他 Bean 的实例。FactoryBean 接口定义了一种创建 Bean 的方式，它允许开发人员在 Bean 的创建过程中进行更多的自定义操作。通过实现 FactoryBean 接口，开发人员可以创建复杂的 Bean 实例，或者在 Bean 实例化之前进行一些额外的逻辑处理。

区别在于，BeanFactory 是 Spring 框架的核心接口，用于管理和提供 Bean 实例，而 FactoryBean 是一个特殊的 Bean，用于创建和管理其他 Bean 的实例。FactoryBean 在 Bean 的创建过程中提供更多的自定义能力，允许进行额外的逻辑处理。

确切地烙印在记忆中：当你遇到需求类似"我需在Runtime时动态地配置我的bean" 或者 "我需要确保我的bean是复杂生产步骤下的产物"时，那么FactoryBean就是你的不二之选。