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
更多相關文章
  • ClickHouse(06)ClickHouse的數據表創建語句詳細解析
    當前伺服器上創建表(單節點) 創建新表具有幾種種語法形式，具體取決於用例。預設情況下，僅在當前伺服器上創建表。分散式DDL查詢作為子句實現，該子句另外描述。 語法形式 使用顯式架構 CREATE TABLE [IF NOT EXISTS] [db.]table_name [ON CLUSTER cl ...
  • 2022 IDC中國未來企業大獎優秀獎頒佈，華為雲資料庫助力德邦快遞獲獎
    摘要：華為雲資料庫助力德邦快遞打造的“基於數智融合的一站式物流供應鏈平臺”項目從500多個項目中脫穎而出，榮獲2022 IDC中國未來企業大獎優秀獎“未來智能領軍者”。 本文分享自華為雲社區《華為雲資料庫助力德邦快遞斬獲IDC中國未來企業大獎“未來智能領軍者”優秀獎》，作者： GaussDB 資料庫 ...
  • 實現一個簡單的Database1(譯文）
    “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 ...
  • Android EGL 實踐
    一個沉浸感十足的游戲，其場景中的全局光照效果一定功不可沒。 動態漫反射全局光照（DDGI）帶來的光影變化，是細膩延展的視覺語言，讓場景中每種顏色都有了“五彩斑斕”的詮釋，場景佈局光影，物體關係立顯，環境溫度降臨，拓展了畫面信息傳達的層次，點睛之筆。 直接光渲染 VS 動態漫反射全局光照 細膩的光照視 ...
  • [通明境 · React架構]通俗地講React，優雅地理解React
    ⚠️1.1萬長文⚠️ React源碼並非洪水猛獸，知道方法，就可以很輕易地馴服它(=^▽^=)。文章基於最新的React源碼進行調試及閱讀，將以通俗地方式解讀React ...
  • 記錄--通過手寫，分析axios核心原理
    這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 一、axios簡介 axios是什麼？ Axios 是一個基於 promise 的 HTTP 庫，可以用在瀏覽器和 node.js 中。 axios有什麼特性？（不得不說面試被問到幾次） 從瀏覽器中創建 XMLHttpRequests 從 ...
  • FE寶典
    前端學科面試寶典 蔡威 [電子郵件地址] HTML5、CSS3...................................................................................................................... ...
  • 深入淺出 JavaScript 中的 this
    筆者最近在看 你不知道的JavaScript上捲，裡面關於 this 的講解個人覺得非常精彩。JavaScript 中的 this 算是一個核心的概念，有一些同學會對其有點模糊和小恐懼，究其原因，現在對 this 討論的文章很多，讓我們覺得 this 無規律可尋，就像一個幽靈一樣 如果你還沒弄懂 t ...
一周排行
    -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.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類