Java中的SPI機制

在學習SPI之前卓缰,在了解一下API(應用程序接口)慌盯,API就是服務方定義好接口和實現(xiàn)枫耳,然后提供暴露一個接口給調用方乏矾。那什么是SPI呢?

SPI介紹

SPI 迁杨,全稱為 Service Provider Interface钻心,是一種服務發(fā)現(xiàn)機制。它通過在classpath路徑下的META-INF/services文件夾查找文件铅协,自動加載文件里所定義的類捷沸。Java自身提供的服務發(fā)現(xiàn)機制,是掃描META-INF/services文件夾文件定義的類狐史。但是痒给,也可以自己實現(xiàn)SPI功能,掃描不同的文件夾文件骏全,像DubboSPI機制和SpirngBootSPI機制苍柏,都是自己實現(xiàn)的SPI功能,這為很多框架拓展功能提供了更多的可能性姜贡。

SPI可以讓開發(fā)者拓展JDK自身或者框架本身的功能,就是說開發(fā)者是服務實現(xiàn)方试吁,而JDK或者框架是服務調用方。

簡而言之楼咳,就是指定那個目錄下熄捍,通過全限定類名去加載對應的類。

思考母怜,為什么需要SPI

思考一個問題余耽,有這樣一個需求,需要為某個開源框架或者已有的系統(tǒng)拓展一下功能苹熏。

比較常見的做法可能是在原來的代碼進行修改碟贾,然后重新編譯打包再發(fā)布币喧。

那有沒有方法可以不修改原來代碼就可以進行拓展呢?答案就是SPI袱耽,這要求原來提供框架的開發(fā)者粱锐,使用SPI,定義接口(interface)或者抽象類(abstract class), 以及實現(xiàn)了服務接口的具體類扛邑。

在使用中怜浅,框架提供接口,框架提供基礎的實現(xiàn)類蔬崩,開發(fā)者可以去拓展自己的實現(xiàn)類恶座。其中實現(xiàn)類的定義需要放在META-INF/services下面, 在運行時框架會掃描服務配置文件下面的實現(xiàn)類,從而框架就可以調用沥阳。

使用實例

定義一個接口

public interface SPIService {
    void service();
}

原系統(tǒng)調用

public class SPIServiceTest {
    public static void main(String[] args) {
        ServiceLoader<SPIService> spiServices = ServiceLoader.load(SPIService.class);
        Iterator<SPIService> iterator = spiServices.iterator();
        while (iterator.hasNext()) {
            SPIService next = iterator.next();
            next.service();
        }
    }
}

實現(xiàn)類1

public class SPIServiceA implements SPIService {
    @Override
    public void service() {
        System.out.println("SPIServiceA");
    }
}

實現(xiàn)類2

public class SPIServiceB implements SPIService {
    @Override
    public void service() {
        System.out.println("SPIServiceB");
    }
}

resource下面新建META-INF/services目錄跨琳,然后新建文件com.spi.learn.service.SPIService

文件內容

com.spi.learn.service.SPIServiceA
com.spi.learn.service.SPIServiceB

JDK應用場景——Driver

java.sql.DriverManager類的loadInitialDrivers()方法中

    private static void loadInitialDrivers() {
        ....

        AccessController.doPrivileged(new PrivilegedAction<Void>() {
            public Void run() {

                ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
                Iterator<Driver> driversIterator = loadedDrivers.iterator();

                /* Load these drivers, so that they can be instantiated.
                 * It may be the case that the driver class may not be there
                 * i.e. there may be a packaged driver with the service class
                 * as implementation of java.sql.Driver but the actual class
                 * may be missing. In that case a java.util.ServiceConfigurationError
                 * will be thrown at runtime by the VM trying to locate
                 * and load the service.
                 *
                 * Adding a try catch block to catch those runtime errors
                 * if driver not available in classpath but it's
                 * packaged as service and that service is there in classpath.
                 */
                try{
                    while(driversIterator.hasNext()) {
                        driversIterator.next();
                    }
                } catch(Throwable t) {
                // Do nothing
                }
                return null;
            }
        });

        ....
    }

