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中四种AOP实战应用场景及代码实现

《SpringBoot中四种AOP实战应用场景及代码实现》面向切面编程(AOP)是Spring框架的核心功能之一,它通过预编译和运行期动态代理实现程序功能的统一维护,在SpringBoot应用中,AO... 目录引言场景一:日志记录与性能监控业务需求实现方案使用示例扩展:MDC实现请求跟踪场景二:权限控制与

Java NoClassDefFoundError运行时错误分析解决

《JavaNoClassDefFoundError运行时错误分析解决》在Java开发中,NoClassDefFoundError是一种常见的运行时错误,它通常表明Java虚拟机在尝试加载一个类时未能... 目录前言一、问题分析二、报错原因三、解决思路检查类路径配置检查依赖库检查类文件调试类加载器问题四、常见

Java注解之超越Javadoc的元数据利器详解

《Java注解之超越Javadoc的元数据利器详解》本文将深入探讨Java注解的定义、类型、内置注解、自定义注解、保留策略、实际应用场景及最佳实践,无论是初学者还是资深开发者,都能通过本文了解如何利用... 目录什么是注解?注解的类型内置注编程解自定义注解注解的保留策略实际用例最佳实践总结在 Java 编程

Java 实用工具类Spring 的 AnnotationUtils详解

《Java实用工具类Spring的AnnotationUtils详解》Spring框架提供了一个强大的注解工具类org.springframework.core.annotation.Annot... 目录前言一、AnnotationUtils 的常用方法二、常见应用场景三、与 JDK 原生注解 API 的

Java controller接口出入参时间序列化转换操作方法(两种)

《Javacontroller接口出入参时间序列化转换操作方法(两种)》:本文主要介绍Javacontroller接口出入参时间序列化转换操作方法,本文给大家列举两种简单方法,感兴趣的朋友一起看... 目录方式一、使用注解方式二、统一配置场景:在controller编写的接口,在前后端交互过程中一般都会涉及

Java中的StringBuilder之如何高效构建字符串

《Java中的StringBuilder之如何高效构建字符串》本文将深入浅出地介绍StringBuilder的使用方法、性能优势以及相关字符串处理技术,结合代码示例帮助读者更好地理解和应用,希望对大家... 目录关键点什么是 StringBuilder?为什么需要 StringBuilder?如何使用 St

使用Java将各种数据写入Excel表格的操作示例

《使用Java将各种数据写入Excel表格的操作示例》在数据处理与管理领域,Excel凭借其强大的功能和广泛的应用,成为了数据存储与展示的重要工具,在Java开发过程中,常常需要将不同类型的数据,本文... 目录前言安装免费Java库1. 写入文本、或数值到 Excel单元格2. 写入数组到 Excel表格

Java并发编程之如何优雅关闭钩子Shutdown Hook

《Java并发编程之如何优雅关闭钩子ShutdownHook》这篇文章主要为大家详细介绍了Java如何实现优雅关闭钩子ShutdownHook,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起... 目录关闭钩子简介关闭钩子应用场景数据库连接实战演示使用关闭钩子的注意事项开源框架中的关闭钩子机制1.

Maven中引入 springboot 相关依赖的方式(最新推荐)

《Maven中引入springboot相关依赖的方式(最新推荐)》:本文主要介绍Maven中引入springboot相关依赖的方式(最新推荐),本文给大家介绍的非常详细,对大家的学习或工作具有... 目录Maven中引入 springboot 相关依赖的方式1. 不使用版本管理(不推荐)2、使用版本管理(推

Java 中的 @SneakyThrows 注解使用方法(简化异常处理的利与弊)

《Java中的@SneakyThrows注解使用方法(简化异常处理的利与弊)》为了简化异常处理,Lombok提供了一个强大的注解@SneakyThrows,本文将详细介绍@SneakyThro... 目录1. @SneakyThrows 简介 1.1 什么是 Lombok?2. @SneakyThrows