欧美bbbwbbbw肥妇,免费乱码人妻系列日韩,一级黄片

Java插件擴(kuò)展機(jī)制之SPI案例講解

 更新時(shí)間:2021年07月27日 10:48:18   作者:Lidisam  
這篇文章主要介紹了Java插件擴(kuò)展機(jī)制之SPI案例講解,本篇文章通過(guò)簡(jiǎn)要的案例,講解了該項(xiàng)技術(shù)的了解與使用,以下就是詳細(xì)內(nèi)容,需要的朋友可以參考下

什么是SPI

SPI ,全稱為 Service Provider Interface,是一種服務(wù)發(fā)現(xiàn)機(jī)制。其為框架提供了一個(gè)對(duì)外可擴(kuò)展的能力。

與 接口類-實(shí)現(xiàn)類 提供的RPC 方式有什么區(qū)別?

  • 傳統(tǒng)的接口類實(shí)現(xiàn)形式為如下
public interface AdOpFromApolloService {}
public class AdOpFromDbServiceImpl implements AdOpFromDbService {}

假設(shè)我們需要實(shí)現(xiàn)RPC,是怎么做的?

RPC會(huì)在對(duì)應(yīng)的接口類AdOpFromApolloService新增一個(gè)注解用于標(biāo)注是RPC類,然后將當(dāng)前類放在依賴包提供給其他項(xiàng)目來(lái)通過(guò)接口類進(jìn)行調(diào)用

簡(jiǎn)而言之:RPC調(diào)用中只提供接口類,然后讓第三方調(diào)用(第三方只調(diào),不寫(xiě)實(shí)現(xiàn))

那RPC究竟跟SPI什么關(guān)系?

  • SPI:提供接口,第三方引用包之后可重寫(xiě)或用默認(rèn)的SPI接口的實(shí)現(xiàn)。
  • RPC:提供接口,但是實(shí)現(xiàn)是私有的,不對(duì)外開(kāi)放重寫(xiě)能力。

SPI的應(yīng)用場(chǎng)景

框架實(shí)現(xiàn)案例:

  1. Spring擴(kuò)展插件實(shí)現(xiàn)。如JDCB
  2. 中間件擴(kuò)展插件實(shí)現(xiàn)。如Dubbo、Apollo
  3. 開(kāi)發(fā)過(guò)程中舉例:實(shí)現(xiàn)一個(gè)攔截器,并用SPI機(jī)制來(lái)擴(kuò)展其攔截方式(比如全量攔截、每分鐘攔截多少、攔截比例多少、攔截的日志是log打印還是落庫(kù)、落es)

怎么實(shí)現(xiàn)一個(gè)SPI?

接下來(lái)用兩個(gè)項(xiàng)目模塊來(lái)講解SPI的用法,先看項(xiàng)目結(jié)構(gòu)圖如下

在這里插入圖片描述

接下來(lái)是實(shí)現(xiàn)的過(guò)程

第一步:創(chuàng)建spi-demo-contract項(xiàng)目,在resources目錄下新建如下目錄(MATE-INF/services)和文件(com.example.spidemocontract.spi.SpiTestDemoService)

  • 修改com.example.spidemocontract.spi.SpiTestDemoService文件
  • 新增第二步一樣位置的接口類,以及對(duì)應(yīng)的實(shí)現(xiàn)類


第二步:創(chuàng)建spi-demo項(xiàng)目,然后引入spi-demo-contract依賴

  • 在resources目錄下新建如下目錄(MATE-INF/services)和文件(com.example.spidemocontract.spi.SpiTestDemoService),文件名跟spi-demo-contract的完全一致
  • 修改com.example.spidemocontract.spi.SpiTestDemoService(與依賴包的文件名稱完全一致,但內(nèi)容指向了當(dāng)前項(xiàng)目自定義的實(shí)現(xiàn)類)文件
  • 實(shí)現(xiàn)SPI接口,自定義spi-demo項(xiàng)目的實(shí)現(xiàn)類(這里可以把優(yōu)先級(jí)調(diào)到最高)


第三步:在spi-demo項(xiàng)目中用ServiceLoader進(jìn)行加載SPI接口

補(bǔ)充說(shuō)明:我們可以重寫(xiě)聲明類的優(yōu)先級(jí),來(lái)判斷需要用哪個(gè)實(shí)現(xiàn)類來(lái)處理。比如重寫(xiě)一個(gè)優(yōu)先級(jí)=0最高優(yōu)先級(jí),然后加載的時(shí)候默認(rèn)只取第一個(gè)優(yōu)先級(jí)最高的,那我們重寫(xiě)的自定義實(shí)現(xiàn)類就能覆蓋掉默認(rèn)SPI實(shí)現(xiàn)類

