SPI(Service Provider Interface)

參考文檔:Java SPI(Service Provider Interface)簡(jiǎn)介(http://blog.csdn.net/top_code/article/details/51934459

一庞萍、SPI 是什么?

SPI 全稱為 (Service Provider Interface) ,是JDK內(nèi)置的一種服務(wù)提供發(fā)現(xiàn)機(jī)制。

二、SPI如何使用?

一個(gè)服務(wù)(Service)通常指的是已知的接口或者抽象類薯鼠,服務(wù)提供方就是對(duì)這個(gè)接口或者抽象類的實(shí)現(xiàn),然后按照SPI 標(biāo)準(zhǔn)存放到資源路徑META-INF/services目錄下,文件的命名為該服務(wù)接口的全限定名番官。如有一個(gè)服務(wù)接口:

package com.ricky.codelab.spi;

public interface DemoService {

    public String sayHi(String msg);
}

其實(shí)現(xiàn)類為:

package com.ricky.codelab.spi.impl;

import com.ricky.codelab.spi.DemoService;

public class DemoServiceImpl implements DemoService {

    @Override
    public String sayHi(String msg) {

        return "Hello, "+msg;
    }

}

那此時(shí)需要在META-INF/services中創(chuàng)建一個(gè)名為com.ricky.codelab.spi.DemoService的文件,其中的內(nèi)容就為該實(shí)現(xiàn)類的全限定名:com.ricky.codelab.spi.impl.DemoServiceImpl钢属。
如果該Service有多個(gè)服務(wù)實(shí)現(xiàn)徘熔,則每一行寫(xiě)一個(gè)服務(wù)實(shí)現(xiàn)(#后面的內(nèi)容為注釋),并且該文件只能夠是以UTF-8編碼淆党。

tip 1

如果有多個(gè)實(shí)現(xiàn)近顷,你取出的時(shí)候?yàn)榧希J(rèn)是文件實(shí)現(xiàn)類的順序加載類宁否,如果要自定義order方法窒升,以便取出所有服務(wù)實(shí)現(xiàn)類后,可以按照設(shè)定進(jìn)行排序

三慕匠、ServiceLoader的用途

之前我們只是配置好了SPI饱须,但是SPI是如何真正在java程序中使用的,必須依靠ServiceLoader來(lái)動(dòng)態(tài)加載Service的實(shí)現(xiàn)類了台谊。

許多開(kāi)發(fā)框架都使用了Java的SPI機(jī)制蓉媳,如java.sql.Driver的SPI實(shí)現(xiàn)(mysql驅(qū)動(dòng)、oracle驅(qū)動(dòng)等)锅铅、common-logging的日志接口實(shí)現(xiàn)酪呻、dubbo的擴(kuò)展實(shí)現(xiàn)等等。這些本質(zhì)上盐须,都是框架幫你用ServiceLoader做好了加載SPI等流程

META-INF/services/配置

在src/main/resources 下創(chuàng)建META-INF/services/目錄玩荠,并新建com.ricky.codelab.spi.DemoService文件,內(nèi)容如下:

#English implementation
com.ricky.codelab.spi.impl.EnglishDemoServiceImpl

#Chinese implementation
com.ricky.codelab.spi.impl.ChineseDemoServiceImpl

加載Service實(shí)現(xiàn)類

import java.util.Iterator;
import java.util.ServiceLoader;
import com.ricky.codelab.spi.DemoService;

ServiceLoader<DemoService> serviceLoader = ServiceLoader.load(DemoService.class);
Iterator<DemoService> it = serviceLoader.iterator();
while (it!=null && it.hasNext()) {
     DemoService demoService = it.next();
 System.out.println("class:"+demoService.getClass().getName()+"***"+demoService.sayHi("World"));
}

運(yùn)行結(jié)果
···
class:com.ricky.codelab.spi.impl.DemoServiceImplHello, World
class:com.ricky.codelab.spi.impl.ChineseDemoServiceImpl
你好, World
···

知識(shí)儲(chǔ)備:

1.Meta-Inf文件夾
所謂META-INF, 說(shuō)白了就是存放一些meta information相關(guān)的文件的這么一個(gè)文件夾, 一般來(lái)說(shuō)盡量不要自己手工放置文件到這個(gè)文件夾贼邓。怎么理解這句話呢阶冈?就是說(shuō)這個(gè)文件夾應(yīng)該被看作是JAVA工程的一個(gè)內(nèi)部META目錄,所以這個(gè)目錄下的文件應(yīng)該都是build工具來(lái)生成的塑径。我們自己的文件應(yīng)該直接放到根目錄下或者其他的子目錄中女坑。

根據(jù)官方的JAR file specification(http://docs.oracle.com/javase/7/docs/technotes/guides/jar/jar.html), 一個(gè)典型的META-INF目錄下可能包含如下幾種文件或者子目錄:
MANIFEST.MF
INDEX.LIST
x.SF
x.DSA
services/

如果你將Jar中的META-INF文件夾刪除,那么jar文件里邊就沒(méi)有MANIFEST.MF文件统舀。那么匆骗,java -jar就找不到main class.
沒(méi)有META-INF你仍然可以創(chuàng)建一個(gè)Jar文件劳景。但是,當(dāng)你想要執(zhí)行jar文件的時(shí)候碉就,這個(gè)jar是需要具備 META-INF/MANIFEST.MF的枢泰。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市铝噩,隨后出現(xiàn)的幾起案子衡蚂,更是在濱河造成了極大的恐慌,老刑警劉巖骏庸,帶你破解...
    沈念sama閱讀 222,681評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件毛甲,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡具被,警方通過(guò)查閱死者的電腦和手機(jī)玻募,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,205評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門(mén),熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)一姿,“玉大人七咧,你說(shuō)我怎么就攤上這事《L荆” “怎么了艾栋?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,421評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)蛉顽。 經(jīng)常有香客問(wèn)我蝗砾,道長(zhǎng),這世上最難降的妖魔是什么携冤? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,114評(píng)論 1 300
  • 正文 為了忘掉前任悼粮,我火速辦了婚禮,結(jié)果婚禮上曾棕,老公的妹妹穿的比我還像新娘扣猫。我一直安慰自己,他們只是感情好翘地,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,116評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布申尤。 她就那樣靜靜地躺著,像睡著了一般子眶。 火紅的嫁衣襯著肌膚如雪瀑凝。 梳的紋絲不亂的頭發(fā)上序芦,一...
    開(kāi)封第一講書(shū)人閱讀 52,713評(píng)論 1 312
  • 那天臭杰,我揣著相機(jī)與錄音,去河邊找鬼谚中。 笑死渴杆,一個(gè)胖子當(dāng)著我的面吹牛寥枝,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播磁奖,決...
    沈念sama閱讀 41,170評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼囊拜,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了比搭?” 一聲冷哼從身側(cè)響起冠跷,我...
    開(kāi)封第一講書(shū)人閱讀 40,116評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎身诺,沒(méi)想到半個(gè)月后蜜托,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,651評(píng)論 1 320
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡霉赡,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,714評(píng)論 3 342
  • 正文 我和宋清朗相戀三年橄务,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片穴亏。...
    茶點(diǎn)故事閱讀 40,865評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡蜂挪,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出嗓化,到底是詐尸還是另有隱情棠涮,我是刑警寧澤,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布刺覆,位于F島的核電站故爵,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏隅津。R本人自食惡果不足惜诬垂,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,211評(píng)論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望伦仍。 院中可真熱鬧结窘,春花似錦、人聲如沸充蓝。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,699評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)谓苟。三九已至官脓,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間涝焙,已是汗流浹背卑笨。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,814評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留仑撞,地道東北人赤兴。 一個(gè)月前我還...
    沈念sama閱讀 49,299評(píng)論 3 379
  • 正文 我出身青樓妖滔,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親桶良。 傳聞我的和親對(duì)象是個(gè)殘疾皇子座舍,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,870評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容