一文搞懂JavaSPI機(jī)制的原理與使用

第一文搞懂JavaSPI機(jī)制的原理與使用目錄SPI概念舉個(gè)栗子第一步第二步第三步第四步原理常用的框架優(yōu)缺點(diǎn)優(yōu)點(diǎn)缺點(diǎn)Java程序員在日常工作中經(jīng)常會(huì)聽(tīng)到SPI，而且很多框架都使用了SPI的技術(shù)，那么問(wèn)題來(lái)了，到底什么是SPI呢？今天阿粉就帶大家好好了解一下SPI。

SPI概念

SPI全稱(chēng)是ServiceProviderInterface，是一種JDK內(nèi)置的動(dòng)態(tài)加載實(shí)現(xiàn)擴(kuò)展點(diǎn)的機(jī)制，通過(guò)SPI技術(shù)我們可以動(dòng)態(tài)獲取接口的實(shí)現(xiàn)類(lèi)，不用自己來(lái)創(chuàng)建。

這里提到了接口和實(shí)現(xiàn)類(lèi)，那么SPI技術(shù)上具體有哪些技術(shù)細(xì)節(jié)呢？

接口：需要有一個(gè)功能接口；實(shí)現(xiàn)類(lèi)：接口只是規(guī)范，具體的執(zhí)行需要有實(shí)現(xiàn)類(lèi)才行，所以不可缺少的需要有實(shí)現(xiàn)類(lèi)；配置文件：要實(shí)現(xiàn)SPI機(jī)制，必須有一個(gè)與接口同名的文件存放于類(lèi)路徑下面的META-INF/services文件夾中，并且文件中的每一行的內(nèi)容都是一個(gè)實(shí)現(xiàn)類(lèi)的全路徑；類(lèi)加載器ServiceLoader：JDK內(nèi)置的一個(gè)類(lèi)加載器，用于加載配置文件中的實(shí)現(xiàn)類(lèi)；

舉個(gè)栗子

上面說(shuō)了SPI的幾個(gè)概念，接下來(lái)阿粉就通過(guò)一個(gè)栗子來(lái)帶大家感受一下具體的用法。

第一步

創(chuàng)建一個(gè)接口，這里我們創(chuàng)建一個(gè)解壓縮的接口，其中定義了壓縮和解壓的兩個(gè)方法。

package

com.example.demo.spi;

*

br

*

bFunction：/bbr

*

bAuthor：/b@author

ziyoubr

*

bDate：/b2025-10-0821:31br

*

bDesc：/b無(wú)br

public

interface

Compresser

