我們一起聊聊 Java SPI 機制
Java SPI 是基于接口的編程+策略模式+約定配置文件組合實現的動態加載機制,能夠很方便的為某個接口尋找服務實現的機制。
今天這篇文章就來深入聊一下SPI。
什么是SPI?
SPI 全稱:Service Provider Interface,是Java提供的一套用來被第三方實現或者擴展的接口,它可以用來啟用框架擴展和替換組件。
面向的對象的設計里,我們一般推薦模塊之間基于接口編程,模塊之間不對實現類進行硬編碼。一旦代碼里涉及具體的實現類,就違反了可拔插的原則,如果需要替換一種實現,就需要修改代碼。
為了實現在模塊裝配的時候不用在程序里動態指明,這就需要一種服務發現機制。java spi就是提供這樣的一個機制:為某個接口尋找服務實現的機制。這有點類似IOC的思想,將裝配的控制權移到了程序之外。
這是一種JDK內置的一種服務發現的機制,用于制定一些規范,實際實現方式交給不同的服務廠商。如下圖:
解耦、可拔插、面向接口編程、動態類加載。
當服務的提供者提供了一種接口的實現之后,需要在classpath下的 META-INF/services/ 目錄里創建一個以服務接口命名的文件,這個文件里的內容就是這個接口的具體的實現類。
當其他的程序需要這個服務的時候,就可以通過查找這個jar包(一般都是以jar包做依賴)的META-INF/services/中的配置文件,配置文件中有接口的具體實現類名,可以根據這個類名進行加載實例化,就可以使用該服務了。JDK中查找服務的實現的工具類是:java.util.ServiceLoader。
SPI 的不足
- 不能按需加載,需要遍歷所有的實現,并實例化,然后在循環中才能找到我們需要的實現。如果不想用某些實現類,或者某些類實例化很耗時,它也被載入并實例化了,這就造成了浪費。
- 獲取某個實現類的方式不夠靈活,只能通過 Iterator 形式獲取,不能根據某個參數來獲取對應的實現類。(Spring 的BeanFactory,ApplicationContext 就要高級一些了。)
- 多個并發多線程使用 ServiceLoader 類的實例是不安全的。
API 與 SPI 區別?
API是調用并用于實現目標的類、接口、方法等的描述;
SPI是擴展和實現以實現目標的類、接口、方法等的描述;
換句話說,API 為操作提供特定的類、方法,SPI 通過操作來符合特定的類、方法。
SPI和API的使用場景解析
- API (Application Programming Interface)在大多數情況下,都是實現方制定接口并完成對接口的實現,調用方僅僅依賴接口調用,且無權選擇不同實現。從使用人員上來說,API 直接被應用開發人員使用。
- SPI (Service Provider Interface)是調用方來制定接口規范,提供給外部來實現,調用方在調用時則選擇自己需要的外部實現。 從使用人員上來說,SPI 被框架擴展人員使用。
SPI 案例實現
下面來一個簡單的案例實現:比如每個動物都有不同的叫聲,作為聲紋系統會定義一個接口,如下:
public interface AnimalSay {
void say();
}
在這個系統中并沒有實現具體的實現,但是在處理業務邏輯時有需要用到該實例,此時就需要用到SPI去加載實現類,定義一個AnimalManagerLoader,實現如下:
@Data
publicclass AnimalManagerLoader {
privatestaticfinal AnimalManagerLoader INSTANCE = new AnimalManagerLoader();
privatefinal List<AnimalSay> animalSays;
private AnimalManagerLoader() {
animalSays = load();
}
/**
* 通過SPI加載實現類
*/
private List<AnimalSay> load() {
ArrayList<AnimalSay> animalSays = new ArrayList<>();
Iterator<AnimalSay> iterator = ServiceLoader.load(AnimalSay.class).iterator();
while (iterator.hasNext()){
animalSays.add(iterator.next());
}
return animalSays;
}
public static AnimalManagerLoader getInstance() {
return INSTANCE;
}
}
此時就可以通過AnimalManagerLoader中的load方法去加載對應的實現類,封裝到List集合中,調用如下:
public static void main(String[] args) {
AnimalManagerLoader animalManagerLoader = AnimalManagerLoader.getInstance();
List<AnimalSay> animalSays = animalManagerLoader.getAnimalSays();
for (AnimalSay animalSay : animalSays) {
animalSay.say();
}
}
那么此時提供聲音的廠家就需要實現這個接口,比如狗狗的聲紋廠家,實現如下:
/**
* 狗狗的聲紋
*/
public class DogSay implements AnimalSay {
public void say() {
System.out.println("wang wang ~");
}
}
貓咪的聲紋如下:
/**
* 貓咪的聲紋
*/
public class CatSay implements AnimalSay {
@Override
public void say() {
System.out.println("miao miao ~");
}
}
實現類定義了,就需要在 /META-INF/services 中定義一個 com.myjszl.animal.api.AnimalSay文件,內容如下:
com.myjszl.dog.api.DogSay
com.myjszl.dog.api.CatSay
SPI 應用場景
SPI擴展機制應用場景有很多,比如Common-Logging,JDBC,Dubbo、ShardingSphere等等。
1. JDBC場景
java中定義的java.sql.Driver接口,并沒有具體的實現,實現方式而是交給不同的服務廠商:
- 在MySQL的jar包mysql-connector-java-6.0.6.jar中,可以找到META-INF/services目錄,該目錄下會有一個名字為java.sql.Driver的文件,文件內容是com.mysql.cj.jdbc.Driver,這里面的內容就是針對Java中定義的接口的實現。
- PostgreSQL的jar包PostgreSQL-42.0.0.jar中,也可以找到同樣的配置文件,文件內容是org.postgresql.Driver,這是PostgreSQL對Java的java.sql.Driver的實現。
2. ShardingSphere場景
在ShardingSphere中為了實現分布式事務提供了一個接口ShardingTransactionManager,但是在其架構中并未對其做出具體的實現,而是交給不同的廠商去實現,比如JTA強一致性事務的XAShardingTransactionManager,在其中META-INF/services就有一個org.apache.shardingsphere.transaction.spi.ShardingTransactionManager文件,如下圖:
圖片
以上只是簡單的列舉了幾個場景,實際應用場景很多,比如Spring、Spring Boot 中都有用到SPI設計。
3. Spring 場景
Spring中大量使用了SPI;比如:對servlet3.0規范對ServletContainerInitializer的實現、自動類型轉換Type Conversion SPI(Converter SPI、Formatter SPI)等
4. SLF4J 日志門面 場景
SLF4J加載不同提供商的日志實現類,比如log4j、log4j2、logback.....
總結
通過Java的SPI機制能夠很方便的實現可插拔、解耦的功能設計,在日常的開發中要能想到該機制并能靈活的運用。