Spring拓展接口之FactoryBean,我们来看看其源码实现

2024-03-19 00:20

本文主要是介绍Spring拓展接口之FactoryBean,我们来看看其源码实现,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

前言

  开心一刻

   那年去相亲,地点在饭店里,威特先上了两杯水,男方绅士的喝了一口,咧嘴咋舌轻放桌面,手抚额头闭眼一脸陶醉,白水硬是喝出了82年拉菲的感觉。如此有生活情调的幽默男人,果断拿下,相处后却发现他比较木讷,问他为什么那天喝水那么有趣,他仰头道:鬼知道那杯水怎么那么烫啊!

是什么

  FactoryBean的源码比较简单,大家可以细读下其注释,我做了简单的如下翻译

/*** 实现此接口的bean不能用作普通bean。此bean暴露的对象是通过getObject()创建的对象,而不是它自身*/
public interface FactoryBean<T> {/*** 返回此工厂管理的对象的实例(可能是共享的或独立的,取决于isSingleton()的返回值)*/@NullableT getObject() throws Exception;/*** 返回此FactoryBean创建的对象类型,*/@NullableClass<?> getObjectType();/*** 该工厂管理的对象是否为单例?* 如果是(return true),getObject()总是返回同一个共享的实例,该对象会被BeanFactory缓存起来* 如果是(return false),getObject()返回独立的实例* 一般情况下返回true*/default boolean isSingleton() {return true;}}

  说的简单点,FactoryBean是BeanFactory支持的、用来暴露bean实例的接口

有什么用

  先带大家回忆下,目前我们配置bean主要有哪几种方式?

  1、基于XML的配置方式

    在xml文件中配置,例如

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-4.1.xsd"><bean id="user" class="com.lee.factorybean.User"><property name="name" value="zhangsan"/></bean>    
</beans>

    spring的发布的第一版就支持,这个大家都知道

  2、基于注解的配置方式

    spring2.5开始支持,例如:@Compoment、@Repository、@Controller、@Service等,平时我们用的挺多的

  3、基于Java类的配置方式

    spring3.0开始支持,也是目前spring推荐的方式,@Configuration结合@Bean,springboot中用的非常多

  一般情况下,Spring通过反射机制利用<bean>的class属性指定实现类实例化Bean,在某些情况下,实例化Bean过程比较复杂,如果按照传统的xml方式,则需要在<bean>中提供大量的配置信息。xml配置方式的灵活性是受限的,这时采用编码的方式可能会得到一个简单的方案。那么编码方式又有哪些了?spring3.0之后,编码的方式有基于注解、基于Java类以及基于FactoryBean,那么在spring2.5之前了,如何用xml方式配置实例化过程比较复杂的Bean?可以采用xml结合FactoryBean来实现,xml中配置FactoryBean,FactoryBean创建我们需要的、实例化过程比较复杂的Bean,示例核心代码如下,从spring容器获取name为user的bean实例,获取到的是User类型的Bean

  xml配置

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beanshttp://www.springframework.org/schema/beans/spring-beans-4.1.xsd"><bean id="user" class="com.lee.factorybean.config.UserFactoryBean" />
</beans>

  UserFactoryBean

