深入理解SPI機制

一、什么是SPI

SPI ，全稱為 Service Provider Interface，是一種服務發現機制。它通過在ClassPath路徑下的META-INF/services文件夾查找文件，自動加載文件里所定義的類。

這一機制為很多框架擴展提供了可能，比如在Dubbo、JDBC中都使用到了SPI機制。我們先通過一個很簡單的例子來看下它是怎么用的。

1、小栗子

首先，我們需要定義一個接口，SPIService

package com.viewscenes.netsupervisor.spi;
public interface SPIService {
    void execute();
}

然后，定義兩個實現類，沒別的意思，只輸入一句話。

package com.viewscenes.netsupervisor.spi;
public class SpiImpl1 implements SPIService{
    public void execute() {
        System.out.println("SpiImpl1.execute()");
    }
}
----------------------我是乖巧的分割線----------------------
package com.viewscenes.netsupervisor.spi;
public class SpiImpl2 implements SPIService{
    public void execute() {
        System.out.println("SpiImpl2.execute()");
    }
}

最后呢，要在ClassPath路徑下配置添加一個文件。文件名字是接口的全限定類名，內容是實現類的全限定類名，多個實現類用換行符分隔。
文件路徑如下：

 

 內容就是實現類的全限定類名：

com.viewscenes.netsupervisor.spi.SpiImpl1
com.viewscenes.netsupervisor.spi.SpiImpl2

2、測試

然后我們就可以通過ServiceLoader.load或者Service.providers方法拿到實現類的實例。其中，Service.providers包位於sun.misc.Service，而ServiceLoader.load包位於java.util.ServiceLoader。

public class Test {
    public static void main(String[] args) {    
        Iterator<SPIService> providers = Service.providers(SPIService.class);
        ServiceLoader<SPIService> load = ServiceLoader.load(SPIService.class);

        while(providers.hasNext()) {
            SPIService ser = providers.next();
            ser.execute();
        }
        System.out.println("--------------------------------");
        Iterator<SPIService> iterator = load.iterator();
        while(iterator.hasNext()) {
            SPIService ser = iterator.next();
            ser.execute();
        }
    }
}

兩種方式的輸出結果是一致的：

SpiImpl1.execute()
SpiImpl2.execute()
--------------------------------
SpiImpl1.execute()
SpiImpl2.execute()

二、源碼分析

我們看到一個位於sun.misc包，一個位於java.util包，sun包下的源碼看不到。我們就以ServiceLoader.load為例，通過源碼看看它里面到底怎么做的。

1、ServiceLoader

首先，我們先來了解下ServiceLoader，看看它的類結構。

public final class ServiceLoader<S> implements Iterable<S>
    //配置文件的路徑
    private static final String PREFIX = "META-INF/services/";
    //加載的服務類或接口
    private final Class<S> service;
    //已加載的服務類集合
    private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
    //類加載器
    private final ClassLoader loader;
    //內部類，真正加載服務類
    private LazyIterator lookupIterator;
}

2、Load

load方法創建了一些屬性，重要的是實例化了內部類，LazyIterator。最后返回ServiceLoader的實例。

public final class ServiceLoader<S> implements Iterable<S>
    private ServiceLoader(Class<S> svc, ClassLoader cl) {
        //要加載的接口
        service = Objects.requireNonNull(svc, "Service interface cannot be null");
        //類加載器
        loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
        //訪問控制器
        acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
        //先清空
        providers.clear();
        //實例化內部類 
        LazyIterator lookupIterator = new LazyIterator(service, loader);
    }
}

3、查找實現類

查找實現類和創建實現類的過程，都在LazyIterator完成。當我們調用iterator.hasNext和iterator.next方法的時候，實際上調用的都是LazyIterator的相應方法。

public Iterator<S> iterator() {
    return new Iterator<S>() {
        public boolean hasNext() {
            return lookupIterator.hasNext();
        }
        public S next() {
            return lookupIterator.next();
        }
        .......
    };
}

所以，我們重點關注lookupIterator.hasNext()方法，它最終會調用到hasNextService。

private class LazyIterator implements Iterator<S>{
    Class<S> service;
    ClassLoader loader;
    Enumeration<URL> configs = null;
    Iterator<String> pending = null;
    String nextName = null; 
    private boolean hasNextService() {
        //第二次調用的時候，已經解析完成了，直接返回
        if (nextName != null) {
            return true;
        }
        if (configs == null) {
            //META-INF/services/ 加上接口的全限定類名，就是文件服務類的文件
            //META-INF/services/com.viewscenes.netsupervisor.spi.SPIService
            String fullName = PREFIX + service.getName();
            //將文件路徑轉成URL對象
            configs = loader.getResources(fullName);
        }
        while ((pending == null) || !pending.hasNext()) {
            //解析URL文件對象，讀取內容，最后返回
            pending = parse(service, configs.nextElement());
        }
        //拿到第一個實現類的類名
        nextName = pending.next();
        return true;
    }
}

4、創建實例

當然，調用next方法的時候，實際調用到的是，lookupIterator.nextService。它通過反射的方式，創建實現類的實例並返回。

