Spring拓展接口之FactoryBean，咱們來看看其源碼實現

時間  2019-12-05
標籤 spring 拓展 接口 factorybean 咱們 看看 源碼 實現 欄目 Spring 简体版
原文   原文鏈接

前言

　　開心一刻git

　　　那年去相親，地點在飯店裏，威特先上了兩杯水，男方紳士的喝了一口，咧嘴咋舌輕放桌面，手撫額頭閉眼一臉陶醉，白水硬是喝出了82年拉菲的感受。如此有生活情調的幽默男人，果斷拿下，相處後卻發現他比較木訥，問他爲何那天喝水那麼有趣，他仰頭道：鬼知道那杯水怎麼那麼燙啊！spring

是什麼

　　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實例的接口springboot

有什麼用

　　先帶你們回憶下，目前咱們配置bean主要有哪幾種方式？app

　　一、基於XML的配置方式ide

　　　　在xml文件中配置，例如spring-boot

<?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的發佈的初版就支持，這個你們都知道測試

　　二、基於註解的配置方式ui

　　　　spring2.5開始支持，例如：@Compoment、@Repository、@Controller、@Service等，平時咱們用的挺多的this

　　三、基於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究竟是怎麼用的

　　應用示例

　　　　示例地址：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> {

    @Override
    public User getObject() throws Exception {
        // 假設User的實例化過程比較複雜，在此處進行User的實例化
        return new User();
    }

    @Override
    public Class<?> getObjectType() {
        return User.class;
    }

    @Override
    public 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 {

    @Autowired
    private BeanFactory beanFactory;

    @Test
    public 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方法建立咱們須要的實例對象；你們自行跟下getObjectFromFactoryBean
        object = 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

總結

　　一、FactoryBean是BeanFactory支持的、用來暴露bean實例的接口，能夠實現此接口來完成實例化過程比較複雜的bean的建立；

　　二、經過beanName從spring容器獲取bean實例時，一開始獲取的是beanName直接關聯的bean實例，後續spring容器會根據此bean實例返回咱們須要的對象實例；若是bean實例不是FactoryBean類型，則直接返回bean實例，若是bean實例是FactoryBean類型，而beanName又是以&開頭，直接返回bean實例，若是bean實例是FactoryBean類型，而beanName不是以&開頭，則返回bean實例的getObject()方法獲取的對象實例（通常getObject中就是咱們須要的實例對象的建立過程）；

　　三、對於建立過程比較複雜的對象的建立，目前spring其實有不少實現方式了，而FactoryBean只是其中一種，也許咱們不會採用此種方式來實現實例對象的建立，但咱們須要可以看懂此種方式，知道有這種實現方式；不少第三方都沿用了此種方式，咱們去追源碼的時候，很容易就能碰到；

　　四、相比普通bean的建立，FactoryBean的方式會在spring容器中多存在一個FactoryBean的實例，若想獲取FactoryBean實例對象，只須要在FactoryBean的beanName加&便可；

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程