Spring FactoryBean

2024-01-20 17:04
文章标签 java spring factorybean

本文主要是介绍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;}@Overridepublic Tool getObject() throws Exception {return new Tool(toolId);}@Overridepublic Class<?> getObjectType() {return Tool.class;}@Overridepublic boolean isSingleton() {return true; // 该例子中,每次都返回同一个 Tool 实例(单例)}
}

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

FactoryBean 在 Spring 中的处理

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

public abstract class AbstractBeanFactory extends FactoryBeanRegistrySupport implements ConfigurableBeanFactory {@Overrideprotected Object doGetBean(final String name, final Class<?> requiredType, final Object[] args, boolean typeCheckOnly)throws BeansException {// 其他代码省略...// 检查缓存中或实例化 SingletonObject 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,而不是系统的内部 FactoryBeanboolean 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 的高级特性。

这篇关于Spring FactoryBean的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/626708

相关文章

SpringBoot中六种批量更新Mysql的方式效率对比分析

《SpringBoot中六种批量更新Mysql的方式效率对比分析》文章比较了MySQL大数据量批量更新的多种方法,指出REPLACEINTO和ONDUPLICATEKEY效率最高但存在数据风险,MyB... 目录效率比较测试结构数据库初始化测试数据批量修改方案第一种 for第二种 case when第三种

Java docx4j高效处理Word文档的实战指南

《Javadocx4j高效处理Word文档的实战指南》对于需要在Java应用程序中生成、修改或处理Word文档的开发者来说,docx4j是一个强大而专业的选择,下面我们就来看看docx4j的具体使用... 目录引言一、环境准备与基础配置1.1 Maven依赖配置1.2 初始化测试类二、增强版文档操作示例2.

一文详解如何使用Java获取PDF页面信息

《一文详解如何使用Java获取PDF页面信息》了解PDF页面属性是我们在处理文档、内容提取、打印设置或页面重组等任务时不可或缺的一环,下面我们就来看看如何使用Java语言获取这些信息吧... 目录引言一、安装和引入PDF处理库引入依赖二、获取 PDF 页数三、获取页面尺寸(宽高)四、获取页面旋转角度五、判断

Spring Boot中的路径变量示例详解

《SpringBoot中的路径变量示例详解》SpringBoot中PathVariable通过@PathVariable注解实现URL参数与方法参数绑定,支持多参数接收、类型转换、可选参数、默认值及... 目录一. 基本用法与参数映射1.路径定义2.参数绑定&nhttp://www.chinasem.cnbs

JAVA中安装多个JDK的方法

《JAVA中安装多个JDK的方法》文章介绍了在Windows系统上安装多个JDK版本的方法,包括下载、安装路径修改、环境变量配置(JAVA_HOME和Path),并说明如何通过调整JAVA_HOME在... 首先去oracle官网下载好两个版本不同的jdk(需要登录Oracle账号,没有可以免费注册)下载完

Spring StateMachine实现状态机使用示例详解

《SpringStateMachine实现状态机使用示例详解》本文介绍SpringStateMachine实现状态机的步骤,包括依赖导入、枚举定义、状态转移规则配置、上下文管理及服务调用示例,重点解... 目录什么是状态机使用示例什么是状态机状态机是计算机科学中的​​核心建模工具​​,用于描述对象在其生命

Spring Boot 结合 WxJava 实现文章上传微信公众号草稿箱与群发

《SpringBoot结合WxJava实现文章上传微信公众号草稿箱与群发》本文将详细介绍如何使用SpringBoot框架结合WxJava开发工具包,实现文章上传到微信公众号草稿箱以及群发功能,... 目录一、项目环境准备1.1 开发环境1.2 微信公众号准备二、Spring Boot 项目搭建2.1 创建

Java中Integer128陷阱

《Java中Integer128陷阱》本文主要介绍了Java中Integer与int的区别及装箱拆箱机制,重点指出-128至127范围内的Integer值会复用缓存对象,导致==比较结果为true,下... 目录一、Integer和int的联系1.1 Integer和int的区别1.2 Integer和in

SpringSecurity整合redission序列化问题小结(最新整理)

《SpringSecurity整合redission序列化问题小结(最新整理)》文章详解SpringSecurity整合Redisson时的序列化问题,指出需排除官方Jackson依赖,通过自定义反序... 目录1. 前言2. Redission配置2.1 RedissonProperties2.2 Red

IntelliJ IDEA2025创建SpringBoot项目的实现步骤

《IntelliJIDEA2025创建SpringBoot项目的实现步骤》本文主要介绍了IntelliJIDEA2025创建SpringBoot项目的实现步骤,文中通过示例代码介绍的非常详细,对大家... 目录一、创建 Spring Boot 项目1. 新建项目2. 基础配置3. 选择依赖4. 生成项目5.