Java SPI 和 API，傻傻分不清？
最近新寫了一個(gè)中間件「運(yùn)行時(shí)動(dòng)態(tài)日志等級(jí)開關(guān)」，其中使用Java SPI機(jī)制實(shí)現(xiàn)了自定義配置中心，保證良好的擴(kuò)展性。
項(xiàng)目地址，走過路過可以點(diǎn)個(gè)star ：）
https://github.com/saigu/LogLevelSwitch
在使用過程中，突然發(fā)現(xiàn)SPI其實(shí)和日常寫API接口，然后進(jìn)行implements實(shí)現(xiàn)非常相似，那SPI到底和普通API實(shí)現(xiàn)有啥區(qū)別呢？帶著這個(gè)問題，我們一起來梳理下SPI機(jī)制吧。
本文預(yù)計(jì)閱讀時(shí)間10分鐘，將圍繞以下幾點(diǎn)展開：
什么是 SPI 機(jī)制？
SPI 實(shí)踐案例
SPI 和 API 有啥區(qū)別？
1、什么是SPI機(jī)制？
SPI（Service Provider Interface） 字面意思是服務(wù)提供者接口，本質(zhì)上是一種「服務(wù)擴(kuò)展機(jī)制」。
為什么需要這樣一種「服務(wù)擴(kuò)展機(jī)制」呢？
因?yàn)橄到y(tǒng)里抽象的各個(gè)模塊，比如日志模塊、xml解析模塊、jdbc模塊等，往往有很多不同的實(shí)現(xiàn)方案。
為了滿足可拔插的原則，我們一般推薦模塊之間基于接口編程，模塊之間不對(duì)實(shí)現(xiàn)類進(jìn)行硬編碼。這就需要一種「服務(wù)擴(kuò)展機(jī)制」，然后就有了SPI。
SPI 機(jī)制為我們的程序提供拓展功能。而不必將框架的一些實(shí)現(xiàn)類寫死在代碼里面。我們?cè)谙鄳?yīng)配置文件中定義好某個(gè)接口的實(shí)現(xiàn)類全限定名，并由服務(wù)加載器讀取配置文件，加載實(shí)現(xiàn)類。這樣可以在運(yùn)行時(shí)，動(dòng)態(tài)為接口替換實(shí)現(xiàn)類。
最常見的就是Java的SPI機(jī)制，另外，還有Dubbo和SpringBoot自定義的SPI機(jī)制。
2、SPI實(shí)踐案例
2.1?業(yè)界SPI實(shí)踐案例
簡單了解了SPI的概念，我們看看業(yè)界有哪些SPI實(shí)踐案例，如何利用SPI實(shí)現(xiàn)靈活擴(kuò)展的。
JDBC驅(qū)動(dòng)加載
最常見的SPI機(jī)制實(shí)踐案例就是JDBC的驅(qū)動(dòng)加載。利用Java的SPI機(jī)制，我們可以根據(jù)不同的數(shù)據(jù)庫廠商來引入不同的JDBC驅(qū)動(dòng)包。
SpringBoot的SPI機(jī)制
用過SpringBoot的同學(xué)應(yīng)該都知道，我們可以在spring.factories中加上我們自定義的自動(dòng)配置類，這個(gè)特性尤其在xxx-starter中應(yīng)用廣泛。
Dubbo的SPI機(jī)制
Dubbo基本上自身的每個(gè)功能點(diǎn)都提供了擴(kuò)展點(diǎn)，把SPI機(jī)制應(yīng)用的淋漓盡致，比如提供了集群擴(kuò)展、路由擴(kuò)展和負(fù)載均衡擴(kuò)展等差不多接近30個(gè)擴(kuò)展點(diǎn)。
如果Dubbo的某個(gè)內(nèi)置實(shí)現(xiàn)不符合我們的需求，那么我們只要利用其SPI機(jī)制將我們的實(shí)現(xiàn)替換掉Dubbo的實(shí)現(xiàn)即可。
2.2?在實(shí)際項(xiàng)目中如何使用
以上三個(gè)例子是業(yè)界最常見的SPI機(jī)制的實(shí)現(xiàn)。下面，來看看我在實(shí)際項(xiàng)目中如何利用Java SPI機(jī)制實(shí)現(xiàn)了自定義配置中心，保證良好的擴(kuò)展性。
項(xiàng)目地址，走過路過可以點(diǎn)個(gè)star ：）
https://github.com/saigu/LogLevelSwitch
需求很簡單，中間件「運(yùn)行時(shí)動(dòng)態(tài)日志等級(jí)開關(guān)」需要在應(yīng)用運(yùn)行時(shí)獲取開關(guān)狀態(tài)，然后動(dòng)態(tài)改變應(yīng)用日志等級(jí)。
如何獲取開關(guān)狀態(tài)呢？我們一般需要配置中心來進(jìn)行處理。作為一個(gè)開源中間件，使用它的應(yīng)用可能有自己的不同的配置中心（比如Nacos、Apollo、spring cloud config、自研配置中心等），因此，必須支持自定義配置中心接入。
這時(shí)候就需要SPI機(jī)制來實(shí)現(xiàn)了！
1）定義接口interface
package io.github.saigu.log.level.sw.listener;public interface ConfigListener<T> {/*** 獲取初始開關(guān)狀態(tài)* @return initial context of switch*/SwitchContext getInitSwitch();/*** 獲取變化的配置* @param changedConfig changed config context*/void listenChangedConfig(T changedConfig);}
2）SPI加載
本項(xiàng)目通過Java SPI實(shí)現(xiàn)，不需要依賴額外的組件，通過ServiceLoader來動(dòng)態(tài)加載
public class ChangeListenerFactory {public static ConfigListener getListener() {final ServiceLoaderloader = ServiceLoader.load(ConfigListener.class); for (ConfigListener configListener : loader) {return configListener;}throw new IllegalArgumentException("please choose valid listener");}}
3）應(yīng)用自定義配置中心接入
使用這個(gè)中間件的應(yīng)用，只需要三步即可接入自定義配置中心。
STEP 1: 應(yīng)用中pom引入依賴
STEP 2: 構(gòu)建config Bean
public class LogLevelSwitchConfig {LogLevelSwitch logLevelSwitch() {return new LogLevelSwitch();}}
STEP 3: 接入配置中心
聲明配置中心的SPI實(shí)現(xiàn)。
在resource路徑下新建?META-INF/services，創(chuàng)建文件名為
io.github.saigu.log.level.sw.listener.ConfigListener的文件，并寫入自定義配置中心的「實(shí)現(xiàn)類名」。
3、SPI和API有啥區(qū)別？
我們已經(jīng)介紹了什么是SPI，怎么使用SPI機(jī)制，現(xiàn)在，回頭來看看一開始提出的問題，SPI和API有啥區(qū)別呢？
它們都需要定義接口interface，然后自定義實(shí)現(xiàn)類implements，看起來基本一致呀。
區(qū)別在哪？各自的使用場(chǎng)景是啥？
別急，我們從頭梳理一下。
從「面向接口編程」的思想來看，「調(diào)用方」應(yīng)該通過調(diào)用「接口」而不是「具體實(shí)現(xiàn)」來處理邏輯。那么，對(duì)于「接口」的定義，應(yīng)該在「調(diào)用方」還是「實(shí)現(xiàn)方」呢？
理論上來說，會(huì)有三種選擇：
「接口」定義在「實(shí)現(xiàn)方」
「接口」定義在「調(diào)用方」
「接口」定義在 獨(dú)立的包中
1)「接口」定義在「實(shí)現(xiàn)方」
先來看看「接口」定義在「實(shí)現(xiàn)方」的情況。這個(gè)很容易理解，實(shí)現(xiàn)方同時(shí)提供了「接口」和「實(shí)現(xiàn)類」，「調(diào)用方」可以引用接口來達(dá)到調(diào)用某實(shí)現(xiàn)類的功能，這就是我們?nèi)粘Ｊ褂玫腁PI。API的最顯著特征就是：
實(shí)現(xiàn)和接口在一個(gè)包中。自己定義接口，自己實(shí)現(xiàn)類。
2)「接口」定義在「調(diào)用方」
再來看看「接口」屬于「調(diào)用方」的情況。這個(gè)其實(shí)就是SPI機(jī)制。以JDBC驅(qū)動(dòng)為例，「調(diào)用方」（用戶或者說JDK)定義了java.sql.Driver接口，這個(gè)接口位于「調(diào)用方」JDK的包中，各個(gè)數(shù)據(jù)庫廠商實(shí)現(xiàn)了這個(gè)接口，比如mysql驅(qū)動(dòng)com.mysql.jdbc.Driver。因此，SPI最顯著的特征就是：
「接口」在「調(diào)用方」的包，「調(diào)用方」定義規(guī)則，而自定義實(shí)現(xiàn)類在「實(shí)現(xiàn)方」的包，然后把實(shí)現(xiàn)類加載到「調(diào)用方」中。
3)「接口」定義在獨(dú)立的包
最后一種情況，如果一個(gè)「接口」在一個(gè)上下文是API，在另一個(gè)上下文是SPI，那么就可以把「接口」定義在獨(dú)立的包中。
4、小結(jié)
本文介紹了什么是SPI機(jī)制，然后結(jié)合業(yè)界案例與項(xiàng)目實(shí)踐來說明SPI的使用場(chǎng)景，最后對(duì)Java SPI和API的區(qū)別進(jìn)行了分析。
本文不對(duì)SPI原理進(jìn)行深入解析，下一篇文章會(huì)詳細(xì)分析下Java SPI的實(shí)現(xiàn)《大名鼎鼎的Java SPI機(jī)制，究竟有沒有破壞雙親委派呢？》，應(yīng)該會(huì)挺有意思，歡迎關(guān)注。
往期熱門筆記合集推薦：
原創(chuàng)：阿丸筆記（微信公眾號(hào)：aone_note），歡迎?分享，轉(zhuǎn)載請(qǐng)保留出處。
沒有留言功能的悲傷，掃描下方二維碼「加我」聊些有的沒的吧～