一、前言

SPI的英文全稱為Service Provider Interface，字面意思為服務(wù)提供者接口，它是jdk提供給“服務(wù)提供廠商”或者“插件開(kāi)發(fā)者”使用的接口。

在面向?qū)ο蟮脑O(shè)計(jì)中，模塊之間我們一般會(huì)采取面向接口編程的方式，而在實(shí)際編程過(guò)程過(guò)程中，API的實(shí)現(xiàn)是封裝在jar中，當(dāng)我們想要換一種實(shí)現(xiàn)方法時(shí)，還要生成新的jar替換以前的實(shí)現(xiàn)類。而通過(guò)jdk的SPI機(jī)制就可以實(shí)現(xiàn)，首先不需要修改原來(lái)作為接口的jar的情況下，將原來(lái)實(shí)現(xiàn)的那個(gè)jar替換為另外一種實(shí)現(xiàn)的jar即可。

總結(jié)一下SPI的思想：在系統(tǒng)的各個(gè)模塊中，往往有不同的實(shí)現(xiàn)方案，例如日志模塊的方案、xml解析的方案等，為了在裝載模塊的時(shí)候不具體指明實(shí)現(xiàn)類，我們需要一種服務(wù)發(fā)現(xiàn)機(jī)制，java spi就提供這樣一種機(jī)制。有點(diǎn)類似于IoC的思想，將服務(wù)裝配的控制權(quán)移到程序之外，在模塊化設(shè)計(jì)時(shí)尤其重要。

順便提一下，Java SPI機(jī)制在很多大型中間件嗎，例如Dubbo中均有采用，屬于高級(jí)Java開(kāi)發(fā)的進(jìn)階必備知識(shí)點(diǎn)，務(wù)必要求掌握。

二、SPI規(guī)范

定義服務(wù)的通用接口，針對(duì)通用的服務(wù)接口，提供具體的實(shí)現(xiàn)類。

1.在jar包（服務(wù)提供者）的META-INF/services/目錄中，新建一個(gè)文件，文件名為SPI接口的"全限定名"。 文件內(nèi)容為該接口的具體實(shí)現(xiàn)類的"全限定名"

2.將spi所在jar放在主程序的classpath中

3.服務(wù)調(diào)用方使用java.util.ServiceLoader去動(dòng)態(tài)加載具體的實(shí)現(xiàn)類到JVM中

三、SPI應(yīng)用案例

3.1 數(shù)據(jù)庫(kù)驅(qū)動(dòng)

java.sql.Driver的spi實(shí)現(xiàn)，有mysql驅(qū)動(dòng)、oracle驅(qū)動(dòng)等。以mysql為例，實(shí)現(xiàn)類是com.mysql.jdbc.Driver，在mysql-connector-java-5.1.6.jar中，我們可以看到有一個(gè)META-INF/services目錄，目錄下有一個(gè)文件名為java.sql.Driver的文件，其中的內(nèi)容是com.mysql.jdbc.Driver。

在我們使用JDBC獲取連接時(shí)，我們通常會(huì)調(diào)用DriverManager.getConnection()方法獲取連接對(duì)象，而在Driver類初始化時(shí)會(huì)使用ServiceLoader動(dòng)態(tài)獲取classpath下“注冊(cè)”的驅(qū)動(dòng)實(shí)現(xiàn)：

static {
        loadInitialDrivers();
        println("JDBC DriverManager initialized");
}

private static void loadInitialDrivers() {
        .....
        AccessController.doPrivileged(new PrivilegedAction<Void>() {
            public Void run() {
				//使用ServiceLoader動(dòng)態(tài)加載具體的驅(qū)動(dòng)實(shí)現(xiàn)類
                ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(Driver.class);
                Iterator<Driver> driversIterator = loadedDrivers.iterator();
                try{
                    while(driversIterator.hasNext()) {
                        driversIterator.next();
                    }
                } catch(Throwable t) {
                // Do nothing
                }
                return null;
            }
        });
		.....
    }

