淺談 Java SPI 機制

開篇

本文主要談一下 Java SPI（Service Provider Interface） ，由於最近在看 Dubbo 的相關內容，其中涉及到了 一個概念- Dubbo SPI， 最後又牽扯出來了 JAVA SPI， 因此先從 Java SPI 開整。

正文

日常學習一個知識點，咱們的常規作法是：

• 是什麼
• 有什麼用
• 怎麼用

此次咱們倒着作，先不談什麼是 SPI 及其做用，來看下如何使用。

使用

1. 建立一個 maven 工程

2. 建立一個接口類以及實現類

// 接口
public interface HelloService {

    void sayHello();

}

// 實現類 1
public class HelloServiceImpl1 implements HelloService {
    @Override
    public void sayHello() {
        System.out.println("hello impl1");
    }
}

// 實現類 2
public class HelloServiceImpl2 implements HelloService {
    @Override
    public void sayHello() {
        System.out.println("hello impl2");
    }
}

3. 建立一個 META-INF/services 文件夾，並添加一個文件

在 classpath 下面建立一個META-INF/services目錄，再在下面建立一個
以接口類全路徑名 命名的文件
即：com.nimo.spidemo.service.HelloService

4. 在第三步建立的文件中寫入以下內容

寫入兩個實現類的全路徑名

com.nimo.spidemo.service.impl.HelloServiceImpl1
com.nimo.spidemo.service.impl.HelloServiceImpl2

5. 啓動函數

public class App {

    public static void main(String[] args) throws ClassNotFoundException, SQLException {
        // 方式 一
        Iterator<HelloService> providers = Service.providers(HelloService.class);
        while(providers.hasNext()) {
            HelloService ser = providers.next();
            ser.sayHello();
        }

        System.out.println("-----------------分割線---------------");
        // 方式 二
        ServiceLoader<HelloService> load = ServiceLoader.load(HelloService.class);
        Iterator<HelloService> iterator = load.iterator();
        while(iterator.hasNext()) {
            HelloService ser = iterator.next();
            ser.sayHello();
        }
    }

}

運行結果以下：

hello impl1
hello impl2
-----------------分割線---------------
hello impl1
hello impl2

使用要素

針對上面的 demo，能夠看出使用 Java SPI 的幾個關鍵要素：

1. 接口類，好比 HelloService
2. 對應接口的實現類
   實現類必須攜帶一個不帶參數的構造方法
3. 文件夾 META-INF/services
   放置 classpath 目錄下
4. 以「接口全限定名」命名的文件
5. 文件內容爲接口實現類的全路徑

主程序經過java.util.ServiceLoder 掃描META-INF/services下的配置文件,而後會找到實現類的全限定名，最後把類加載到JVM；

SPI 的做用

從上面的 demo 中能夠看到，Java SPI 就是把某個接口的 指定實現類 （經過在指定文件配置的方式）給實例化出來了。

準確+官方的說：

SPI 是一種將服務接口與服務實現分離以達到解耦、大大提高了程序可擴展性的機制。引入服務提供者就是引入了 spi 接口的實現者，經過本地的註冊發現獲取到具體的實現類，輕鬆可插拔。

～～～ 若是仍是不懂就接着往下看⬇️

SPI 的應用場景

一個典型的案例就是 jdbc 。

數據庫各大廠商（如Mysql、Oracle）會根據一個統一的接口規範( java.sql.Driver )開發各自的驅動實現邏輯。
客戶端使用 jdbc 時不須要去改變代碼，直接引入不一樣的 spi 接口服務便可。
例如 ：
Mysql 是 com.mysql.jdbc.Drive
Oracle 是 oracle.jdbc.driver.OracleDriver

一段熟悉的代碼：

使用操做 mysql 數據庫的前置工做：

//1.加載驅動程序
Class.forName("com.mysql.jdbc.Driver");
//2. 得到數據庫鏈接
Connection conn = DriverManager.getConnection(URL, USER, PASSWORD);

當咱們須要切到 oracle 數據庫時，更改驅動爲 oracle.jdbc.driver.OracleDriver, 最後修改鏈接信息【用戶名，密碼等】便可。

總結

Java SPI 是一種服務發現機制。它經過在 classPath 路徑下的 META-INF/services 文件夾查找文件，自動加載文件裏所定義的類。

它的核心關鍵做用就是 擴展。

其餘應用場景：

• 日誌門面接口實現類加載

  SLF4J加載不一樣提供商的日誌實現類

• Spring

  Spring中大量使用了 SPI,好比：對 servlet3.0 規範 ServletContainerInitializer 的實現、自動類型轉換Type Conversion SPI(Converter SPI、Formatter SPI)等

• Dubbo

  Dubbo中也大量使用SPI的方式實現框架的擴展, 不過它對Java提供的原生SPI作了封裝，容許用戶擴展實現Filter接口

其中 Dubbo 中的 SPI 是接下來研究的重點。