1 SPI機制簡介

SPI的全名為Service Provider Interface.大多數開發人員可能不熟悉，因為這個是針對廠商或者外掛的。在java.util.ServiceLoader的文件裡有比較詳細的介紹。簡單的總結下java spi機制的思想。我們系統裡抽象的各個模組，往往有很多不同的實現方案，比如日誌模組的方案，xml解析模組、jdbc模組的方案等。面向的物件的設計裡，我們一般推薦模組之間基於介面程式設計，模組之間不對實現類進行硬編碼。一旦程式碼裡涉及具體的實現類，就違反了可拔插的原則，如果需要替換一種實現，就需要修改程式碼。為了實現在模組裝配的時候能不在程式裡動態指明，這就需要一種服務發現機制。
 
 java spi就是提供這樣的一個機制：為某個介面尋找服務實現的機制。有點類似IOC的思想，就是將裝配的控制權移到程式之外，在模組化設計中這個機制尤其重要。

2 SPI具體約定

java spi的具體約定為:當服務的提供者，提供了服務介面的一種實現之後，在jar包的META-INF/services/目錄裡同時建立一個以服務介面命名的檔案。該檔案裡就是實現該服務介面的具體實現類。而當外部程式裝配這個模組的時候，就能通過該jar包META-INF/services/裡的配置檔案找到具體的實現類名，並裝載例項化，完成模組的注入。 基於這樣一個約定就能很好的找到服務介面的實現類，而不需要再程式碼裡制定。jdk提供服務實現查詢的一個工具類：java.util.ServiceLoader
 

3 應用場景

1.common-logging
apache最早提供的日誌的門面介面。只有介面，沒有實現。具體方案由各提供商實現， 發現日誌提供商是通過掃描 META-INF/services/org.apache.commons.logging.LogFactory配置檔案，通過讀取該檔案的內容找到日誌提工商實現類。只要我們的日誌實現裡包含了這個檔案，並在檔案裡制定 LogFactory工廠介面的實現類即可。
      2.jdbc
    jdbc4.0以前， 開發人員還需要基於Class.forName("xxx")的方式來裝載驅動，jdbc4也基於spi的機制來發現驅動提供商了，可以通過META-INF/services/java.sql.Driver檔案裡指定實現類的方式來暴露驅動提供者.
 

4 案例說明

一個內容管理系統有一個搜尋模組。是基於介面程式設計的。搜尋的實現可能是基於檔案系統的搜尋，也可能是基於資料庫的搜尋

  介面定義如下

1. package my.xyz.spi;  
2. import java.util.List;  
3. public interface Search {  
4.    public List serch(String keyword);  
5. }    

     A公司採用檔案系統搜尋的方式實現了 Search介面，B公司採用了資料庫系統的方式實現了Search介面

          A公司實現的類  com.A.spi.impl.FileSearch  

          B公司實現的類  com.B.spi.impl.DatabaseSearch  

     那麼A公司釋出 實現jar包時，則要在jar包中META-INF/services/my.xyz.spi.Search檔案中寫下如下內容

     com.A.spi.impl.FileSearch

那麼B公司釋出 實現jar包時，則要在jar包中META-INF/services/my.xyz.spi.Search檔案中寫下如下內容

com.B.spi.impl.DatabaseSearch

1. package com.xyz.factory;  
2. import java.util.Iterator;  
3. import java.util.ServiceLoader;  
4. import my.xyz.spi.Search;  
5. public class SearchFactory {  
6.     private SearchFactory() {  
7.     }  
8.     public static Search newSearch() {  
9.         Search search = null;  
10.         ServiceLoader<Search> serviceLoader = ServiceLoader.load(Search.class);  
11.         Iterator<Search> searchs = serviceLoader.iterator();  
12.         if (searchs.hasNext()) {  
13.             search = searchs.next();  
14.         }  
15.         return search;  
16.     }  
17. }  

1. package my.xyz.test;  
2. import java.util.Iterator;  
3. import java.util.ServiceLoader;  
4. import com.xyz.factory.SearchFactory;  
5. import my.xyz.spi.Search;  
6. public class SearchTest {  
7.     public static void main(String[] args) {  
8.         Search search = SearchFactory.newSearch();  
9.         search.serch("java spi test");  
10.     }  
11. }