Java 中經(jīng)常被提到的 SPI 到底是什么?
Java? 程序員在日常工作中經(jīng)常會(huì)聽到 SPI?,而且很多框架都使用了 SPI? 的技術(shù),那么問題來了,到底什么是 SPI 呢?今天阿粉就帶大家好好了解一下 SPI。
SPI 概念
SPI? 全稱是 Service Provider Interface?,是一種 JDK? 內(nèi)置的動(dòng)態(tài)加載實(shí)現(xiàn)擴(kuò)展點(diǎn)的機(jī)制,通過 SPI 技術(shù)我們可以動(dòng)態(tài)獲取接口的實(shí)現(xiàn)類,不用自己來創(chuàng)建。
這里提到了接口和實(shí)現(xiàn)類,那么 SPI 技術(shù)上具體有哪些技術(shù)細(xì)節(jié)呢?
- 接口:需要有一個(gè)功能接口;
- 實(shí)現(xiàn)類:接口只是規(guī)范,具體的執(zhí)行需要有實(shí)現(xiàn)類才行,所以不可缺少的需要有實(shí)現(xiàn)類;
- 配置文件:要實(shí)現(xiàn)SPI? 機(jī)制,必須有一個(gè)與接口同名的文件存放于類路徑下面的 META-INF/services 文件夾中,并且文件中的每一行的內(nèi)容都是一個(gè)實(shí)現(xiàn)類的全路徑;
- 類加載器ServiceLoader:JDK 內(nèi)置的一個(gè)類加載器,用于加載配置文件中的實(shí)現(xiàn)類;
舉個(gè)栗子
上面說了 SPI 的幾個(gè)概念,接下來阿粉就通過一個(gè)栗子來帶大家感受一下具體的用法。
第一步
創(chuàng)建一個(gè)接口,這里我們創(chuàng)建一個(gè)解壓縮的接口,其中定義了壓縮和解壓的兩個(gè)方法。
package com.example.demo.spi;
public interface Compresser {
byte[] compress(byte[] bytes);
byte[] decompress(byte[] bytes);
}
第二步
再寫兩個(gè)對(duì)應(yīng)的實(shí)現(xiàn)類,分別是 GzipCompresser.java? 和 WinRarCompresser.java 代碼如下
package com.example.demo.spi.impl;
import com.example.demo.spi.Compresser;
import java.nio.charset.StandardCharsets;
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;
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
注意該文件的名稱必須是接口的全路徑,文件里面的內(nèi)容每一行都是一個(gè)實(shí)現(xiàn)類的全路徑,多個(gè)實(shí)現(xiàn)類就寫在多行里面,效果如下。
第四步
有了上面的接口,實(shí)現(xiàn)類和配置文件,接下來我們就可以使用 ServiceLoader? 動(dòng)態(tài)加載實(shí)現(xiàn)類,來實(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) {
ServiceLoader<Compresser> compressers = ServiceLoader.load(Compresser.class);
for (Compresser compresser : compressers) {
System.out.println(compresser.getClass());
}
}
}
運(yùn)行的結(jié)果如下
可以看到我們正常的獲取到了接口的實(shí)現(xiàn)類,并且可以直接使用實(shí)現(xiàn)類的解壓縮方法。
原理
知道了如何使用 SPI? 接下來我們來研究一下是如何實(shí)現(xiàn)的,通過上面的測試我們可以看到,核心的邏輯是 ServiceLoader.load()? 方法,這個(gè)方法有點(diǎn)類似于 Spring 中的根據(jù)接口獲取所有實(shí)現(xiàn)類一樣。
點(diǎn)開 ServiceLoader? 我們可以看到有一個(gè)常量 PREFIX?,如下所示,這也是為什么我們必須在這個(gè)路徑下面創(chuàng)建配置文件,因?yàn)?nbsp;JDK 代碼里面會(huì)從這個(gè)路徑里面去讀取我們的文件。
同時(shí)又因?yàn)樵谧x取文件的時(shí)候使用了 class? 的路徑名稱,因?yàn)槲覀兪褂?nbsp;load? 方法的時(shí)候只會(huì)傳遞一個(gè) class,所以我們的文件名也必須是接口的全路徑。
通過 load? 方法我們可以看到底層構(gòu)造了一個(gè) java.util.ServiceLoader.LazyIterator 迭代器。
在迭代器中的 parse? 方法中,就獲取了配置文件中的實(shí)現(xiàn)類名稱集合,然后在通過反射創(chuàng)建出具體的實(shí)現(xiàn)類對(duì)象存放到 LinkedHashMap<String,S> providers = new LinkedHashMap<>(); 中。
常用的框架
SPI 技術(shù)的使用非常廣泛,比如在 Dubble?,不過 Dubble? 中的 SPI? 有經(jīng)過改造的,還有我們很常見的數(shù)據(jù)庫的驅(qū)動(dòng)中也使用了 SPI?,感興趣的小伙伴可以去翻翻看,還有 SLF4J? 用來加載不同提供商的日志實(shí)現(xiàn)類以及 Spring 框架等。
優(yōu)缺點(diǎn)
前面介紹了 SPI? 的原理和使用,那 SPI 有什么優(yōu)缺點(diǎn)呢?
優(yōu)點(diǎn)
優(yōu)點(diǎn)當(dāng)然是解耦,服務(wù)方只要定義好接口規(guī)范就好了,具體的實(shí)現(xiàn)可以由不同的 Jar 進(jìn)行實(shí)現(xiàn),只要按照規(guī)范實(shí)現(xiàn)功能就可以被直接拿來使用,在某些場合會(huì)被進(jìn)行熱插拔使用,實(shí)現(xiàn)了解耦的功能。
缺點(diǎn)
一個(gè)很明顯的缺點(diǎn)那就是做不到按需加載,通過源碼我們看到了是會(huì)將所有的實(shí)現(xiàn)類都進(jìn)行創(chuàng)建的,這種做法會(huì)降低性能,如果某些實(shí)現(xiàn)類實(shí)現(xiàn)很耗時(shí)了話將影響加載時(shí)間。同時(shí)實(shí)現(xiàn)類的命名也沒有規(guī)范,讓使用者不方便引用。