詳細(xì)步驟拆分如下

  • 第一步:創(chuàng)建spi-demo-contract項(xiàng)目,在resources目錄下新建如下目錄(MATE-INF/services)和文件(com.example.spidemocontract.spi.SpiTestDemoService)
-- resources
---- META-INF
-------- services
------------ com.example.spidemocontract.spi.SpiTestDemoService
  • 修改com.example.spidemocontract.spi.SpiTestDemoService文件如下
com.example.spidemocontract.spi.impl.DefaultSpiTestDemoService
  • 新增第二步一樣位置的接口類,以及對(duì)應(yīng)的實(shí)現(xiàn)類
/**
* 這個(gè)接口類完全對(duì)應(yīng)resources/META-INF/services/com.example.spidemocontract.spi.impl.DefaultSpiTestDemoService
**/
public interface SpiTestDemoService {
    void printLog();
    int getOrder();
}

/**
 * 將默認(rèn)的設(shè)置為優(yōu)先級(jí)最低,這是默認(rèn)的SPI接口的實(shí)現(xiàn)類
 */
public class DefaultSpiTestDemoService implements SpiTestDemoService {
    @Override
    public int getOrder() {
        return Integer.MAX_VALUE;
    }
    @Override
    public void printLog() {
        System.out.println("輸出 DefaultSpiTestDemoService log");
    }
}
  • 第二步:創(chuàng)建spi-demo項(xiàng)目,然后引入spi-demo-contract依賴
<dependency>
    <groupId>com.example</groupId>
    <artifactId>spi-demo-contract</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <scope>compile</scope>
</dependency>
  • 在resources目錄下新建如下目錄(MATE-INF/services)和文件(com.example.spidemocontract.spi.SpiTestDemoService),文件名跟spi-demo-contract的完全一致
-- resources
---- META-INF
-------- services
------------ com.example.spidemocontract.spi.SpiTestDemoService
  • 修改com.example.spidemocontract.spi.SpiTestDemoService(與依賴包的文件名稱完全一致,但內(nèi)容指向了當(dāng)前項(xiàng)目自定義的實(shí)現(xiàn)類)文件如下
com.example.spidemo.spi.OtherSpiTestDemoService
  • 實(shí)現(xiàn)SPI接口,自定義spi-demo項(xiàng)目的實(shí)現(xiàn)類
/**
 * 其他,把他優(yōu)先級(jí)設(shè)置的比較高
 */
public class OtherSpiTestDemoService implements SpiTestDemoService {
    // 后面我們用SPI類加載器獲取時(shí),會(huì)根據(jù)order排序,越小優(yōu)先級(jí)越高
    @Override
    public int getOrder() {
        return 0;
    }
    @Override
    public void printLog() {
        System.out.println("輸出 OtherSpiTestDemoService log");
    }
}
  • 第三步:在spi-demo項(xiàng)目中用ServiceLoader進(jìn)行加載SPI接口
public static void main(String[] args) {
    // 加載SPI
    Iterator<SpiTestDemoService> iterator = ServiceLoader.load(SpiTestDemoService.class).iterator();
    // 實(shí)現(xiàn)了ordered,會(huì)根據(jù)ordered返回值排序,優(yōu)先級(jí)越高,越先取出來(lái)
    List<SpiTestDemoService> list = Lists.newArrayList(iterator)
            .stream().sorted(Comparator.comparing(SpiTestDemoService::getOrder))
            .collect(Collectors.toList());
    for (SpiTestDemoService item : list) {
        item.printLog();
    }
}

中間件是怎么實(shí)現(xiàn)SPI的?

Apollo-Client中的實(shí)現(xiàn)

  • Apollo-Client初始化過(guò)程中,有一個(gè)SPI接口ConfigPropertySourcesProcessorHelper
// 當(dāng)前接口會(huì)在resource/META-INF/services目錄下對(duì)應(yīng)文件com.ctrip.framework.apollo.spring.spi.ConfigPropertySourcesProcessorHelper
public interface ConfigPropertySourcesProcessorHelper extends Ordered {
  void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException;
}
  • 當(dāng)前SPI中的默認(rèn)實(shí)現(xiàn)為
public class DefaultConfigPropertySourcesProcessorHelper implements ConfigPropertySourcesProcessorHelper {
    @Override
    public void postProcessBeanDefinitionRegistry(BeanDefinitionRegistry registry) throws BeansException {
        // .....各種注冊(cè)bean,初始化的流程
    }
    @Override
    public int getOrder() {
        // 優(yōu)先級(jí)排序置為最低。方便其他自定義spi實(shí)現(xiàn)類能夠覆蓋
        return Ordered.LOWEST_PRECEDENCE;
    }
}
  • 怎么選擇加載出自定義的SPI實(shí)現(xiàn)類

