Java進階—JDK SPI源碼詳解

認識JDK SPI

SPI是Service Provider Interface的縮寫，能夠使用它擴展框架和更換的組件。JDK提供了java.util.ServiceLoader工具類，在使用某個服務接口時，它能夠幫助咱們查找該服務接口的實現類，加載和初始化，前提條件是基於它的約定。

大多數開發人員可能不熟悉，卻常用它。舉個例子，獲取MySQL數據庫鏈接，代碼以下：

public class MySQLConnect {

    private final static String url ="jdbc:mysql://localhost:3306/test";

    private final static String username = "root";

    private final static String password = "root";

    public static Connection getConnection() throws SQLException {
       // Class.forName("com.mysql.jdbc.Driver");
       return DriverManager.getConnection(url,username,password);
    }

    public static void main(String[] args) throws SQLException {
        System.out.println(getConnection());
    }
}
複製代碼

上述代碼是能夠運行成功的。接下來咱們就分析下DriverManager.getConnection(url,username,password)的過程，探究其如何獲取到數據庫鏈接Connection？

一、首先分析loadInitialDrivers方法，其源碼以下：

private static void loadInitialDrivers() {
        
    /** * 獲取ServiceLoader實例，loadedDrivers = * new ServiceLoader(Driver.class,Thread.currentThread().getContextClassLoader()) */
    ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
    /** * 獲取serviceLoader實例的迭代器,driversIterator = new LazyIterator(service, loader) */
    Iterator<Driver> driversIterator = loadedDrivers.iterator();

    /** * 應用程序加載器（Thread.currentThread().getContextClassLoader()） * 加載classpath下META-INF/services/java.sql.Driver文件， * 解析java.sql.Driver文件的內容將其存儲在LazyIterator.pending實例變量中。 */
    while(driversIterator.hasNext()) {
        /** * 經過反射實例化java.sql.Driver文件中的類（com.mysql.jdbc.Driver， com.mysql.fabric.jdbc.FabricMySQLDriver） */
        driversIterator.next();
    }
}
複製代碼

約定：當服務的提供者，提供了服務接口（java.sql.Driver）的一種實現以後，在jar包的META-INF/services/目錄裏同時建立一個以服務接口命名的文件。該文件裏就是實現該服務接口的具體實現類。而當外部程序裝配這個模塊的時候，就能經過該jar包META-INF/services/裏的配置文件找到具體的實現類名，並裝載實例化，完成模塊的注入。

二、com.mysql.jdbc.Driver類的初始化 

static {
    try {
        // registeredDrivers存儲Dirver實例
        java.sql.DriverManager.registerDriver(new Driver());
    } catch (SQLException E) {
        throw new RuntimeException("Can't register driver!");
    }
}
複製代碼

三、獲取數據庫鏈接

for(DriverInfo aDriver : registeredDrivers) {

    if(isDriverAllowed(aDriver.driver, callerCL)) {
        try {
            // 獲取Connection
            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());
    }

}
複製代碼

JDK SPI簡單使用

一、目錄結構

二、示例代碼

public interface HelloService {

    String sayHello();

}

public class CHelloService implements HelloService {

    @Override
    public String sayHello() {
        return "Welcome to C world";
    }

}

public class JavaHelloService implements HelloService {

    @Override
    public String sayHello() {
        return "Welcome to Java world";
    }

}

複製代碼

三、com.codersm.study.jdk.spi.HelloService文件內容

com.codersm.study.jdk.spi.impl.CHelloService
com.codersm.study.jdk.spi.impl.JavaHelloService

複製代碼

四、測試

@Test
public void testSpi() {

    ServiceLoader<HelloService> loaders = ServiceLoader.load(HelloService.class);
    for (HelloService loader : loaders) {
        System.out.println(loader.sayHello());
    }
}

複製代碼

歡迎留言補充，共同交流。我的微信公衆號求關注：