3.2 Slf4j

slf4j是一個(gè)典型的門面接口，早起我們使用log4j作為日記記錄框架，我們需要同時(shí)引入slf4j和log4j的依賴。后面比較流行l(wèi)ogback，我們也想要把項(xiàng)目切換到logback上來(lái)，此時(shí)利用SPI的機(jī)制，我們只需要把log4j的jar包替換為logback的jar包就可以了。

在log4j-to-slf4j.jar中我們可以看到前面提到的服務(wù)提供方的SPI接口聲明：

這樣我們只需要將log4j-to-slf4j.jar引入classpath，slf4j就能夠獲取到org.apache.logging.slf4j.SLF4JProvider作為實(shí)現(xiàn)類。

四、SPI示例

模塊依賴關(guān)系：

4.1 spi-operate-service模塊

在spi-operate-service中定義INumOperate接口：

package cn.bigcoder.spi.operate.service;

/**
 * @author: Jindong.Tian
 * @date: 2020-11-29
 * @description:
 **/
public interface INumOperate {

    int exec(int num1, int num2);
}

4.2 spi-operate-add模塊

在spi-operate-add中定義加法實(shí)現(xiàn)：

package cn.bigcoder.spi.operate.add;


import cn.bigcoder.spi.operate.service.INumOperate;

/**
 * @author: Jindong.Tian
 * @date: 2020-11-29
 * @description:
 **/
public class NumAddOperateImpl implements INumOperate {

    public int exec(int num1, int num2) {
        return num1 + num2;
    }
}

在resource/METAINF/resoures目錄下創(chuàng)建cn.bigcoder.spi.operate.service.INumOperate文件：

cn.bigcoder.spi.operate.add.NumAddOperateImpl

4.3 spi-operate-multiplication模塊

在spi-operate-multiplication模塊中定義乘法的實(shí)現(xiàn)：

package cn.bigcoder.spi.operate.multiplication;

import cn.bigcoder.spi.operate.service.INumOperate;

/**
 * @author: Jindong.Tian
 * @date: 2020-11-29
 * @description:
 **/
public class NumMultiOperateImpl implements INumOperate {
    
    public int exec(int num1, int num2) {
        return num1 * num2;
    }
}

同樣的在resource/METAINF/resoures目錄下創(chuàng)建cn.bigcoder.spi.operate.service.INumOperate文件：

cn.bigcoder.spi.operate.multiplication.NumMultiOperateImpl

4.4 spi-operate-consumer模塊

在spi-operate-consumer模塊中，我們編寫測(cè)試類獲取classpath中INumOperate實(shí)現(xiàn)類：

package cn.bigcoder.spi.operate;

import cn.bigcoder.spi.operate.service.INumOperate;
import org.junit.Test;

import java.util.Iterator;
import java.util.ServiceLoader;

/**
 * @author: Jindong.Tian
 * @date: 2020-11-29
 * @description:
 **/
public class INumOperateTest {
    @Test
    public void test() {
        // SPI機(jī)制，尋找所有的實(shí)現(xiàn)類，順序執(zhí)行
        ServiceLoader<INumOperate> loader = ServiceLoader.load(INumOperate.class);
        Iterator<INumOperate> iterator = loader.iterator();
        if (iterator.hasNext()) {
            INumOperate numOperate = iterator.next();
            System.out.println(numOperate.exec(1, 2));
        } else {
            throw new RuntimeException("classpath中未找到cn.bigcoder.spi.operate.INumOperate實(shí)現(xiàn)類");
        }
    }
}

此時(shí)如果我們?cè)?code>spi-operate-consumer中引入spi-operate-add，則測(cè)試方法執(zhí)行求和操作；如果引入spi-operate-multiplication，則測(cè)試方法執(zhí)行乘法操作。

到此這篇關(guān)于Java進(jìn)階之Java SPI詳解的文章就介紹到這了,更多相關(guān)Java SPI內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

最新評(píng)論