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？

1、首先分析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/裡的配置檔案找到具體的實現類名，並裝載例項化，完成模組的注入。

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

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

3、獲取資料庫連線

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簡單使用

1、目錄結構

2、示例程式碼

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";
    }

}

複製程式碼

3、com.codersm.study.jdk.spi.HelloService檔案內容

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

複製程式碼

4、測試

@Test
public void testSpi() {

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

複製程式碼

歡迎留言補充，共同交流。個人微信公眾號求關注：