Java中的SPI原理淺談

来源:https://www.cnblogs.com/wha6239/archive/2022/09/19/16692713.html
-Advertisement-
Play Games

在面向對象的程式設計中,模塊之間交互採用介面編程,通常情況下調用方不需要知道被調用方的內部實現細節,因為一旦涉及到了具體實現,如果需要換一種實現就需要修改代碼,這違反了程式設計的"開閉原則"。所以我們一般有兩種選擇:一種是使用API(Application Programming Interface ...


  在面向對象的程式設計中,模塊之間交互採用介面編程,通常情況下調用方不需要知道被調用方的內部實現細節,因為一旦涉及到了具體實現,如果需要換一種實現就需要修改代碼,這違反了程式設計的"開閉原則"。所以我們一般有兩種選擇:一種是使用API(Application Programming Interface),另一種是SPI(Service Provider Interface),API通常被應用程式開發人員使用,而SPI通常被框架擴展人員使用。

  在進入下麵學習之前,我們先來再加深一下API和SPI這兩個的印象:

  API:由實現方制定介面標準並完成對介面的不同實現,這種模式服務介面從概念上更接近於實現方;

  SPI:由調用方制定介面標準,實現方來針對介面提供不同的實現;從前半句話我們來看,SPI其實就是"為介面查找實現"的一種服務發現機制;這種模式,服務介面組織上位於調用方所在的包中,實現位於獨立的包中。

  API和SPI簡略圖示:

  

  看完上面的簡單圖示,相信大家對API和SPI的區別有了一個大致的瞭解,現在我們使用SPI機制來實現我們一個簡單的日誌框架:

  第一步,創建一個maven項目命名為spi-interface,定義一個SPI對外服務介面,用來後續提供給調用者使用;

package cn.com.wwh;
/**
 * 
 * @FileName Logger.java
 * @version:1.0
 * @Description: 服務提供者介面
 * @author: wwh
 * @date: 2022年9月19日 上午10:31:53
 */
public interface Logger {
    
    /**
     * 
     * @Description:(功能描述)
     * @param msg
     */
    public void info(String msg);
    
    /**
     * 
     * @Description:(功能描述)
     * @param msg
     */
    public void debug(String msg);
}
package cn.com.wwh;

import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.ServiceLoader;

/**
 * 
 * @FileName LoggerService.java
 * @version:1.0
 * @Description: 為服務的調用者提供特定的功能,是SPI的核心功能
 * @author: wwh
 * @date: 2022年9月19日 上午10:33:30
 */
public class LoggerService {

    private static final LoggerService INSTANCE = new LoggerService();

    private final Logger logger;                          

    private final List<Logger> loggers = new ArrayList<>();

    private LoggerService() {
     //ServiceLoader是實現SPI的核心類 ServiceLoader
<Logger> sl = ServiceLoader.load(Logger.class); Iterator<Logger> it = sl.iterator(); while (it.hasNext()) { loggers.add(it.next()); } if (!loggers.isEmpty()) { logger = loggers.get(0); } else { logger = null; } } /** * @Description:(功能描述) * @return */ public static LoggerService getLoggerService() { return INSTANCE; } /** * * @Description:(功能描述) * @param msg */ public void info(String msg) { if (logger == null) { System.err.println("在info方法中沒有找到Logger的實現類..."); } else { logger.info(msg); } } /** * * @Description:(功能描述) * @param msg */ public void debug(String msg) { if (logger == null) { System.err.println("在debug方法中沒有找到Logger的實現類..."); } else { logger.info(msg); } } }

  將上面這個這個項目打成spi-interface.jar包。

  第二步,新建一個maven項目並導入第一步中打出來的spi-interface.jar包,這個項目用來提供服務的實現,定義一個類,實現第一步中定義的cn.com.wwh.Logger介面,示例代碼如下:

package cn.com.wwh;

import cn.com.pep.Logger;

/**
 * 
 * @FileName Logback.java
 * @version:1.0
 * @Description: 服務介面的實現類
 * @author: wwh
 * @date: 2022年9月19日 上午10:50:31
 */
public class Logback implements Logger {

    @Override
    public void debug(String msg) {
        System.err.println("調用Logback的debug方法,輸出的日誌為:" + msg);
    }

    @Override
    public void info(String msg) {
        System.err.println("調用Logback的info方法,輸出的日誌為:" + msg);
    }

}

  同時在當前項目的classpath路徑下建立META-INF/services/文件夾(至於為什麼這麼建立目錄,我們一會兒再解釋),並且新建一個名稱為cn.com.wwh.Logger內容為cn.com.wwh.Logback的文件,這一步是關鍵(具體作用後面再詳細說明),然後將上面第二步這個這個項目打成spi-provider.jar包,供給之後使用,我目前使用的開發工具是Eclipse,目錄結構如下圖所示:

  

  第三步,編寫測試類,新建一個maven項目,命名為spi-test,導入前面兩個步驟打的spi-interface.jar和spi-provider.jar這兩個jar包,並編寫測試代碼,示例如下:

package cn.com.wwh;

import cn.com.pep.LoggerService;

/**
 * 
 * @FileName SpiTest.java
 * @version:1.0
 * @Description: 
 * @author: wwh
 * @date: 2022年9月19日 上午10:56:31
 */
public class SpiTest {
    
    public static void main(String[] args) {
        LoggerService logger = LoggerService.getLoggerService();
        logger.info("我是中國人");
        logger.debug("白菜多少錢一斤");
    }
}

  有了SPI我們可以將服務和服務提供者輕鬆地解耦,假如將來的某一天我們需要將日誌保存到資料庫,或者通過網路發送,我們直接只需要替換針對服務介面的實現類即可,別的地方都不用修改,這更符合程式設計中的“開閉原則”。

  SPI的大致原理是:應用啟動的時候,掃描classpath下麵的所有jar包,將jar包下的/META-INF/services/目錄下的文件載入到記憶體中,進行一系列的解析(文件的名稱是spi介面的全路徑名稱,文件內容應該是spi介面實現類的全路徑名,可以用多個實現類,在文件中換行保存),之後判斷當前類和當前介面是否是同一類型?結果為true,則通過反射生成指定類的實例對象,保存到一個map集合中,可以通過遍歷或者迭代的方式拿出來使用。

  SPI實質就是一個載入服務實現的工具,核心類是ServiceLoader,其實瞭解了SPI的原理,我們再接著探究JDK中的源碼就沒有那麼費力了,下麵我們開始源碼分析吧。

  ServiceLoader類是定義在java.util包下的,使用final定義禁止子類繼承和修改,實現了Iterable介面,使得可以通過迭代或者遍歷的方式獲取SPI介面的不同實現。

從上面的我們所舉的例子中,我們知道SPI的入口是ServiceLoader.load(Class<S> service)方法,我們來看看它都幹了什麼?   

  上面的這4步總的來說,就是使用指定的類型和當前線程綁定的classLoader實例化了一個LazyIterator對象賦值給lookupIterator這個引用,並且清除了原來providers列表中緩存的服務的實現。接下來我們調用了ServiceLoader實例的iterator()方法獲取了一個迭代器,代碼如下:

 1 public Iterator<S> iterator() {
 2         //通過匿名內部類方式提供了一個迭代器
 3         return new Iterator<S>() {
 4             //獲取緩存的服務實現者的迭代器
 5             Iterator<Map.Entry<String, S>> knownProviders = providers.entrySet().iterator();
 6             
 7             //判斷迭代器中是否還有元素
 8             public boolean hasNext() {
 9                 //緩存的服務實現者的迭代器中已經沒有元素了
10                 if (knownProviders.hasNext())
11                     return true;
12                 return lookupIterator.hasNext();//判斷延遲載入的迭代器中是否還有元素
13             }
14 
15             //獲取迭代其中的下一個元素
16             public S next() {
17                 if (knownProviders.hasNext())
18                     return knownProviders.next().getValue();
19                 return lookupIterator.next();//獲取延遲載入的迭代器中的下一個元素
20             }
21 
22             public void remove() {
23                 throw new UnsupportedOperationException();
24             }
25         };
26    }

  我們接著調用上步獲取的迭代器it的hasNext()方法,因為我們在ServiceLoader.load()過程中其實是清除了providers列表中的緩存服務實現的,所以其實調用的是lookupIterator.hasNext()方法,如下:

 1 public boolean hasNext() {
 2         if (nextName != null) {//存在下一個元素
 3             return true;
 4         }
 5         if (configs == null) {//配置文件為空
 6             try {
 7                 String fullName = PREFIX + service.getName();//獲取配置文件路徑
 8                 if (loader == null)
 9                     configs = ClassLoader.getSystemResources(fullName);
10                 else
11                     configs = loader.getResources(fullName);//載入配置文件
12             } catch (IOException x) {
13                 fail(service, "Error locating configuration files", x);
14             }
15         }
16         //遍歷配置文件內容
17         while ((pending == null) || !pending.hasNext()) {
18             if (!configs.hasMoreElements()) {
19                 return false;
20             }
21             pending = parse(service, configs.nextElement());//配置文件內容解析
22         }
23         nextName = pending.next();//獲取服務實現類的全路徑名
24         return true;
25     }
26 

   假如上部判斷為true,緊接著我們又調用了迭代器it的next()方式,同理也調用的是lookupIterator.next()方法,源碼如下:

 1 public S next() {
 2         if (!hasNext()) {
 3             throw new NoSuchElementException();
 4         }
 5         String cn = nextName;//文件中保存的服務介面實現類的全路徑名
 6         nextName = null;
 7         Class<?> c = null;
 8         try {
 9             //獲取全限定名的Class對象
10             c = Class.forName(cn, false, loader);
11         } catch (ClassNotFoundException x) {
12             fail(service, "Provider " + cn + " not found");
13         }
14             //判斷實現類和服務介面是否是同一類型
15         if (!service.isAssignableFrom(c)) {
16             fail(service, "Provider " + cn + " not a subtype");
17         }
18         try {
19             //通過反射生成服務介面的實現類,並判斷這個實例是否是介面的實現
20             S p = service.cast(c.newInstance());
21             //將服務介面的實現緩存起來,並返回
22             providers.put(cn, p);
23             return p;
24         } catch (Throwable x) {
25             fail(service, "Provider " + cn + " could not be instantiated", x);
26         }
27         throw new Error(); // This cannot happen
28     }

  其實spi實現的主要流程是:掃描classpath路徑下的所有jar包下的/META-INF/services/目錄(即我們需要將服務介面的具體實現類暴露在這個目錄下,之前我們提到需要在實現類的classpath下麵建立一個/META-INF/services/文件夾就是這個原因。),找到對應的文件,讀取這個文件名找到對應的SPI介面,然後通過InputStream流將文件內容讀出來,獲取到實現類的全路徑名,並得到這個全路徑名所表示的Class對象,判斷其與服務介面是否是同一類型,然後通過反射生成服務介面的實現,並保存在providers列表中,供給後續的使用。

  SPI這種設計方式為我們的應用擴展提供了極大的便利,但是它的短板也是顯而易見的,Java SPI 在查找擴展實現類的時候遍歷 SPI 的配置文件並且將實現類全部實例化,假設一個實現類初始化過程比較消耗資源且耗時,但是你的代碼裡面又用不上它,這就產生了資源的浪費。所以說 Java SPI 無法按需載入實現類。

  另外,SPI 機制在很多框架中都有應用:slf4j日誌框架、Spring 框架的基本原理也是類似的反射。還有 Dubbo 框架提供同樣的 SPI 擴展機制,只不過 Dubbo 和 spring 框架中的 SPI 機制具體實現方式跟咱們今天學得這個有些細微的區別(Dubbo可以實現按需載入實現類),不過整體的原理都是一致的,我們今天先對SPI有個簡單的瞭解,相信有了今天的基礎理解剩下的那幾個也不是什麼難事。

  好了,今天就到這兒了,文章中有說的不對的地方還請各位大佬批評指正,一起學習,共同進步,謝謝。

本文來自博客園,作者:一隻烤鴨朝北走,僅用於技術學習,所有資源都來源於網路,部分是轉發,部分是個人總結。歡迎共同學習和轉載,轉載請在醒目位置標明原文。如有侵權,請留言告知,及時撤除。轉載請註明原文鏈接:https://www.cnblogs.com/wha6239/p/16692713.html


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

-Advertisement-
Play Games
更多相關文章
  • 當前伺服器上創建表(單節點) 創建新表具有幾種種語法形式,具體取決於用例。預設情況下,僅在當前伺服器上創建表。分散式DDL查詢作為子句實現,該子句另外描述。 語法形式 使用顯式架構 CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cl ...
  • 摘要:華為雲資料庫助力德邦快遞打造的“基於數智融合的一站式物流供應鏈平臺”項目從500多個項目中脫穎而出,榮獲2022 IDC中國未來企業大獎優秀獎“未來智能領軍者”。 本文分享自華為雲社區《華為雲資料庫助力德邦快遞斬獲IDC中國未來企業大獎“未來智能領軍者”優秀獎》,作者: GaussDB 資料庫 ...
  • “What I cannot create, I do not understand.” – Richard Feynman I’m building a clone of sqlite from scratch in C in order to understand, and I’m going ...
  • 一個沉浸感十足的游戲,其場景中的全局光照效果一定功不可沒。 動態漫反射全局光照(DDGI)帶來的光影變化,是細膩延展的視覺語言,讓場景中每種顏色都有了“五彩斑斕”的詮釋,場景佈局光影,物體關係立顯,環境溫度降臨,拓展了畫面信息傳達的層次,點睛之筆。 直接光渲染 VS 動態漫反射全局光照 細膩的光照視 ...
  • ⚠️1.1萬長文⚠️ React源碼並非洪水猛獸,知道方法,就可以很輕易地馴服它(=^▽^=)。文章基於最新的React源碼進行調試及閱讀,將以通俗地方式解讀React ...
  • 這裡給大家分享我在網上總結出來的一些知識,希望對大家有所幫助 一、axios簡介 axios是什麼? Axios 是一個基於 promise 的 HTTP 庫,可以用在瀏覽器和 node.js 中。 axios有什麼特性?(不得不說面試被問到幾次) 從瀏覽器中創建 XMLHttpRequests 從 ...
  • 前端學科面試寶典 蔡威 [電子郵件地址] HTML5、CSS3...................................................................................................................... ...
  • 筆者最近在看 你不知道的JavaScript上捲,裡面關於 this 的講解個人覺得非常精彩。JavaScript 中的 this 算是一個核心的概念,有一些同學會對其有點模糊和小恐懼,究其原因,現在對 this 討論的文章很多,讓我們覺得 this 無規律可尋,就像一個幽靈一樣 如果你還沒弄懂 t ...
一周排行
    -Advertisement-
    Play Games
  • 隨著Aspire發佈preview5的發佈,Microsoft.Extensions.ServiceDiscovery隨之更新, 服務註冊發現這個屬於老掉牙的話題解決什麼問題就不贅述了,這裡主要講講Microsoft.Extensions.ServiceDiscovery(preview5)以及如何 ...
  • 概述:通過使用`SemaphoreSlim`,可以簡單而有效地限制非同步HTTP請求的併發量,確保在任何給定時間內不超過20個網頁同時下載。`ParallelOptions`不適用於非同步操作,但可考慮使用`Parallel.ForEach`,儘管在非同步場景中謹慎使用。 對於併發非同步 I/O 操作的數量 ...
  • 1.Linux上安裝Docken 伺服器系統版本以及內核版本:cat /etc/redhat-release 查看伺服器內核版本:uname -r 安裝依賴包:yum install -y yum-utils device-mapper-persistent-data lvm2 設置阿裡雲鏡像源:y ...
  • 概述:WPF界面綁定和渲染大量數據可能導致性能問題。通過啟用UI虛擬化、非同步載入和數據分頁,可以有效提高界面響應性能。以下是簡單示例演示這些優化方法。 在WPF中,當你嘗試綁定和渲染大量的數據項時,性能問題可能出現。以下是一些可能導致性能慢的原因以及優化方法: UI 虛擬化: WPF提供了虛擬化技術 ...
  • 引言 上一章節介紹了 TDD 的三大法則,今天我們講一下在單元測試中模擬對象的使用。 Fake Fake - Fake 是一個通用術語,可用於描述 stub或 mock 對象。 它是 stub 還是 mock 取決於使用它的上下文。 也就是說,Fake 可以是 stub 或 mock Mock - ...
  • 為.net6在CentOS7上面做準備,先在vmware虛擬機安裝CentOS 7.9 新建CentOS764位的系統 因為CentOS8不更新了,所以安裝7;簡單就一筆帶過了 選擇下載好的操作系統的iso文件,下載地址https://mirrors.aliyun.com/centos/7.9.20 ...
  • 經過前面幾篇的學習,我們瞭解到指令的大概分類,如:參數載入指令,該載入指令以 Ld 開頭,將參數載入到棧中,以便於後續執行操作命令。參數存儲指令,其指令以 St 開頭,將棧中的數據,存儲到指定的變數中,以方便後續使用。創建實例指令,其指令以 New 開頭,用於在運行時動態生成並初始化對象。方法調用指... ...
  • LiteDB 是一個輕量級的嵌入式 NoSQL 資料庫,其設計理念與 MongoDB 類似,但它是完全使用 C# 開發的,因此與 C# 應用程式的集成非常順暢。與 SQLite 相比,LiteDB 提供了 NoSQL(即鍵值對)的數據存儲方式,並且是一個開源且免費的項目。它適用於桌面、移動以及 We ...
  • 1 開源解析和拆分文檔 第三方的工具去對文件解析拆分,去將我們的文件內容給提取出來,並將我們的文檔內容去拆分成一個小的chunk。常見的PDF word mark down, JSON、HTML。都可以有很好的一些模塊去把這些文件去進行一個東西去提取。 優勢 支持豐富的文檔類型 每種文檔多樣化選擇 ...
  • OOM是什麼?英文全稱為 OutOfMemoryError(記憶體溢出錯誤)。當程式發生OOM時,如何去定位導致異常的代碼還是挺麻煩的。 要檢查OOM發生的原因,首先需要瞭解各種OOM情況下會報的異常信息。這樣能縮小排查範圍,再結合異常堆棧、heapDump文件、JVM分析工具和業務代碼來判斷具體是哪 ...