其中ServiceLoader.load(Driver.class)會去加載META-INF/services目錄下,所有實現(xiàn)了Driver接口的類桐罕,因此在mysql中實現(xiàn)了Driver接口的類會被加載脉让,然后執(zhí)行靜態(tài)塊,這樣子就實現(xiàn)了不同數(shù)據(jù)庫的驅動注冊功炮。

com.mysql.jdbc.Driver

public class Driver extends NonRegisteringDriver implements java.sql.Driver {
    //
    // Register ourselves with the DriverManager
    // static塊溅潜,執(zhí)行這行Class.forName("com.mysql.jdbc.Driver");的時候,會調用static塊
    static {
        try {
            java.sql.DriverManager.registerDriver(new Driver());
        } catch (SQLException E) {
            throw new RuntimeException("Can't register driver!");
        }
    }

    /**
     * Construct a new driver and register it with DriverManager
     * 
     * @throws SQLException
     *             if a database error occurs.
     */
    public Driver() throws SQLException {
        // Required for Class.forName().newInstance()
    }
}
?著作權歸作者所有,轉載或內容合作請聯(lián)系作者
  • 序言:七十年代末薪伏,一起剝皮案震驚了整個濱河市滚澜,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌嫁怀,老刑警劉巖设捐,帶你破解...
    沈念sama閱讀 216,496評論 6 501
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異塘淑,居然都是意外死亡萝招,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,407評論 3 392
  • 文/潘曉璐 我一進店門存捺,熙熙樓的掌柜王于貴愁眉苦臉地迎上來槐沼,“玉大人,你說我怎么就攤上這事召噩∧刚裕” “怎么了逸爵?”我有些...
    開封第一講書人閱讀 162,632評論 0 353
  • 文/不壞的土叔 我叫張陵具滴,是天一觀的道長。 經常有香客問我师倔,道長构韵,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,180評論 1 292
  • 正文 為了忘掉前任,我火速辦了婚禮疲恢,結果婚禮上凶朗,老公的妹妹穿的比我還像新娘。我一直安慰自己显拳,他們只是感情好棚愤,可當我...
    茶點故事閱讀 67,198評論 6 388
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著杂数,像睡著了一般宛畦。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上揍移,一...
    開封第一講書人閱讀 51,165評論 1 299
  • 那天次和,我揣著相機與錄音,去河邊找鬼那伐。 笑死踏施,一個胖子當著我的面吹牛,可吹牛的內容都是我干的罕邀。 我是一名探鬼主播畅形,決...
    沈念sama閱讀 40,052評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼诉探!你這毒婦竟也來了束亏?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 38,910評論 0 274
  • 序言:老撾萬榮一對情侶失蹤阵具,失蹤者是張志新(化名)和其女友劉穎碍遍,沒想到半個月后,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體阳液,經...
    沈念sama閱讀 45,324評論 1 310
  • 正文 獨居荒郊野嶺守林人離奇死亡怕敬,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,542評論 2 332
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了帘皿。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片东跪。...
    茶點故事閱讀 39,711評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖鹰溜,靈堂內的尸體忽然破棺而出虽填,到底是詐尸還是另有隱情,我是刑警寧澤曹动,帶...
    沈念sama閱讀 35,424評論 5 343
  • 正文 年R本政府宣布斋日,位于F島的核電站,受9級特大地震影響墓陈,放射性物質發(fā)生泄漏恶守。R本人自食惡果不足惜第献,卻給世界環(huán)境...
    茶點故事閱讀 41,017評論 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望兔港。 院中可真熱鬧庸毫,春花似錦、人聲如沸衫樊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,668評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽科侈。三九已至盒揉,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間兑徘,已是汗流浹背刚盈。 一陣腳步聲響...
    開封第一講書人閱讀 32,823評論 1 269
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留挂脑,地道東北人藕漱。 一個月前我還...
    沈念sama閱讀 47,722評論 2 368
  • 正文 我出身青樓,卻偏偏與公主長得像崭闲,于是被迫代替她去往敵國和親肋联。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 44,611評論 2 353

推薦閱讀更多精彩內容