最近學習了JDK SPI

JDK SPI是什麼

最近工做中聽幾個同事說了好幾回SPI這個名詞，雖然和我不要緊，可是內心默默想仍是學習一下，否則下次和我說到SPI，連是什麼都不知道那就尷尬了。

因此SPI是什麼呢？SPI全稱Service Provider Interface，在Java中仍是一個比較重要的概念，是Java提供的一套用來被第三方實現或者擴展的API，或者換句話說，SPI是一種服務發現機制。

 

JDK SPI使用說明及示例

要使用SPI比較簡單，只須要按照如下幾個步驟操做便可：

• 在jar包的META-INF/services目錄下建立一個以"接口全限定名"爲命名的文件，內容爲實現類的全限定名
• 接口實現類所在的jar包在classpath下
• 主程序經過java.util.ServiceLoader動態狀態實現模塊，它經過掃描META-INF/services目錄下的配置文件找到實現類的全限定名，把類加載到JVM
• SPI的實現類必須帶一個無參構造方法

接着咱們看一下具體例子，首先定義一個SpiService，它是一個接口：

package org.xrq.test.spi;

public interface SpiService {

    public void hello();
    
}

兩個實現類，分別爲SpiServiceA與SpiServiceB：

package org.xrq.test.spi;

public class SpiServiceA implements SpiService {

    public void hello() {
        System.out.println("SpiServiceA.Hello");
    }
    
}

package org.xrq.test.spi;

public class SpiServiceB implements SpiService {

    @Override
    public void hello() {
        System.out.println("SpiServiceB.hello");
    }
    
}

接着咱們建一個META-INF/services的文件夾，裏面建一個file，file的名字是接口的全限定名org.xrq.test.spi.SpiService：

文件的內容是SpiService實現類SpiServiceA、SpiServiceB的全限定名：

org.xrq.test.spi.SpiServiceA
org.xrq.test.spi.SpiServiceB

這樣就大功告成了！而後咱們寫個測試類自動加載一下這兩個類：

public class SpiTest {

    @Test
    public void testSpi() {
        ServiceLoader<SpiService> serviceLoader = ServiceLoader.load(SpiService.class);
        
        Iterator<SpiService> iterator = serviceLoader.iterator();
        while (iterator.hasNext()) {
            SpiService spiService = iterator.next();
            
            spiService.hello();
        }
    }
    
}

結果一目瞭然，調用了hello()方法：

SpiServiceA.Hello
SpiServiceB.hello

這就是SPI的使用示例，接着咱們看一下SPI在實際場景中的應用。

 

SPI在JDBC中的應用

回看快四年前的文章http://www.javashuo.com/article/p-bxqcguso-dg.html，這篇名爲《JDBC學習2：爲何要寫Class.forName("XXX")？》的文章裏面當時技術真的是稚嫩，爲何不寫Class.forName("XXX")的解釋如今看來真的是弱爆了，最後一樓網友的回覆"不用寫的緣由是，新版本JDBC使用了SPI"，因此學了一下SPI立刻就想起這個例子來了，所以就由JDBC講講SPI的實際應用。

在老版本的JDBC中，假設咱們使用的是MySql，初始化JDBC的時候是須要顯式調用Class.forName("com.mysql.jdbc.Driver")這一句的，可是在某個版本以後就不須要作這一步操做了，如上所說這是經過SPI實現的，怎麼理解呢。Class.forName其實沒有實際意義，其實既不會new對象也不會反射生成對象，它只是爲了調用com.mysql.jdbc.Driver的static方法塊而已：

public class Driver extends NonRegisteringDriver implements java.sql.Driver {
    //
    // Register ourselves with the DriverManager
    //
    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()
    }
}

方法塊的做用只有一個，經過jdk自帶的DriverManager註冊Driver，registerDrivers方法沒什麼套路，把Driver放到CopyOnArrayList裏面而已：

public static synchronized void registerDriver(java.sql.Driver driver, DriverAction da)
      throws SQLException {

    /* Register the driver if it has not already been added to our list */
    if(driver != null) {
        registeredDrivers.addIfAbsent(new DriverInfo(driver, da));
    } else {
        // This is for compatibility with the original DriverManager
        throw new NullPointerException();
    }

    println("registerDriver: " + driver);

}

從某個JDK版本，具體也不知道哪一個版本，廢棄了這個操做，看下新版的DriverManager，個人是JDK1.8的：

/**
 * Load the initial JDBC drivers by checking the System property
 * jdbc.properties and then use the {@code ServiceLoader} mechanism
 */
static {
    loadInitialDrivers();
    println("JDBC DriverManager initialized");
}

直接看一下loadInitialDrivers這個方法的核心部分：

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

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

        /* 
         * 節約篇幅，註釋省略
         */
        try{
            while(driversIterator.hasNext()) {
               driversIterator.next();
            }
        } catch(Throwable t) {
        // Do nothing
        }
        return null;
    }
});

看到使用SPI的方式從META-INF/services下去找java.sql.Driver這個文件，並找到裏面的Driver實現類逐一注入。最後咱們看一下Iterator的next()方法作了什麼就徹底懂了，經過next()方法調用了：

private S nextService() {
    if (!hasNextService())
        throw new NoSuchElementException();
    String cn = nextName;
    nextName = null;
    Class<?> c = null;
    try {
        c = Class.forName(cn, false, loader);
    } catch (ClassNotFoundException x) {
        fail(service,
             "Provider " + cn + " not found");
   }
    if (!service.isAssignableFrom(c)) {
       fail(service,
             "Provider " + cn  + " not a subtype");
    }
    try {
        S p = service.cast(c.newInstance());
        providers.put(cn, p);
        return p;
    } catch (Throwable x) {
        fail(service,
             "Provider " + cn + " could not be instantiated",
            x);
    }
    throw new Error();          // This cannot happen
}
            

看到Class.forName了吧，雖然都是Class.forName，可是經過SPI的方式把用戶手動作的動做變成框架作。

 

對SPI的理解

最後談一談我對SPI的理解，學習了怎麼用SPI、SPI在實際應用中的示例以後，深入理解SPI機制才能在之後工做中真正將SPI爲我所用。

首先你們能夠注意到，標題是JDK SPI，也就是說SPI並非JDK專屬的。是的，我理解的SPI實際上是一種可插拔技術的總稱，最簡單的例子就是USB，廠商提供了USB的標準，廠家根據USB的標準制造本身的外設，例如鼠標、鍵盤、遊戲手柄等等，可是USB標準具體在電腦中是怎麼用的，廠家就不須要管了。

回到咱們的代碼中也是同樣的道理。當咱們開發一個框架的時候，除了保證基本的功能外，最重要的一個點是什麼？我認爲最重要的應該是鬆耦合，即對擴展開放、對修改關閉，保證框架實現對於使用者來講是黑盒。

框架不可能作好全部的事情，只能把共性的部分抽離出來進行流程化，鬆耦合實現的核心就是定義好足夠鬆散的接口，或者能夠理解是擴展點，具體的擴展點讓使用者去實現，這樣不一樣的擴展就不須要修改源代碼或者對框架進行定製，這就是面向接口編程的好處。

回到咱們框架的部分來講：

• JDK對於SPI的實現是經過META-INF/services這個目錄 + ServiceLoader
• Spring實現SPI的方式是留了N多的接口，例如BeanPostProcessor、InitializingBean、DisposableBean，咱們只須要實現這些接口而後注入便可

對已有框架而言，咱們能夠經過框架給咱們提供的擴展點擴展框架功能。對本身寫框架而言，記得SPI這個事情，留好足夠的擴展點，這將大大增強你寫的框架的擴展性。