Spring拓展介面之FactoryBean，我們來看看其源碼實現

来源:https://www.cnblogs.com/youzhibing/archive/2019/03/25/10528821.html
-Advertisement-
Play Games

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


前言

　　開心一刻

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

是什麼

　　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到底是怎麼用的

　　應用示例

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

總結

　　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加&即可；


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • jQuery中頁面返回頂部的方法總結
    當頁面過長時，通常會在頁面下方有一個返回頂部的button，總結一下，大概三種實現方法，下麵說下各方法及優缺點。 方法一 錨點定位 ? 1 <a href="#" class="top" id="top">返回頂部</a> ? 1 <a href="#" class="top" id="top">返 ...
  • 簡單幾步用純CSS3實現3D翻轉效果
    作為前端開發人員的必修課，CSS3翻轉能帶我們完成許多基本動效，本期我們將用CSS3實現hover翻轉效果~ 第一步非常簡單，我們簡單畫1個演示方塊，為其 添加transition和transform屬性 ： ? 1 2 3 4 5 6 7 8 9 10 11 // 本示例均使用Sass語法 .bl ...
  • jQuery元素操作
    jQuery中創建元素及追加元素 DOM中可以動態創建元素:document.createElement(“標簽的名字”); jQuery中同樣可以創建元素標簽,並且返回的就是jQuery對象,可以直接調用方法進行使用 1.append 方法用來在元素的末尾追加元素（最後一個子節點）。增加元素末尾 ...
  • 個人博客建站最全解析
    大家好~又見面了。 今天呢我想給大家，也給我自己， 對我的個人網站yanyy.cn/yanyy 做一個全面的整理和分析。 也給有這方面想法的朋友一個參考。 做網站的有愛好也有帶有目的性的。 不過我還是希望大家能夠傳播正能量~ 進入正題 網站首頁 看到上圖，是網站的首頁。 首頁上用戶直接看得到的部分有 ...
  • react中圖片校驗碼實現以及new Buffer()使用方法
    圖片校驗碼原理就是圖片是後端生成的前端只是前後端傳過來的數據流做些處理展示即可，先直接上核心代碼圖： 這裡就是簡單得對axios的一些預設項屬性重寫：最後你只需要將resolve的內容插入頁面的<img src="resolve（data:img/png;base64,&{base64}）">即可， ...
  • Friendly Date Ranges 讓日期區間更友好
    把常見的日期格式如：YYYY-MM-DD 轉換成一種更易讀的格式。 易讀格式應該是用月份名稱代替月份數字，用序數詞代替數字來表示天 (1st 代替 1). 記住不要顯示那些可以被推測出來的信息: 如果一個日期區間里結束日期與開始日期相差小於一年，則結束日期就不用寫年份了；在這種情況下，如果月份開始和 ...
  • 2019年北航OO第一次博客總結
    一、基於度量對程式結構的分析 1. 第一次作業 1.1 基於類的分析的度量 首先，基於類的屬性個數，方法個數，每個方法的規模，每個方法的控制分支數目，類總代碼規模等特征對本次作業的結構進行分析。 1.2 基於類間內聚和耦合的度量 我使用了MetricsReloaded插件來對代碼的複雜度進行了分析。 ...
  • Sentry快速開始並集成釘釘群機器人
    Sentry（直譯為：哨兵）是一個開源錯誤跟蹤服務，幫助開發人員實時監控和修複崩潰 Sentry本質上是一種幫助您實時監控和修複崩潰的服務 1. 安裝客戶端SDK 這裡我們安裝Java平臺的SDK，而且使用logback的方式集成 https://docs.sentry.io/clients/jav ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類