private class LazyIterator implements Iterator<S>{
    private S nextService() {
        //全限定類名
        String cn = nextName;
        nextName = null;
        //創建類的Class對象
        Class<?> c = Class.forName(cn, false, loader);
        //通過newInstance實例化
        S p = service.cast(c.newInstance());
        //放入集合，返回實例
        providers.put(cn, p);
        return p; 
    }
}

看到這兒，我想已經很清楚了。獲取到類的實例，我們自然就可以對它為所欲為了！

三、JDBC中的應用

我們開頭說，SPI機制為很多框架的擴展提供了可能，其實JDBC就應用到了這一機制。回憶一下JDBC獲取數據庫連接的過程。在早期版本中，需要先設置數據庫驅動的連接，再通過DriverManager.getConnection獲取一個Connection。

String url = "jdbc:mysql:///consult?serverTimezone=UTC";
String user = "root";
String password = "root";

Class.forName("com.mysql.jdbc.Driver");
Connection connection = DriverManager.getConnection(url, user, password);

在較新版本中(具體哪個版本，筆者沒有驗證)，設置數據庫驅動連接，這一步驟就不再需要，那么它是怎么分辨是哪種數據庫的呢？答案就在SPI。

1、加載

我們把目光回到DriverManager類，它在靜態代碼塊里面做了一件比較重要的事。很明顯，它已經通過SPI機制， 把數據庫驅動連接初始化了。

public class DriverManager {
    static {
        loadInitialDrivers();
        println("JDBC DriverManager initialized");
    }
}

具體過程還得看loadInitialDrivers，它在里面查找的是Driver接口的服務類，所以它的文件路徑就是：META-INF/services/java.sql.Driver。

public class DriverManager {
    private static void loadInitialDrivers() {
        AccessController.doPrivileged(new PrivilegedAction<Void>() {
            public Void run() {
                //很明顯，它要加載Driver接口的服務類，Driver接口的包為:java.sql.Driver
                //所以它要找的就是META-INF/services/java.sql.Driver文件
                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;
            }
        });
    }
}

那么，這個文件哪里有呢？我們來看MySQL的jar包，就是這個文件，文件內容為：com.mysql.cj.jdbc.Driver。

 

MySQL SPI文件

 

2、創建實例

上一步已經找到了MySQL中的com.mysql.cj.jdbc.Driver全限定類名，當調用next方法時，就會創建這個類的實例。它就完成了一件事，向DriverManager注冊自身的實例。

public class Driver extends NonRegisteringDriver implements java.sql.Driver {
    static {
        try {
            //注冊
            //調用DriverManager類的注冊方法
            //往registeredDrivers集合中加入實例
            java.sql.DriverManager.registerDriver(new Driver());
        } catch (SQLException E) {
            throw new RuntimeException("Can't register driver!");
        }
    }
    public Driver() throws SQLException {
        // Required for Class.forName().newInstance()
    }
}

3、創建Connection

在DriverManager.getConnection()方法就是創建連接的地方，它通過循環已注冊的數據庫驅動程序，調用其connect方法，獲取連接並返回。

private static Connection getConnection(
        String url, java.util.Properties info, Class<?> caller) throws SQLException {   
    //registeredDrivers中就包含com.mysql.cj.jdbc.Driver實例
    for(DriverInfo aDriver : registeredDrivers) {
        if(isDriverAllowed(aDriver.driver, callerCL)) {
            try {
                //調用connect方法創建連接
                Connection con = aDriver.driver.connect(url, info);
                if (con != null) {
                    return (con);
                }
            }catch (SQLException ex) {
                if (reason == null) {
                    reason = ex;
                }
            }
        } else {
            println("    skipping: " + aDriver.getClass().getName());
        }
    }
}

4、再擴展

既然我們知道JDBC是這樣創建數據庫連接的，我們能不能再擴展一下呢？如果我們自己也創建一個java.sql.Driver文件，自定義實現類MyDriver，那么，在獲取連接的前后就可以動態修改一些信息。

還是先在項目ClassPath下創建文件，文件內容為自定義驅動類com.viewscenes.netsupervisor.spi.MyDriver

 

自定義數據庫驅動程序

我們的MyDriver實現類，繼承自MySQL中的NonRegisteringDriver，還要實現java.sql.Driver接口。這樣，在調用connect方法的時候，就會調用到此類，但實際創建的過程還靠MySQL完成。

package com.viewscenes.netsupervisor.spi

public class MyDriver extends NonRegisteringDriver implements Driver{
    static {
        try {
            java.sql.DriverManager.registerDriver(new MyDriver());
        } catch (SQLException E) {
            throw new RuntimeException("Can't register driver!");
        }
    }
    public MyDriver()throws SQLException {}
    
    public Connection connect(String url, Properties info) throws SQLException {
        System.out.println("准備創建數據庫連接.url:"+url);
        System.out.println("JDBC配置信息："+info);
        info.setProperty("user", "root");
        Connection connection =  super.connect(url, info);
        System.out.println("數據庫連接創建完成!"+connection.toString());
        return connection;
    }
}
--------------------輸出結果---------------------
准備創建數據庫連接.url:jdbc:mysql:///consult?serverTimezone=UTC
JDBC配置信息：{user=root, password=root}
數據庫連接創建完成!com.mysql.cj.jdbc.ConnectionImpl@7cf10a6f

 

轉載：https://www.jianshu.com/p/3a3edbcd8f24