腳本之家服務器常用軟件

快捷導航

Java和Dubbo的SPI機制原理解析

更新時間：2021年03月22日 09:23:49 作者：luzaichun

這篇文章主要介紹了Java和Dubbo的SPI機制原理解析,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下

SPI: 簡單理解就是，你一個接口有多種實現，然后在代碼運行時候，具體選用那個實現，這時候我們就可以通過一些特定的方式來告訴程序尋用那個實現類，這就是SPI。

JAVA的SPI

全稱為 Service Provider Interface，是一種服務發(fā)現機制。它是約定在 Classpath 下的 META-INF/services/ 目錄里創(chuàng)建一個以服務接口命名的文件，然后文件里面記錄的是此 jar 包提供的具體實現類的全限定名。

這樣當我們引用了某個 jar 包的時候就可以去找這個 jar 包的 META-INF/services/ 目錄，再根據接口名找到文件，然后讀取文件里面的內容去進行實現類的加載與實例化。

例如：

java的jdbc就使用了SPI機制,當我項目種應用了mysql的連接jar時候，就會去去mysql-connector-java.jar下的META-INF/services/ 目錄查找java.sql.Driver名的文件，然后加載里面全類名的類。如果使用oracle連接驅動時候，就會去ojdbc.jar下面去找java.sql.Driver文件里的配置的全類名。

在這里插入圖片描述

并且通過IDEA的智能提示功能，也能看到，在你切換不同連接的jar包時候，Driver接口實現類是不同的。

使用mysql的連接驅動：

在這里插入圖片描述

切換到oracle的連接驅動：

在這里插入圖片描述

Java的SPI機制源碼分析

下面這段代碼，以jdbc的SPI為例，可以作為debug的入口：

package com.example.demo;

import java.sql.Connection;
import java.sql.DriverManager;
/**
 * @author:luzaichun
 * @Date:2021/3/14
 * @Time:14:09
 **/
public class JDBCMain {
  private static final String URL = "jdbc:mysql://localhost:3306/test?useSSL=true&useUnicode=true&characterEncoding=UTF-8";

  public static void main(String[] args) throws Exception{
    Connection conn = DriverManager.getConnection(URL, "root", "123456");
  }
}

在使用DriverManager.getConnection()方法時候，會加載并初始化DriverManager類，此類是jdbc使用SPI的核心類。

1.DriverManager類初始化，調用static代碼塊，執(zhí)行DriverManager#loadInitialDrivers（）方法

在這里插入圖片描述

2.使用javaSPI的核心類ServiceLoader#load()和以及其內部實現了Iterator的LazyIterator#hasNext()和
LazyIterator#next(),加載接口的具體實現類。

在這里插入圖片描述

ServiceLoader.load()整個代碼流程，如下圖。其實就是給LazyIterator類的賦值屬性，是那個接口要進行SPI,使用的類加載器是哪一個。

在這里插入圖片描述

driversIterator.hasNext()和driversIterator.next()方法負責類實際類的加載

driversIterator.hasNext()最后實際是調到了LazyIterator.hasNext();
driversIterator.next()最后實際是調到了LazyIterator.next();

