文章目录
BeanFactory VS FactoryBean
首先明确一下,这两个东西是完全不同的两个东西 ,不要混淆。
BeanFactory 是Spring Framework的 *核心接口 , 没有这个接口,就没有Bean的产生。
FactoryBean也是一个接口,是一个特殊的Bean , 实现了FactoryBean 接口的Bean,原来的Bean将会被隐藏,而是由FactoryBean 的getObjecct方法返回最终的Bean 。 简单工厂模式 。
如果需要获取FactoryBean实例本身,需要 & 。
可以把FactoryBean理解为4S店,改装你原来的Bean。
FactoryBean VS 普通Bean
FactoryBean和普通Bean不同,其返回的对象不是指定类的一个实例,而是该FactoryBean的getObject方法所返回的对象。创建出来的对象是否属于单例由isSingleton中的返回决定。
演示
【Bean1】
package com.artisan.factoryBean;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
@Component
public class Bean1 {
@PostConstruct
public void init(){
System.out.println("bean1 create ");
}
}
【SpecialBeanFB 实现了 FactoryBean接口 】 用于装饰Bean
package com.artisan.factoryBean;
import org.springframework.beans.factory.FactoryBean;
import org.springframework.stereotype.Component;
import javax.annotation.PostConstruct;
@Component
public class SpecialBeanFB implements FactoryBean {
@PostConstruct
public void init(){
System.out.println("SpecialBean as Factory Bean create ");
}
@Override
public Object getObject() {
return new Bean2();
}
@Override
public Class<?> getObjectType() {
return Bean2.class;
}
@Override
public boolean isSingleton() {
return true;
}
}
如果SpecialBeanFB这个FactoryBean上的Component注解 增加了 name ,例如@Component("aaa")
其实是个getObject对象起的名字,而不是本身这个FactoryBean实例
当我们需要获取FactoryBean实例本身而不是它所产生的bean,要使用&符号
比如这里的 id为”specialBeanFB”的FactoryBean :
- 调用getBean(“specialBeanFB”)将返回FactoryBean产生的bean
- 调用getBean("&specialBeanFB")将返回FactoryBean它本身的实例
【配置类】
package com.artisan.factoryBean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
@Configuration
@ComponentScan("com.artisan.factoryBean")
public class FBConfig {
}
【测试类】
package com.artisan.factoryBean;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
public class FactoryBeanTest {
public static void main(String[] args) throws Exception {
// 实例化Spring Bean 容器
AnnotationConfigApplicationContext ac = new AnnotationConfigApplicationContext(FBConfig.class);
// 从bean容器中读取普通的bean
System.out.println(ac.getBean(Bean1.class));
System.out.println(ac.getBean("bean1"));
System.out.println("===========");
// 从bean容器中读取FactoryBean接口修饰的Bean
System.out.println(ac.getBean(SpecialBeanFB.class).getObject().getClass().getName());
System.out.println(ac.getBean("specialBeanFB"));
System.out.println("===========");
// 通过 & 获取 FactoryBean本身的bean对象
System.out.println(ac.getBean("&specialBeanFB"));
System.out.println("===========");
// 如果SpecialBeanFB这个FactoryBean上的Component注解 增加了 name ,例如@Component("aaa")
// 其实是个getObject对象起的名字,而不是本身这个FactoryBean实例
// System.out.println(ac.getBean("aaa"));
// System.out.println(ac.getBean("&aaa"));
}
}
【测试结果】
源码
在实例化Bean的方法中
AbstractApplicationContext # refresh()
---------- finishBeanFactoryInitialization(beanFactory)
----- DefaultListableBeanFactory#preInstantiateSingletons
在Spring容器启动阶段,会调用到refresh()方法,在refresh()中调用了finishBeanFactoryInitialization()方法,最终会调用到beanFactory.preInstantiateSingletons()方法
public void preInstantiateSingletons() throws BeansException {
// 从容器中获取到所有的beanName
List<String> beanNames = new ArrayList<>(this.beanDefinitionNames);
for (String beanName : beanNames) {
// 合并Bean ScannedGenericBeanDefinition AnnotatedGenericBeanDefinition 类型的Bean 等等 都要合并为 RootBeanDefinition 比较复杂,知道即可
RootBeanDefinition bd = getMergedLocalBeanDefinition(beanName);
// 创建Bean的条件校验
if (!bd.isAbstract() && bd.isSingleton() && !bd.isLazyInit()) {
// 在此处会根据beanName判断bean是不是一个FactoryBean,实现了FactoryBean接口的bean,会返回true
if (isFactoryBean(beanName)) {
// 然后通过getBean()方法去获取或者创建单例对象
// 注意:在此处为beanName拼接了一个前缀:FACTORY_BEAN_PREFIX 是一个常量字符串,即:&
// 所以在此时容器启动阶段,对于specialBeanFB,应该是:getBean("&specialBeanFB")
Object bean = getBean(FACTORY_BEAN_PREFIX + beanName);
// 下面这一段逻辑,是判断是否需要在容器启动阶段,就去实例化getObject()返回的对象,即是否调用FactoryBean的getObject()方法
if (bean instanceof FactoryBean) {
final FactoryBean<?> factory = (FactoryBean<?>) bean;
boolean isEagerInit;
if (System.getSecurityManager() != null && factory instanceof SmartFactoryBean) {
isEagerInit = AccessController.doPrivileged((PrivilegedAction<Boolean>)
((SmartFactoryBean<?>) factory)::isEagerInit,
getAccessControlContext());
}
else {
isEagerInit = (factory instanceof SmartFactoryBean &&
((SmartFactoryBean<?>) factory).isEagerInit());
}
if (isEagerInit) {
getBean(beanName);
}
}
}
}
}
}
使用场景
比如 MyBatis3 提供 mybatis-spring项目中的 org.mybatis.spring.SqlSessionFactoryBean
SqlSessionFactoryBean 看名字的结尾FactoryBean
public class SqlSessionFactoryBean implements FactoryBean<SqlSessionFactory>, InitializingBean, ApplicationListener<ApplicationEvent> {
// ...省略其他代码
public SqlSessionFactory getObject() throws Exception {
if (this.sqlSessionFactory == null) {
afterPropertiesSet();
}
return this.sqlSessionFactory;
}
}
sqlSessionFactory是SqlSessionFactoryBean的一个属性,它的赋值是在通过回调afterPropertiesSet()方法进行的。 因为SqlSessionFactoryBean实现了InitializingBean接口,所以在Spring初始化Bean的时候,能回调afterPropertiesSet()方法 .
public void afterPropertiesSet() throws Exception {
// buildSqlSessionFactory()方法会根据mybatis的配置进行初始化。
this.sqlSessionFactory = buildSqlSessionFactory();
}