Java SPI機(jī)制原理及代碼實(shí)例
SPI的全名為:Service Provider Interface,大多數(shù)開發(fā)人員可能不熟悉,因?yàn)檫@個(gè)是針對(duì)廠商或者插件的。在java.util.ServiceLoader的文檔里有比較詳細(xì)的介紹。
簡單的總結(jié)下 Java SPI 機(jī)制的思想。我們系統(tǒng)里抽象的各個(gè)模塊,往往有很多不同的實(shí)現(xiàn)方案,比如日志模塊的方案,xml解析模塊、jdbc模塊的方案等。面向的對(duì)象的設(shè)計(jì)里,我們一般推薦模塊之間基于接口編程,模塊之間不對(duì)實(shí)現(xiàn)類進(jìn)行硬編碼。
一旦代碼里涉及具體的實(shí)現(xiàn)類,就違反了可拔插的原則,如果需要替換一種實(shí)現(xiàn),就需要修改代碼。為了實(shí)現(xiàn)在模塊裝配的時(shí)候能不在程序里動(dòng)態(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ī)制尤其重要。
Java SPI 的具體約定為:當(dāng)服務(wù)的提供者,提供了服務(wù)接口的一種實(shí)現(xiàn)之后,在jar包的META-INF/services/目錄里同時(shí)創(chuàng)建一個(gè)以服務(wù)接口命名的文件。該文件里就是實(shí)現(xiàn)該服務(wù)接口的具體實(shí)現(xiàn)類。
而當(dāng)外部程序裝配這個(gè)模塊的時(shí)候,就能通過該jar包META-INF/services/里的配置文件找到具體的實(shí)現(xiàn)類名,并裝載實(shí)例化,完成模塊的注入。
基于這樣一個(gè)約定就能很好的找到服務(wù)接口的實(shí)現(xiàn)類,而不需要再代碼里制定。jdk提供服務(wù)實(shí)現(xiàn)查找的一個(gè)工具類:java.util.ServiceLoader。
1.common-logging
apache最早提供的日志的門面接口。只有接口,沒有實(shí)現(xiàn)。具體方案由各提供商實(shí)現(xiàn), 發(fā)現(xiàn)日志提供商是通過掃描 META-INF/services/org.apache.commons.logging.LogFactory配置文件,通過讀取該文件的內(nèi)容找到日志提工商實(shí)現(xiàn)類。
只要我們的日志實(shí)現(xiàn)里包含了這個(gè)文件,并在文件里制定 LogFactory工廠接口的實(shí)現(xiàn)類即可。關(guān)注Java技術(shù)棧微信公眾號(hào),在后臺(tái)回復(fù)關(guān)鍵字:Java,可以獲取更多棧長整理的Java技術(shù)干貨。
2.jdbc
jdbc4.0以前, 開發(fā)人員還需要基于Class.forName('xxx')的方式來裝載驅(qū)動(dòng),jdbc4也基于spi的機(jī)制來發(fā)現(xiàn)驅(qū)動(dòng)提供商了,可以通過META-INF/services/java.sql.Driver文件里指定實(shí)現(xiàn)類的方式來暴露驅(qū)動(dòng)提供者。
一個(gè)內(nèi)容管理系統(tǒng)有一個(gè)搜索模塊。是基于接口編程的。搜索的實(shí)現(xiàn)可能是基于文件系統(tǒng)的搜索,也可能是基于數(shù)據(jù)庫的搜索
接口定義如下:
package my.xyz.spi;import java.util.List;public interface Search { public List serch(String keyword);}
A公司采用文件系統(tǒng)搜索的方式實(shí)現(xiàn)了 Search接口,B公司采用了數(shù)據(jù)庫系統(tǒng)的方式實(shí)現(xiàn)了Search接口。
A公司實(shí)現(xiàn)的類:com.A.spi.impl.FileSearch
B公司實(shí)現(xiàn)的類:com.B.spi.impl.DatabaseSearch
那么A公司發(fā)布 實(shí)現(xiàn)jar包時(shí),則要在jar包中META-INF/services/my.xyz.spi.Search文件中寫下如下內(nèi)容:
com.A.spi.impl.FileSearch
那么B公司發(fā)布 實(shí)現(xiàn)jar包時(shí),則要在jar包中META-INF/services/my.xyz.spi.Search文件中寫下如下內(nèi)容:
com.B.spi.impl.DatabaseSearch
下面是 SPI 測(cè)試代碼:
package com.xyz.factory;import java.util.Iterator;import java.util.ServiceLoader;import my.xyz.spi.Search;public class SearchFactory { private SearchFactory() { } public static Search newSearch() { Search search = null; ServiceLoader<Search> serviceLoader = ServiceLoader.load(Search.class); Iterator<Search> searchs = serviceLoader.iterator(); if (searchs.hasNext()) { search = searchs.next(); } return search; }}
以上就是本文的全部內(nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持好吧啦網(wǎng)。
相關(guān)文章:
1. vue實(shí)現(xiàn)web在線聊天功能2. 完美解決vue 中多個(gè)echarts圖表自適應(yīng)的問題3. JavaScript實(shí)現(xiàn)頁面動(dòng)態(tài)驗(yàn)證碼的實(shí)現(xiàn)示例4. 解決Android Studio 格式化 Format代碼快捷鍵問題5. JavaEE SpringMyBatis是什么? 它和Hibernate的區(qū)別及如何配置MyBatis6. Java使用Tesseract-Ocr識(shí)別數(shù)字7. Python使用urlretrieve實(shí)現(xiàn)直接遠(yuǎn)程下載圖片的示例代碼8. 在Chrome DevTools中調(diào)試JavaScript的實(shí)現(xiàn)9. Springboot 全局日期格式化處理的實(shí)現(xiàn)10. SpringBoot+TestNG單元測(cè)試的實(shí)現(xiàn)
