在java中使用SPI創(chuàng)建可擴(kuò)展的應(yīng)用程序操作
簡介
什么是可擴(kuò)展的應(yīng)用程序呢?可擴(kuò)展的意思是不需要修改原始代碼,就可以擴(kuò)展應(yīng)用程序的功能。我們將應(yīng)用程序做成插件或者模塊。
這樣可以在不修改原應(yīng)用的基礎(chǔ)上,對系統(tǒng)功能進(jìn)行升級或者定制化。
本文將會向大家介紹如何通過java中的SPI機(jī)制實(shí)現(xiàn)這種可擴(kuò)展的應(yīng)用程序。
SPI簡介
SPI的全稱是Java Service Provider Interface。是java提供的一種服務(wù)發(fā)現(xiàn)的機(jī)制。
通過遵循相應(yīng)的規(guī)則編寫應(yīng)用程序之后,就可以使用ServiceLoader來加載相應(yīng)的服務(wù)了。
SPI的實(shí)現(xiàn)主要分為4個(gè)部分:
Service Provider Interface: SPI是一個(gè)interface或者是抽象類,其中定義了我們需要擴(kuò)展實(shí)現(xiàn)的功能。
Service Providers:這是SPI的具體實(shí)現(xiàn),提供了具體的實(shí)現(xiàn)功能
SPI Configuration File:SPI的配置文件,通過在配置文件我們來配置相關(guān)的SPI發(fā)現(xiàn)信息。
ServiceLoader: ServiceLoader是用來加載和發(fā)現(xiàn)服務(wù)的java類,并提供了很多有用的方法。
SPI的普通java實(shí)現(xiàn)
講完SPI的定義,大家可能還是不清楚SPI到底是做什么的,又該怎么使用它。
不用急,我們下面通過一個(gè)例子來說明。
首先創(chuàng)建一個(gè)module:SPI-service,里面主要定義了一個(gè)ModuleService接口:
public interface ModuleService {
}
然后再分別創(chuàng)建兩個(gè)module,作為ModuleService的實(shí)現(xiàn):
public class ModuleServiceA implements ModuleService { public ModuleService getModuleService(){ return new ModuleServiceA(); } }
public class ModuleServiceB implements ModuleService { public ModuleService getModuleService(){ return new ModuleServiceB(); } }
接著分別在兩個(gè)module中創(chuàng)建META-INF/services文件夾,并且在里面創(chuàng)建兩個(gè)以 Service Provider Interface限定名為名字的文件,這里文件名是:com.flydean.base.service.ModuleService,文件里面存放的是SPI的具體實(shí)現(xiàn)類:
com.flydean.base.servicea.ModuleServiceA
com.flydean.base.serviceb.ModuleServiceB
最后,我們需要創(chuàng)建一個(gè)使用SPI的類:
public class ModuleController { public static void main(String[] args) { List<ModuleService> moduleServices = ServiceLoader .load(ModuleService.class).stream() .map(ServiceLoader.Provider::get) .collect(toList()); log.info("{}", moduleServices); } }
為了更好的展示擴(kuò)展應(yīng)用的實(shí)際使用,我們分別創(chuàng)建4個(gè)模塊。在實(shí)際應(yīng)用中,只需要將這些jar包加入應(yīng)用程序的classpath即可。
運(yùn)行看下輸出結(jié)果:
[com.flydean.base.servicea.ModuleServiceA@16f65612,
com.flydean.base.serviceb.ModuleServiceB@311d617d]
從結(jié)果看到,我們獲得了兩個(gè)ModuleService。證明系統(tǒng)擴(kuò)展成功。
SPI在JPMS模塊化系統(tǒng)下的實(shí)現(xiàn)
上面我們講的是基本的操作,考慮一下,如果是在JDK9之后,引入了JPMS模塊化系統(tǒng)之后,應(yīng)該怎么使用SPI呢?
代碼肯定是一樣,我們需要修改的是SPI配置文件。
如果在JPMS中,我們就不需要使用META-INF/services了,我們只需要創(chuàng)建相應(yīng)的module-info.java文件即可。
先看下SPI模塊的module-info.java文件:
module com.flydean.service { exports com.flydean.service; }
這個(gè)模塊我們對外暴露了service package,供其他模塊調(diào)用。
接下來是SPI的實(shí)現(xiàn)模塊:
module com.flydean.servicea { requires com.flydean.service; provides com.flydean.service.ModuleService with com.flydean.servicea.ModuleServiceA; exports com.flydean.servicea; }
這里我們使用了provides命令,定義了兩個(gè)類的關(guān)聯(lián)關(guān)系。
最后是調(diào)用的模塊:
module com.flydean.controller { uses com.flydean.service.ModuleService; requires com.flydean.service; requires lombok; requires slf4j.api; }
這里我們使用uses關(guān)鍵詞來引用ModuleService。
總結(jié)
本文介紹了SPI在模塊化和非模塊化系統(tǒng)中的應(yīng)用。
本文中的例子:learn-java-base-9-to-20
補(bǔ)充知識:Java中SPI機(jī)制詳解
本文通過探析JDK提供的,在開源項(xiàng)目中比較常用的Java SPI機(jī)制,希望給大家在實(shí)際開發(fā)實(shí)踐、學(xué)習(xí)開源項(xiàng)目提供參考。
一、 SPI是什么
SPI全稱Service Provider Interface,是Java提供的一套用來被第三方實(shí)現(xiàn)或者擴(kuò)展的API,它可以用來啟用框架擴(kuò)展和替換組件。
整體機(jī)制圖如下:
Java SPI 實(shí)際上是“基于接口的編程+策略模式+配置文件”組合實(shí)現(xiàn)的動態(tài)加載機(jī)制。
系統(tǒng)設(shè)計(jì)的各個(gè)抽象,往往有很多不同的實(shí)現(xiàn)方案,在面向的對象的設(shè)計(jì)里,一般推薦模塊之間基于接口編程,模塊之間不對實(shí)現(xiàn)類進(jìn)行硬編碼。一旦代碼里涉及具體的實(shí)現(xiàn)類,就違反了可拔插的原則,如果需要替換一種實(shí)現(xiàn),就需要修改代碼。為了實(shí)現(xiàn)在模塊裝配的時(shí)候能不在程序里動態(tài)指明,這就需要一種服務(wù)發(fā)現(xiàn)機(jī)制。
Java SPI就是提供這樣的一個(gè)機(jī)制:為某個(gè)接口尋找服務(wù)實(shí)現(xiàn)的機(jī)制。有點(diǎn)類似IOC的思想,就是將裝配的控制權(quán)移到程序之外,在模塊化設(shè)計(jì)中這個(gè)機(jī)制尤其重要。所以SPI的核心思想就是解耦。
二、使用場景
概括地說,適用于:調(diào)用者根據(jù)實(shí)際使用需要,啟用、擴(kuò)展、或者替換框架的實(shí)現(xiàn)策略。
比較常見的例子:
數(shù)據(jù)庫驅(qū)動加載接口實(shí)現(xiàn)類的加載
JDBC加載不同類型數(shù)據(jù)庫的驅(qū)動
日志門面接口實(shí)現(xiàn)類加載
SLF4J加載不同提供商的日志實(shí)現(xiàn)類
Spring
Spring中大量使用了SPI,比如:對servlet3.0規(guī)范
對ServletContainerInitializer的實(shí)現(xiàn)、自動類型轉(zhuǎn)換Type Conversion SPI(Converter SPI、Formatter SPI)等
Dubbo
Dubbo中也大量使用SPI的方式實(shí)現(xiàn)框架的擴(kuò)展, 不過它對Java提供的原生SPI做了封裝,允許用戶擴(kuò)展實(shí)現(xiàn)Filter接口
三、使用介紹
要使用Java SPI,需要遵循如下約定:
當(dāng)服務(wù)提供者提供了接口的一種具體實(shí)現(xiàn)后,在jar包的META-INF/services目錄下創(chuàng)建一個(gè)以“接口全限定名”為命名的文件,內(nèi)容為實(shí)現(xiàn)類的全限定名;
接口實(shí)現(xiàn)類所在的jar包放在主程序的classpath中;
主程序通過java.util.ServiceLoder動態(tài)裝載實(shí)現(xiàn)模塊,它通過掃描META-INF/services目錄下的配置文件找到實(shí)現(xiàn)類的全限定名,把類加載到JVM;
SPI的實(shí)現(xiàn)類必須攜帶一個(gè)不帶參數(shù)的構(gòu)造方法;
四、示例代碼
步驟1、定義一組接口 (假設(shè)是org.foo.demo.IShout),并寫出接口的一個(gè)或多個(gè)實(shí)現(xiàn),(假設(shè)是org.foo.demo.animal.Dog、org.foo.demo.animal.Cat)。
public interface IShout { void shout(); } public class Cat implements IShout { @Override public void shout() { System.out.println("miao miao"); } } public class Dog implements IShout { @Override public void shout() { System.out.println("wang wang"); } }
步驟2、在 src/main/resources/ 下建立 /META-INF/services 目錄, 新增一個(gè)以接口命名的文件 (org.foo.demo.IShout文件),內(nèi)容是要應(yīng)用的實(shí)現(xiàn)類(這里是org.foo.demo.animal.Dog和org.foo.demo.animal.Cat,每行一個(gè)類)。
文件位置
- src
-main
-resources
- META-INF
- services
- org.foo.demo.IShout
文件內(nèi)容
org.foo.demo.animal.Dog
org.foo.demo.animal.Cat
步驟3、使用 ServiceLoader 來加載配置文件中指定的實(shí)現(xiàn)。
public class SPIMain { public static void main(String[] args) { ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class); for (IShout s : shouts) { s.shout(); } } }
代碼輸出:
wang wang
miao miao
五、原理解析
首先看ServiceLoader類的簽名類的成員變量:
public final class ServiceLoader<S> implements Iterable<S>{ private static final String PREFIX = "META-INF/services/"; // 代表被加載的類或者接口 private final Class<S> service; // 用于定位,加載和實(shí)例化providers的類加載器 private final ClassLoader loader; // 創(chuàng)建ServiceLoader時(shí)采用的訪問控制上下文 private final AccessControlContext acc; // 緩存providers,按實(shí)例化的順序排列 private LinkedHashMap<String,S> providers = new LinkedHashMap<>(); // 懶查找迭代器 private LazyIterator lookupIterator; ...... }
參考具體ServiceLoader具體源碼,代碼量不多,加上注釋一共587行,梳理了一下,實(shí)現(xiàn)的流程如下:
1、 應(yīng)用程序調(diào)用ServiceLoader.load方法
ServiceLoader.load方法內(nèi)先創(chuàng)建一個(gè)新的ServiceLoader,并實(shí)例化該類中的成員變量,包括:
loader(ClassLoader類型,類加載器)
acc(AccessControlContext類型,訪問控制器)
providers(LinkedHashMap<String,S>類型,用于緩存加載成功的類)
lookupIterator(實(shí)現(xiàn)迭代器功能)
2、應(yīng)用程序通過迭代器接口獲取對象實(shí)例,ServiceLoader先判斷成員變量providers對象中(LinkedHashMap<String,S>類型)是否有緩存實(shí)例對象,如果有緩存,直接返回。如果沒有緩存,執(zhí)行類的裝載,實(shí)現(xiàn)如下:
讀取META-INF/services/下的配置文件,獲得所有能被實(shí)例化的類的名稱,值得注意的是,ServiceLoader可以跨越j(luò)ar包獲取META-INF下的配置文件,具體加載配置的實(shí)現(xiàn)代碼如下:
try { String fullName = PREFIX + service.getName(); if (loader == null) configs = ClassLoader.getSystemResources(fullName); else configs = loader.getResources(fullName); } catch (IOException x) { fail(service, "Error locating configuration files", x); }
通過反射方法Class.forName()加載類對象,并用instance()方法將類實(shí)例化。
把實(shí)例化后的類緩存到providers對象中,(LinkedHashMap<String,S>類型),然后返回實(shí)例對象。
六、總結(jié)
優(yōu)點(diǎn):
使用Java SPI機(jī)制的優(yōu)勢是實(shí)現(xiàn)解耦,使得第三方服務(wù)模塊的裝配控制的邏輯與調(diào)用者的業(yè)務(wù)代碼分離,而不是耦合在一起。應(yīng)用程序可以根據(jù)實(shí)際業(yè)務(wù)情況啟用框架擴(kuò)展或替換框架組件。
缺點(diǎn):
雖然ServiceLoader也算是使用的延遲加載,但是基本只能通過遍歷全部獲取,也就是接口的實(shí)現(xiàn)類全部加載并實(shí)例化一遍。如果你并不想用某些實(shí)現(xiàn)類,它也被加載并實(shí)例化了,這就造成了浪費(fèi)。獲取某個(gè)實(shí)現(xiàn)類的方式不夠靈活,只能通過Iterator形式獲取,不能根據(jù)某個(gè)參數(shù)來獲取對應(yīng)的實(shí)現(xiàn)類。
多個(gè)并發(fā)多線程使用ServiceLoader類的實(shí)例是不安全的。
以上這篇在java中使用SPI創(chuàng)建可擴(kuò)展的應(yīng)用程序操作就是小編分享給大家的全部內(nèi)容了,希望能給大家一個(gè)參考,也希望大家多多支持腳本之家。
相關(guān)文章
Java數(shù)據(jù)結(jié)構(gòu)超詳細(xì)分析二叉搜索樹
二叉搜索樹是以一棵二叉樹來組織的。每個(gè)節(jié)點(diǎn)是一個(gè)對象,包含的屬性有l(wèi)eft,right,p和key,其中,left指向該節(jié)點(diǎn)的左孩子,right指向該節(jié)點(diǎn)的右孩子,p指向該節(jié)點(diǎn)的父節(jié)點(diǎn),key是它的值2022-03-03Java 程序里transient關(guān)鍵字使用方法示例
這篇文章主要為大家介紹了Java 程序里transient關(guān)鍵字使用方法示例,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11詳解SpringBoot結(jié)合策略模式實(shí)戰(zhàn)套路
這篇文章主要介紹了詳解SpringBoot結(jié)合策略模式實(shí)戰(zhàn)套路,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2019-10-10Java死鎖_動力節(jié)點(diǎn)Java學(xué)院整理
死鎖是兩個(gè)甚至多個(gè)線程被永久阻塞時(shí)的一種運(yùn)行局面,這種局面的生成伴隨著至少兩個(gè)線程和兩個(gè)或者多個(gè)資源。在這里我已寫好一個(gè)簡單的程序,它將會引起死鎖方案然后我們就會明白如何分析它2017-06-06