{

byte[]

compress(byte[]

bytes);

byte[]

decompress(byte[]

bytes);

第二步

再寫(xiě)兩個(gè)對(duì)應(yīng)的實(shí)現(xiàn)類(lèi)，分別是GzipCompresser.java和WinRarCompresser.java代碼如下

package

com.example.demo.spi.impl;

import

com.example.demo.spi.Compresser;

import

java.nio.charset.StandardCharsets;

*

br

*

bFunction：/bbr

*

bAuthor：/b@author

ziyoubr

*

bDate：/b2025-10-0821:33br

*

bDesc：/b無(wú)br

public

class

GzipCompresser

implements

Compresser

{

@Override

public

byte[]

compress(byte[]

bytes)

{

return"compress

by

Gzip".getBytes(StandardCharsets.UTF_8);

@Override

public

byte[]

decompress(byte[]

bytes)

{

return

"decompress

by

Gzip".getBytes(StandardCharsets.UTF_8);

package

com.example.demo.spi.impl;

import

com.example.demo.spi.Compresser;

import

java.nio.charset.StandardCharsets;

*

bFunction：/b

*

bAuthor：/b@author

ziyou

*

bDate：/b2025-10-0821:33

*

bDesc：/b無(wú)

public

class

WinRarCompresser

implements

Compresser

{

@Override

public

byte[]

compress(byte[]

bytes)

{

return

"compress

by

WinRar".getBytes(StandardCharsets.UTF_8);

@Override

public

byte[]

decompress(byte[]

bytes)

{

return

"decompress

by

WinRar".getBytes(StandardCharsets.UTF_8);

第三步

創(chuàng)建配置文件，我們接著在resources目錄下創(chuàng)建一個(gè)名為META-INF/services的文件夾，在其中創(chuàng)建一個(gè)名為com.example.demo.spi.Compresser的文件，其中的內(nèi)容如下：

com.example.demo.spi.impl.WinRarCompresser

com.example.demo.spi.impl.GzipCompresser

注意該文件的名稱(chēng)必須是接口的全路徑，文件里面的內(nèi)容每一行都是一個(gè)實(shí)現(xiàn)類(lèi)的全路徑，多個(gè)實(shí)現(xiàn)類(lèi)就寫(xiě)在多行里面，效果如下。

第四步

有了上面的接口，實(shí)現(xiàn)類(lèi)和配置文件，接下來(lái)我們就可以使用ServiceLoader動(dòng)態(tài)加載實(shí)現(xiàn)類(lèi)，來(lái)實(shí)現(xiàn)SPI技術(shù)了，如下所示：

package

com.example.demo;

import

com.example.demo.spi.Compresser;

import

java.nio.charset.StandardCharsets;

import

java.util.ServiceLoader;

public

class

TestSPI

{

public

static

void

main(String[]

args)

{

ServiceLoaderCompresser

compressers

=

ServiceLoader.load(Compresser.class);

for

(Compresser

compresser

:

compressers)

{

System.out.println(compresser.getClass());

}

運(yùn)行的結(jié)果如下

可以看到我們正常的獲取到了接口的實(shí)現(xiàn)類(lèi)，并且可以直接使用實(shí)現(xiàn)類(lèi)的解壓縮方法。

原理

知道了如何使用SPI接下來(lái)我們來(lái)研究一下是如何實(shí)現(xiàn)的，通過(guò)上面的測(cè)試我們可以看到，核心的邏輯是ServiceLoader.load()方法，這個(gè)方法有點(diǎn)類(lèi)似于Spring中的根據(jù)接口獲取所有實(shí)現(xiàn)類(lèi)一樣。

點(diǎn)開(kāi)ServiceLoader我們可以看到有一個(gè)常量PREFIX，如下所示，這也是為什么我們必須在這個(gè)路徑下面創(chuàng)建配置文件，因?yàn)镴DK代碼里面會(huì)從這個(gè)路徑里面去讀取我們的文件。

同時(shí)又因?yàn)樵谧x取文件的時(shí)候使用了class的路徑名稱(chēng)，因?yàn)槲覀兪褂胠oad方法的時(shí)候只會(huì)傳遞一個(gè)class，所以我們的文件名也必須是接口的全路徑。

通過(guò)load方法我們可以看到底層構(gòu)造了一個(gè)java.util.ServiceLoader.LazyIterator迭代器。

在迭代器中的parse方法中，就獲取了配置文件中的實(shí)現(xiàn)類(lèi)名稱(chēng)集合，然后在通過(guò)反射創(chuàng)建出具體的實(shí)現(xiàn)類(lèi)對(duì)象存放到LinkedHashMapString,Sproviders=newLinkedHashMap();中。

常用的框架

SPI技術(shù)的使用非常廣泛，比如在Dubble，不過(guò)Dubble中的SPI有經(jīng)過(guò)改造的，還有我們很常見(jiàn)的數(shù)據(jù)庫(kù)的驅(qū)動(dòng)中也使用了SPI，感興趣的小伙伴可以去翻翻看，還有SLF4J用來(lái)加載不同提供商的日志實(shí)現(xiàn)類(lèi)以及Spring框架等。

優(yōu)缺點(diǎn)

前面介紹了SPI的原理和使用，那SPI有什么優(yōu)缺點(diǎn)呢？

優(yōu)點(diǎn)

優(yōu)點(diǎn)當(dāng)然是解耦，服務(wù)方只要定義好接口規(guī)范就好