外观
08 - FactoryBean、BeanFactory 与 ObjectProvider
适用版本:Spring Framework 6.x。
前置阅读:03 - getBean() 背后的单例 Bean 创建链路和04 - Spring 如何完成依赖注入。本文讨论
getBean()在普通 Bean 创建完成后的特殊返回值处理。
摘要
BeanFactory、FactoryBean 和 ObjectFactory 名字相似,职责却完全不同。本文从“为什么 Mapper 接口能注入”切入,解释容器、工厂 Bean、产品对象和延迟获取,并说明 &beanName、产品缓存与类型判断中的常见陷阱。
1. 场景:接口没有实现类,为什么能调用
MyBatis Mapper、RPC Client 等组件常以接口形式注入。Mapper 是声明数据库操作的接口,RPC Client 是调用远程服务的客户端。接口本身不能实例化,调用方能够执行接口方法,是因为框架生成了实现该接口的代理对象,并在方法调用时执行数据库访问或远程调用。
接入 Spring 时,一个常见方案就是注册 FactoryBean:Spring 先管理这个工厂 Bean,再通过它取得调用方需要的代理对象。下文把工厂返回的对象称为产品对象。产品不一定是代理,也可以是需要特殊创建步骤的普通对象。
2. 三个概念不要混用
| 类型 | 职责 |
|---|---|
BeanFactory | Spring IoC 容器基础接口,负责查找、创建和管理 Bean |
FactoryBean<T> | 容器中的一个特殊 Bean,负责生产某类对象 |
ObjectFactory<T> | 轻量对象获取回调,调用 getObject() 时取得对象,常用于延迟获取 |
IoC(控制反转)在这里指把对象的创建和依赖组装交给容器。Bean 是容器管理的对象;BeanFactory 是管理它们的入口,FactoryBean 则是被管理的对象之一。ObjectFactory 只约定如何获取对象,并不负责管理整个容器,也不要求每次调用都创建新对象。
ObjectProvider<T> 扩展了 ObjectFactory<T>,增加可选获取、候选选择和按顺序遍历等能力。这里的候选是容器中符合所请求类型及注入条件的 Bean。它与 FactoryBean 没有直接的继承关系,也不是更高级的 BeanFactory。
3. FactoryBean 的双重身份
下面是 FactoryBean 的核心接口方法:
java
public interface FactoryBean<T> {
T getObject() throws Exception;
Class<?> getObjectType();
default boolean isSingleton() { return true; }
}getObject() 提供产品,getObjectType() 描述产品类型,isSingleton() 声明产品是否具有单例语义,即是否应共享同一个实例。
BeanDefinition 是容器保存的 Bean 定义,描述如何创建 Bean 以及它的作用域等信息。假设名为 client 的 BeanDefinition 对应一个 FactoryBean:
text
getBean("client") -> FactoryBean 生产的 Client
getBean("&client") -> FactoryBean 本身& 是解引用工厂的特殊前缀:它让容器返回工厂本身,而不是工厂生产的对象。这个规则适用于对应 Bean 是 FactoryBean 的情况;普通 Bean 名仍返回普通 Bean。
可以把获取链拆成两步:
text
先按 BeanDefinition 创建或获取 FactoryBean 实例
→ 名称带 &:返回 FactoryBean 本身
→ 名称不带 &:返回已缓存产品,或调用 getObject() 取得产品因此异常中的 Bean 名称相同,也要判断失败发生在“工厂 Bean 创建”还是“产品对象创建”。前者属于普通 Bean 生命周期,后者发生在 FactoryBean 产品解析阶段。
4. 示例:注册工厂并获取产品
以下代码按工厂、配置和使用方式分段展示,需要放入 Spring Framework 6.x 项目中组合使用。项目需要 spring-context 依赖;@Bean 方法应放在标注 @Configuration 的配置类中,并导入这两个注解。context 表示已加载该配置的 AnnotationConfigApplicationContext,使用时需导入对应类型。
java
import java.lang.reflect.Proxy;
import org.springframework.beans.factory.FactoryBean;
interface GreetingClient {
String hello(String name);
}
class GreetingClientFactoryBean implements FactoryBean<GreetingClient> {
@Override
public GreetingClient getObject() {
return (GreetingClient) Proxy.newProxyInstance(
GreetingClient.class.getClassLoader(),
new Class<?>[]{GreetingClient.class},
(proxy, method, args) -> "hello, " + args[0]);
}
@Override
public Class<?> getObjectType() {
return GreetingClient.class;
}
@Override
public boolean isSingleton() {
return true;
}
}配置中的方法名 greetingClient 就是这里使用的 Bean 名称:
java
@Bean
GreetingClientFactoryBean greetingClient() {
return new GreetingClientFactoryBean();
}使用时按名称获取产品,按带 & 的名称获取工厂:
java
GreetingClient client = context.getBean("greetingClient", GreetingClient.class);
GreetingClientFactoryBean factory = context.getBean(
"&greetingClient", GreetingClientFactoryBean.class);调用 client.hello("Spring") 的预期返回值为 hello, Spring。JDK 的 Proxy.newProxyInstance() 生成实现 GreetingClient 的代理,第三个参数中的回调接收方法调用,示例用第一个参数拼接返回值。
这个回调只演示 hello(String) 的处理方式,没有分别处理 toString()、equals()、hashCode() 等 Object 方法,不能作为完整客户端代理实现使用。
5. 产品对象的单例语义
作用域(scope)决定容器如何创建和复用 Bean。singleton 表示在该容器中复用一个实例,prototype 表示每次请求创建新实例。对于 FactoryBean,BeanDefinition 的作用域控制工厂实例;isSingleton() 描述工厂提供的产品。两者需要分别判断。
例如,上面的 getObject() 每次执行都会创建新代理,但常规单例工厂配合 isSingleton() == true 时,容器会缓存产品,后续获取可以直接返回缓存,而不再执行该方法。直接调用 factory.getObject() 则没有经过容器的产品缓存路径。
还要把产品复用与产品是否经过代理包装分开:
| 对象或处理阶段 | 管理方式 | 判断依据 |
|---|---|---|
| FactoryBean 实例 | BeanFactory 的 Scope | BeanDefinition 的 scope |
| FactoryBean 产品 | FactoryBean 产品缓存 | isSingleton() 及容器获取路径 |
| 产品外层代理 | BeanPostProcessor 可能对产品进行包装 | Advisor 是否匹配产品对象 |
BeanPostProcessor 是参与对象加工的后处理器;用于 AOP(面向切面编程)的处理器可以为产品添加事务等增强。Advisor 组合了增强逻辑及其匹配规则。是否包装产品属于加工问题,并不是第三种独立的缓存规则。
因此,单例工厂仍可以声明非单例产品;产品的单例声明也不能替代对工厂作用域的检查。尤其是非单例工厂,不能直接套用前面的单例工厂缓存路径。
5.1 类型预测为什么困难
按类型注入需要先找出哪些 Bean 能满足依赖,因此容器可能在创建产品前就查询产品类型。getObjectType() 应尽可能准确,并避免网络访问、文件操作或重量级初始化等副作用,否则一次类型查找也可能触发耗时工作。
返回 null 表示暂时无法确定产品类型,可能影响按类型发现;返回过宽的类型,例如 Object.class,则可能无法满足调用方按具体接口查找的需求。示例返回 GreetingClient.class,描述的是产品接口,而不是工厂类。
Spring 还可能从泛型签名、BeanDefinition 属性或工厂方法返回类型推断产品类型;精确策略属于版本相关实现。框架组件应提供稳定、无副作用的类型信息,并在目标 Spring 版本验证按类型查找。
6. ObjectProvider 的适用场景
ObjectProvider<T> 把“注入获取入口”和“取得目标 Bean”分开。对于可选的导出功能,可以先注入 Provider,再在执行导出时获取 Exporter。
下面是局部业务代码,需要导入 org.springframework.beans.factory.ObjectProvider,定义带有 export() 方法的 Exporter 类型,并将 ExportService 注册为容器管理的 Bean:
java
class ExportService {
private final ObjectProvider<Exporter> provider;
ExportService(ObjectProvider<Exporter> provider) {
this.provider = provider;
}
void runIfPresent() {
Exporter exporter = provider.getIfAvailable();
if (exporter != null) {
exporter.export();
}
}
}如果没有可用的 Exporter,这个方法跳过导出;如果获取目标时发生创建异常,异常仍会向调用方传播。Provider 适合可选依赖、延迟获取和多个候选的遍历。它不意味着每次调用都得到新对象,实际复用仍由目标 Bean 的作用域决定。
注入 ObjectProvider<Exporter> 延迟的是当前依赖点对 Exporter 的获取,不会让持有 Provider 的 Bean 自动变成懒加载。若目标是需要在容器启动时预先创建的非懒加载单例,或其他 Bean 直接依赖它,目标仍可能提前创建;Provider 也不会保证目标创建失败后自动重试成功。
调用方法也表达不同契约:
getObject():必须取得对象,否则抛异常;getIfAvailable():允许没有候选,但候选不唯一仍可能失败;getIfUnique():能够确定唯一候选时返回,也包括多个候选中能选出主候选的情况;没有候选或无法确定唯一候选时返回null;orderedStream():按容器的排序规则遍历候选,例如Ordered接口或@Order注解指定的顺序。
业务必需依赖仍应优先使用普通构造器参数,让错误在启动或对象创建阶段尽早暴露。也应避免让业务代码到处主动查找服务;这种把查找依赖的职责交给调用方的方式称为 Service Locator(服务定位器),容易使依赖关系变得不直观。
7. 验证工厂与产品身份
在第 4 节的配置已加载、工厂保持默认单例作用域的条件下,可用下面的片段比较引用。== 比较的是是否为同一个对象,不是两个对象的内容是否相同。使用 AopUtils 还需要 spring-aop 依赖,并导入 org.springframework.aop.support.AopUtils。
java
Object product1 = context.getBean("greetingClient");
Object product2 = context.getBean("greetingClient");
Object factory = context.getBean("&greetingClient");
System.out.println(product1.getClass());
System.out.println("same product: " + (product1 == product2));
System.out.println("factory type: " + factory.getClass());
System.out.println("product is proxy: " + AopUtils.isAopProxy(product1));在没有额外 Spring AOP 包装的条件下,预期 same product 为 true,工厂类型为 GreetingClientFactoryBean,产品类型为 JDK 动态生成的代理类,具体类名随运行环境变化。
这里的 product is proxy 标签容易产生歧义:AopUtils.isAopProxy() 判断的是 Spring AOP 代理。示例直接用 JDK Proxy 创建产品,因此在上述条件下这一行预期为 false,并不表示产品不是动态代理。判断是否为 JDK 动态代理类可以使用 Proxy.isProxyClass(product1.getClass())。
再把 isSingleton() 改为 false,重新创建上下文后比较两次产品引用:由于本例的 getObject() 每次创建新代理,预期 same product 为 false。这不代表所有非单例产品都必然返回不同引用,还要检查工厂自身的实现。这个实验只验证当前 FactoryBean 实现和容器配置,不能据此推断所有 FactoryBean 的缓存策略。
8. 容易踩的坑
- 忘记
&,拿到产品对象后强转 FactoryBean 失败。 getObjectType()返回null,导致按类型发现和自动装配受影响。- 在
getObject()中执行无界远程调用,阻塞 Bean 创建。 - 错误声明
isSingleton(),使调用方对状态共享产生错误预期。 - 把负责生产产品的
FactoryBean与管理 Bean 的BeanFactory混为一谈。 - 以为
ObjectProvider会吞掉目标 Bean 创建异常或候选冲突。 - 类型预测阶段触发网络、文件或重量级对象初始化。
9. 排障清单
- BeanDefinition 对应的是普通类还是 FactoryBean?
- 当前要查看工厂本身还是产品对象?
- 产品类型是否可被
getObjectType()正确预测? - 产品是否被二次 AOP 代理?
- FactoryBean 与产品对象各自的单例语义是什么?
- 异常来自 FactoryBean 自身生命周期,还是来自
getObject()? - 按类型查找时容器获得的预测类型是什么?
10. 总结
BeanFactory 提供容器管理 Bean 的基础接口,FactoryBean 在容器中生产产品对象,ObjectProvider 为调用方提供延迟获取能力。
- 对于 FactoryBean,普通名称返回产品,
&name才返回工厂本身。 - FactoryBean 与产品对象拥有各自的生命周期和缓存语义。
- 延迟获取应解决明确的生命周期问题,而不是掩盖错误依赖设计。
阅读导航
getBean()主流程:03 - getBean() 背后的单例 Bean 创建链路- Provider 如何参与依赖解析:04 - Spring 如何完成依赖注入
- 产品对象如何继续被加工:06 - BeanPostProcessor
- 产品对象的动态代理:09 - Spring AOP 如何创建代理
- Starter 如何注册 FactoryBean:17 - Spring Boot 自动配置与条件装配