通過(guò)ServiceLoader.load(Xxxx.class)加載出所有實(shí)例,然后根據(jù)order來(lái)進(jìn)行排序優(yōu)先級(jí),order最小的那個(gè)優(yōu)先級(jí)最高,只取第一個(gè)數(shù)據(jù)candidates.get(0)并返回。
因?yàn)樽远xSPI實(shí)現(xiàn)優(yōu)先級(jí)可以設(shè)置得很高,所以就可以達(dá)到覆蓋默認(rèn)實(shí)現(xiàn)的目的

public static <S extends Ordered> S loadPrimary(Class<S> clazz) {
    List<S> candidates = loadAllOrdered(clazz);
    return candidates.get(0);
}
public static <S extends Ordered> List<S> loadAllOrdered(Class<S> clazz) {
    Iterator<S> iterator = loadAll(clazz);

    if (!iterator.hasNext()) {
      throw new IllegalStateException(String.format(
          "No implementation defined in /META-INF/services/%s, please check whether the file exists and has the right implementation class!",
          clazz.getName()));
    }
    // 獲取迭代中的所有SPI實(shí)現(xiàn)實(shí)例,然后進(jìn)行排序,取優(yōu)先級(jí)最高的那個(gè)
    List<S> candidates = Lists.newArrayList(iterator);
    Collections.sort(candidates, new Comparator<S>() {
      @Override
      public int compare(S o1, S o2) {
        // the smaller order has higher priority
        return Integer.compare(o1.getOrder(), o2.getOrder());
      }
    });

    return candidates;
}

JDBC中的實(shí)現(xiàn)

  • JDBC SPI中配置文件resources/META-INF/services/java.sql.Driver,并設(shè)置參數(shù)如下
com.example.app.driver.MyDriver
  • 繼承SPI接口java.sql.Driver,實(shí)現(xiàn)MyDriver
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!", e);
        }
    }
    public MyDriver() throws SQLException {}
    @Override
    public Connection connect(String url, Properties info) throws SQLException {
        System.out.println("MyDriver - 準(zhǔn)備創(chuàng)建數(shù)據(jù)庫(kù)連接.url:" + url);
        System.out.println("JDBC配置信息:" + info);
        info.setProperty("user", "root");
        Connection connection = super.connect(url, info);
        System.out.println("MyDriver - 數(shù)據(jù)庫(kù)連接創(chuàng)建完成!" + connection.toString());
        return connection;
    }
}
  • 寫(xiě)main方法調(diào)用執(zhí)行剛實(shí)現(xiàn)的自定義SPI實(shí)現(xiàn)
String url = "jdbc:mysql://localhost:3306/test?serverTimezone=UTC";
String user = "root";
String password = "root";
Class.forName("com.example.app.driver.MyDriver");
Connection connection = DriverManager.getConnection(url, user, password);
  • JDBC如何使用SPI簡(jiǎn)單分析如下

獲取所有注冊(cè)的驅(qū)動(dòng)(每個(gè)驅(qū)動(dòng)的都遍歷一下,其實(shí)就是最晚注冊(cè)那個(gè)就用那個(gè)了,如果失敗就往下一個(gè)找)

// 獲取所有注冊(cè)的驅(qū)動(dòng)(每個(gè)驅(qū)動(dòng)的都遍歷一下,其實(shí)就是最晚注冊(cè)那個(gè)就用那個(gè)了,如果失敗就往下一個(gè)找)
 for(DriverInfo aDriver : registeredDrivers) {
    // If the caller does not have permission to load the driver then
    // skip it.
    if(isDriverAllowed(aDriver.driver, callerCL)) {
        try {
            println("    trying " + aDriver.driver.getClass().getName());
            Connection con = aDriver.driver.connect(url, info);
            if (con != null) {
                // Success!
                println("getConnection returning " + aDriver.driver.getClass().getName());
                return (con);
            }
        } catch (SQLException ex) {
            if (reason == null) {
                reason = ex;
            }
        }

    } else {
        println("    skipping: " + aDriver.getClass().getName());
    }
}

到此這篇關(guān)于Java插件擴(kuò)展機(jī)制之SPI案例講解的文章就介紹到這了,更多相關(guān)Java插件擴(kuò)展機(jī)制之SPI內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!

相關(guān)文章

最新評(píng)論