hashNext(）方法讀到SPI的配置文件里的全類名

在這里插入圖片描述

next()方法最后通過反射創(chuàng)建出具體實現類的實例

在這里插入圖片描述

總結：

jdbc的SPI，通過DriverManager類靜態(tài)代碼塊執(zhí)行l(wèi)oadInitialDrivers()方法
然后通過ServiceLoader.load()拿到具體的接口，以及類加載器。
通過實現了Iterator類的LazyIterator類的hasNext方法讀取配置文件，拿到接口的具體實現全類名
在next()方法內部，通過反射機制，由實現類的全類名，加載具體實現類。

代碼實戰(zhàn)java SPI

DemoService接口

public interface DemoService {
  String sayHello(String msg);
}

XiaoHongDemoServiceImpl實現類

public class XiaoHongDemoServiceImpl implements DemoService {
  @Override
  public String sayHello(String msg) {
    return "xiaohong:"+msg;
  }
}

ZhangSanDemoServiceImpl實現類

public class ZhangSanDemoServiceImpl implements DemoService {
  @Override
  public String sayHello(String msg) {
    return "zhangsan:"+msg;
  }
}

定義SPI配置文件

在這里插入圖片描述

最后使用

public class DemoMain {
  public static void main(String[] args) {
    ServiceLoader<DemoService> serviceLoad = ServiceLoader.load(DemoService.class);
    Iterator<DemoService> iterator = serviceLoad.iterator();
    while (iterator.hasNext()){
      DemoService demoService = iterator.next();
      String returnStr = demoService.sayHello("lzc賊帥?。。。?);
      System.out.println(returnStr);
    }
  }
}

執(zhí)行結果：

在這里插入圖片描述

java SPI劣勢，會加載SPI配置文件里定義的所有配置類，如果用不上該類，也會加載。通俗點講，就是無法按需加載。

Dubbo的SPI

dubbo SPI使用

需要先引入dubbo相關的依賴

1.定義接口
通過dubbo的SPI注解標注定義的接口

@SPI("xiaohong")
public interface DubboSPIService {

  void sayHello();
}

2.多個實現類

public class XiaoHongDubboSPIServiceImpl implements DubboSPIService {
  @Override
  public void sayHello() {
    System.out.println("小紅說：lzc賊帥！");
  }
}

public class XiaoMingDubboSPIServiceImpl implements DubboSPIService {
  @Override
  public void sayHello() {
    System.out.println("小明說：lzc賊帥！");
  }
}

3.定義dubbo SPI配置文件
META-INF/dubbo目錄下定義接口全類名的文件，配置key-value的實現

Dubbo 對配置文件目錄的約定，不同于 Java SPI ，Dubbo 分為了三類目錄。

META-INF/services/ 目錄：該目錄下的 SPI 配置文件是為了用來兼容 Java SPI 。

META-INF/dubbo/ 目錄：該目錄存放用戶自定義的 SPI 配置文件。

META-INF/dubbo/internal/ 目錄：該目錄存放 Dubbo 內部使用的 SPI 配置文件。

在這里插入圖片描述

4.使用

public class DubboSPIMain {
  public static void main(String[] args) {
  //default，會取@SPI注解里定義的key對應的實現
//    DubboSPIService defaultExtensionService = ExtensionLoader.getExtensionLoader(DubboSPIService.class).getDefaultExtension();
//    defaultExtensionService.sayHello();
    DubboSPIService dubboSPIService = ExtensionLoader.getExtensionLoader(DubboSPIService.class).getExtension("xiaoming");
    dubboSPIService.sayHello();
  }
}

結果：

在這里插入圖片描述

源碼分析

ExtensionLoader.getExtensionLoader(DubboSPIService.class).getExtension("xiaoming");
dubbo SPI的核心就是ExtensionLoader類

1.ExtensionLoader#getExtensionLoader()

該方法主要是，從一個map里取key為當前傳進來的接口Class的value（value是ExtensionLoader對象）,如果取不到，我們就往這個map里put一份這樣的key-value。value是new ExtensionLoader(type)傳進去的type是接口的Class對象，最后會賦值給ExtensionLoader對象的type屬性，后面會用到。

在這里插入圖片描述

2.拿到ExtensionLoader對象后，通過ExtensionLoader#getExtension()獲取具體的實現的實例

首先會取緩存里拿，沒拿到就調用createExtension()方法取創(chuàng)建所需要的實例，最后塞入緩存。

在這里插入圖片描述

3.createExtension方法

通過getExtension(“xiaoming”)傳進來的name=xiaoming,從SPI配置文件獲取到所需要實現類的全類名，通過反射拿到實現類的Class對象，最后通過反射拿到相應的實例。核心是getExtensionClasses()方法。

在這里插入圖片描述

4.getExtensionClasses()

getExtensionClasses()方法返回一個Map，key為SPI配置文件中的key,value為SPI配置文件中，實現類的Class對象。

可以看到，代碼中用來大量的緩存機制，鎖的雙檢查。cacheDefaultExtensionName()方法里會拿到SPI注解上配置的默認key,然后賦值給cachedDefaultName屬性，如果使用getDefaultExtension()時候會使用到strategies，其實是通過java得SPI拿到得一個數組

在這里插入圖片描述

5.循環(huán)三個SPI文件得目錄，分別調用loadDirectory方法

fileName最后在三次循環(huán)里，會拼出三個路徑，META-INF/dubbo/com.example.demo.service.DubboSPIService，這一個才是正確得路徑，然后獲得配置文件得絕對路徑。然后會執(zhí)行l(wèi)oadResource()方法讀取SPI配置文件