package com.lee.factorybean.config;import com.lee.factorybean.entity.User;
import org.springframework.beans.factory.FactoryBean;public class UserFactoryBean implements FactoryBean<User> {@Overridepublic User getObject() throws Exception {// 假设User的实例化过程比较复杂,在此处进行User的实例化return new User();}@Overridepublic Class<?> getObjectType() {return User.class;}@Overridepublic boolean isSingleton() {return true;}
}

  spring2.5之前,只能通过xml的配置方式将Bean注册到spring管理,但是xml的配置方式又不够灵活,配置实例化过程比较复杂的Bean比较麻烦,所有结合FactoryBean,既能采用编码的方式构建实例化过程比较复杂的Bean,也能将Bean交由Spring管理;spring2.5之后,特别是spring3.0之后,注册实例化过程比较复杂的Bean到spring容器的方式就比较多了(可采用的编码方式比较多),FactoryBean的方式也一直被spring支持。

  说的再简单点,通过FactoryBean可以创建实例化过程比较复杂的Bean,至于我们以何种方式将FactoryBean的实例注册到Spring容器,在不同的spring版本,可以采用不同的方式

怎么用

  我们通过一个简单的示例来看看FactoryBean到底是怎么用的

  应用示例

    示例地址:spring-boot-FactoryBean

    UserFactoryBean

package com.lee.factorybean.config;import com.lee.factorybean.entity.User;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.stereotype.Component;@Component("user")          // beanName = user
public class UserFactoryBean implements FactoryBean<User> {@Overridepublic User getObject() throws Exception {// 假设User的实例化过程比较复杂,在此处进行User的实例化return new User();}@Overridepublic Class<?> getObjectType() {return User.class;}@Overridepublic boolean isSingleton() {return true;}
}
View Code

    User

package com.lee.factorybean.entity;public class User {private Integer id;private String name;private Integer age;public Integer getId() {return id;}public void setId(Integer id) {this.id = id;}public String getName() {return name;}public void setName(String name) {this.name = name;}public Integer getAge() {return age;}public void setAge(Integer age) {this.age = age;}
}
View Code

    FactoryBeanTest

package com.lee.factorybean.test;import com.lee.factorybean.FactoryBeanApplication;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.BeanFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;@RunWith(SpringRunner.class)
@SpringBootTest
public class FactoryBeanTest {@Autowiredprivate BeanFactory beanFactory;@Testpublic void test() {Object user = beanFactory.getBean("user");System.out.println(user.getClass().getName());}}
View Code

    我们运行测试用例,发现输出的结果是:com.lee.factorybean.entity.User,而不是:com.lee.factorybean.config.UserFactoryBean

  spring中的FactoryBean实现

    Spring自身就提供了很多FactoryBean的实现(spring版本不一样,实现数量不一样),springboot2.0.3(对应spring5.0.7)中FactoryBean实现有如下

    除了我们自定义的UserFactoryBean,有60个是springboot中的实现,其中有50多个是spring中的实现;有兴趣的可以细看下,注意springboot版本,如果直接用的spring,则注意spring的版本

  实际工作中,我们自己实现FactoryBean的场景非常少,反正我工作中是用的非常少,印象中有,但感觉是很久之前的事了;Spring中有很多FactoryBean的实现,也有很多第三方的实现,比如MyBatis的MapperFactoryBean、druid的JdbcStatManagerFactoryBean、shiro的ShiroFilterFactoryBean等等。用不用FactoryBean,全看我们个人,但我们一定得知道FactoryBean,当我们碰到FactoryBean的实现时(读源码很容易碰到),我们一眼就能明白其意图,当我们需要构建实例化过程比较复杂的Bean时,FactoryBean也是一种可选的方案

为什么

  具体问题应该是这样的:上述示例中,为什么从spring容器获取的name为user的实例,其类型是User,而不是UserFactoryBean;抽象的问题:根据FactoryBean实例的name获取的为什么不是FactoryBean实例,而是FactoryBean实例的getObject()返回的对象? 

  源码探究

    我们就以beanFactory.getBean("user");为断点入口

@Test
public void test() {// 断点入口Object user = beanFactory.getBean("user");System.out.println(user.getClass().getName());
} 

    一开始从spring容器获取名为user的bean,类型确实是:UserFactoryBean,但是后面又经过getObjectForBeanInstance来真正获取我们需要的对象

bean = getObjectForBeanInstance(sharedInstance, name, beanName, null);/*** 获取实例对象* 可能是beanInstance自身,也可能是beanInstance创建的对象(如果beanInstance是FactoryBean类型)*/
protected Object getObjectForBeanInstance(Object beanInstance, String name, String beanName, @Nullable RootBeanDefinition mbd) {// name以工厂引用(&)开头,可以跟下isFactoryDereference方法if (BeanFactoryUtils.isFactoryDereference(name)) {if (beanInstance instanceof NullBean) {return beanInstance;}// 如果name以&开头,而beanInstance不是FactoryBean类型,则抛异常(我们没按spring规则来使用)if (!(beanInstance instanceof FactoryBean)) {throw new BeanIsNotAFactoryException(transformedBeanName(name), beanInstance.getClass());}}// 如果beanInstance不是FactoryBean类型,则直接返回beanInstance// 或者name以&开头,也直接返回beanInstance,说明我们就想获取FactoryBean实例if (!(beanInstance instanceof FactoryBean) || BeanFactoryUtils.isFactoryDereference(name)) {return beanInstance;}Object object = null;if (mbd == null) {object = getCachedObjectForFactoryBean(beanName);}if (object == null) {// 此时beanInstance是FactoryBean类型,而name又不是以&开头; 这是我们示例工程的情况,也是最普通、用的最多的情况// 将beanInstance强转成FactoryBean类型FactoryBean<?> factory = (FactoryBean<?>) beanInstance;// 从缓存中获取我们需要的实例对象if (mbd == null && containsBeanDefinition(beanName)) {mbd = getMergedLocalBeanDefinition(beanName);}boolean synthetic = (mbd != null && mbd.isSynthetic());// 调用FactoryBean的getObject方法创建我们需要的实例对象;大家自行跟下getObjectFromFactoryBeanobject = getObjectFromFactoryBean(factory, beanName, !synthetic);}return object;
}
View Code

    根据name从spring容器获取实例,如果该实例不是FactoryBean类型,则直接返回该实例,这也是我们平时用的最多的、最普通的情况;如果该实例是FactoryBean类型,而name又是以&开头,也直接返回该实例,说明我们想要的就是FactoryBean实例;如果name不是以&开头,而该实例又是FactoryBean类型,则会调用该实例的getObject()来创建我们需要的目标实例

  如何获取FactoryBean实例

    这个答案在上面已经有了,通过在name前加&即可,如下

@Test
public void test() {Object user = beanFactory.getBean("&user");System.out.println(user.getClass().getName());
}

    输出结果如下

com.lee.factorybean.config.UserFactoryBean

总结

  1、FactoryBean是BeanFactory支持的、用来暴露bean实例的接口,可以实现此接口来完成实例化过程比较复杂的bean的创建;

  2、通过beanName从spring容器获取bean实例时,一开始获取的是beanName直接关联的bean实例,后续spring容器会根据此bean实例返回我们需要的对象实例;如果bean实例不是FactoryBean类型,则直接返回bean实例,如果bean实例是FactoryBean类型,而beanName又是以&开头,直接返回bean实例,如果bean实例是FactoryBean类型,而beanName不是以&开头,则返回bean实例的getObject()方法获取的对象实例(一般getObject中就是我们需要的实例对象的创建过程);

  3、对于创建过程比较复杂的对象的创建,目前spring其实有很多实现方式了,而FactoryBean只是其中一种,也许我们不会采用此种方式来实现实例对象的创建,但我们需要能够看懂此种方式,知道有这种实现方式;很多第三方都沿用了此种方式,我们去追源码的时候,很容易就能碰到;

  4、相比普通bean的创建,FactoryBean的方式会在spring容器中多存在一个FactoryBean的实例,若想获取FactoryBean实例对象,只需要在FactoryBean的beanName加&即可;

转载于:https://www.cnblogs.com/youzhibing/p/10528821.html

这篇关于Spring拓展接口之FactoryBean,我们来看看其源码实现的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

JVM 的类初始化机制

前言 当你在 Java 程序中new对象时,有没有考虑过 JVM 是如何把静态的字节码(byte code)转化为运行时对象的呢,这个问题看似简单,但清楚的同学相信也不会太多,这篇文章首先介绍 JVM 类初始化的机制,然后给出几个易出错的实例来分析,帮助大家更好理解这个知识点。 JVM 将字节码转化为运行时对象分为三个阶段,分别是:loading 、Linking、initialization

Spring Security 基于表达式的权限控制

前言 spring security 3.0已经可以使用spring el表达式来控制授权,允许在表达式中使用复杂的布尔逻辑来控制访问的权限。 常见的表达式 Spring Security可用表达式对象的基类是SecurityExpressionRoot。 表达式描述hasRole([role])用户拥有制定的角色时返回true (Spring security默认会带有ROLE_前缀),去

浅析Spring Security认证过程

类图 为了方便理解Spring Security认证流程,特意画了如下的类图,包含相关的核心认证类 概述 核心验证器 AuthenticationManager 该对象提供了认证方法的入口,接收一个Authentiaton对象作为参数; public interface AuthenticationManager {Authentication authenticate(Authenti

Spring Security--Architecture Overview

1 核心组件 这一节主要介绍一些在Spring Security中常见且核心的Java类,它们之间的依赖,构建起了整个框架。想要理解整个架构,最起码得对这些类眼熟。 1.1 SecurityContextHolder SecurityContextHolder用于存储安全上下文(security context)的信息。当前操作的用户是谁,该用户是否已经被认证,他拥有哪些角色权限…这些都被保

Spring Security基于数据库验证流程详解

Spring Security 校验流程图 相关解释说明(认真看哦) AbstractAuthenticationProcessingFilter 抽象类 /*** 调用 #requiresAuthentication(HttpServletRequest, HttpServletResponse) 决定是否需要进行验证操作。* 如果需要验证,则会调用 #attemptAuthentica

Spring Security 从入门到进阶系列教程

Spring Security 入门系列 《保护 Web 应用的安全》 《Spring-Security-入门(一):登录与退出》 《Spring-Security-入门(二):基于数据库验证》 《Spring-Security-入门(三):密码加密》 《Spring-Security-入门(四):自定义-Filter》 《Spring-Security-入门(五):在 Sprin

Java架构师知识体认识

源码分析 常用设计模式 Proxy代理模式Factory工厂模式Singleton单例模式Delegate委派模式Strategy策略模式Prototype原型模式Template模板模式 Spring5 beans 接口实例化代理Bean操作 Context Ioc容器设计原理及高级特性Aop设计原理Factorybean与Beanfactory Transaction 声明式事物

Java进阶13讲__第12讲_1/2

多线程、线程池 1.  线程概念 1.1  什么是线程 1.2  线程的好处 2.   创建线程的三种方式 注意事项 2.1  继承Thread类 2.1.1 认识  2.1.2  编码实现  package cn.hdc.oop10.Thread;import org.slf4j.Logger;import org.slf4j.LoggerFactory

hdu1043(八数码问题,广搜 + hash(实现状态压缩) )

利用康拓展开将一个排列映射成一个自然数,然后就变成了普通的广搜题。 #include<iostream>#include<algorithm>#include<string>#include<stack>#include<queue>#include<map>#include<stdio.h>#include<stdlib.h>#include<ctype.h>#inclu

康拓展开(hash算法中会用到)

康拓展开是一个全排列到一个自然数的双射(也就是某个全排列与某个自然数一一对应) 公式: X=a[n]*(n-1)!+a[n-1]*(n-2)!+...+a[i]*(i-1)!+...+a[1]*0! 其中,a[i]为整数,并且0<=a[i]<i,1<=i<=n。(a[i]在不同应用中的含义不同); 典型应用: 计算当前排列在所有由小到大全排列中的顺序,也就是说求当前排列是第