Spring擴充介面之FactoryBean,我們來看看其原始碼實現

Java菜分享發表於2019-03-25

是什麼

FactoryBean的原始碼比較簡單,大家可以細讀下其註釋,我做了簡單的如下翻譯

/**
 * 實現此介面的bean不能用作普通bean。此bean暴露的物件是通過getObject()建立的物件,而不是它自身
 */
public interface FactoryBean<T> {
    /**
     * 返回此工廠管理的物件的例項(可能是共享的或獨立的,取決於isSingleton()的返回值)
     */
    @Nullable
    T getObject() throws Exception;
    /**
     * 返回此FactoryBean建立的物件型別,
     */
    @Nullable
    Class<?> 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/beans
    http://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/beans
    http://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> {
    @Override
    public User getObject() throws Exception {
        // 假設User的例項化過程比較複雜,在此處進行User的例項化
        return new User();
    }
    @Override
    public Class<?> getObjectType() {
        return User.class;
    }
    @Override
    public 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到底是怎麼用的

應用示例

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> {
    @Override
    public User getObject() throws Exception {
        // 假設User的例項化過程比較複雜,在此處進行User的例項化
        return new User();
    }
    @Override
    public Class<?> getObjectType() {
        return User.class;
    }
    @Override
    public boolean isSingleton() {
        return true;
    }
}
複製程式碼

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;
    }
}
複製程式碼

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 {
    @Autowired
    private BeanFactory beanFactory;
    @Test
    public void test() {
        Object user = beanFactory.getBean("user");
        System.out.println(user.getClass().getName());
    }
}
複製程式碼

我們執行測試用例,發現輸出的結果是:com.lee.factorybean.entity.User,而不是:com.lee.factorybean.config.UserFactoryBean

spring中的FactoryBean實現

Spring自身就提供了很多FactoryBean的實現(spring版本不一樣,實現數量不一樣),springboot2.0.3(對應spring5.0.7)中FactoryBean實現有如下

Spring擴充介面之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擴充介面之FactoryBean,我們來看看其原始碼實現


一開始從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方法建立我們需要的例項物件;大家自行跟下getObjectFromFactoryBean
        object = getObjectFromFactoryBean(factory, beanName, !synthetic);
    }
    return object;
}
複製程式碼

根據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加&即可;

歡迎工作一到五年的Java工程師朋友們加入Java程式設計師開發: 721575865

群內提供免費的Java架構學習資料(裡面有高可用、高併發、高效能及分散式、Jvm效能調優、Spring原始碼,MyBatis,Netty,Redis,Kafka,Mysql,Zookeeper,Tomcat,Docker,Dubbo,Nginx等多個知識點的架構資料)合理利用自己每一分每一秒的時間來學習提升自己,不要再用"沒有時間“來掩飾自己思想上的懶惰!趁年輕,使勁拼,給未來的自己一個交代!


相關文章