一文帶你掌握J(rèn)ava?SPI的原理和實(shí)踐

更新時間：2023年05月30日 09:54:35 作者：守望時空33

在Java中，我們經(jīng)常會提到面向接口編程，這樣減少了模塊之間的耦合，更加靈活，Java?SPI?(Service?Provider?Interface)就提供了這樣的機(jī)制，本文就來講講它的原理與具體使用吧

1、SPI和API

在說起SPI之前，我們還是先看一下API，API我們已經(jīng)很熟悉了，和SPI都可以被稱作接口。

只不過API的功能的實(shí)現(xiàn)，以及接口的定義全部是接口的實(shí)現(xiàn)者提供的，調(diào)用者只需要調(diào)用接口即可：

不過SPI就不一樣了，在SPI機(jī)制中，調(diào)用者仍然是調(diào)用接口，但是這個接口是獨(dú)立存在的，并且可以由不同的實(shí)現(xiàn)者實(shí)現(xiàn)：

也就是說，這里接口只是一個標(biāo)準(zhǔn)，并且提供接口的那一方并不一定回去實(shí)現(xiàn)接口，而是根據(jù)接口的定義，由更多的第三方實(shí)現(xiàn)。

這個接口可以由一個甚至是多個實(shí)現(xiàn)者去實(shí)現(xiàn)。也因此，調(diào)用者在調(diào)用接口時，可能還需要指定一下使用哪個實(shí)現(xiàn)者的實(shí)現(xiàn)類。

實(shí)現(xiàn)者也叫做服務(wù)提供者。

事實(shí)上，我們?nèi)粘Ｉ钪薪?jīng)常使用的U盤也很類似SPI機(jī)制，U盤使用的是USB接口，USB接口僅僅是一個規(guī)范（接口），但是發(fā)明USB接口的公司并沒有去生產(chǎn)U盤，而是由不同的U盤廠商例如金士頓、閃迪（實(shí)現(xiàn)者）等等去根據(jù)這個規(guī)范生產(chǎn)U盤，然后我們就可以去選擇自己喜歡的牌子（選擇實(shí)現(xiàn)者）購買U盤，不過平時無論使用什么牌子的U盤，我們只需要插入到電腦的USB接口（調(diào)用接口）即可使用，而不用關(guān)心不同的廠商是怎么實(shí)現(xiàn)USB接口的功能的。

可見，SPI機(jī)制將實(shí)現(xiàn)者和接口再次解耦合了，使得接口更加易于擴(kuò)展。

事實(shí)上，我們常常用的SLF4J就是一個Java的日志接口，但是它也僅僅是一個接口，所以被稱作門面。而它的實(shí)現(xiàn)有Logback、Log4j等等，并且在切換實(shí)現(xiàn)的時候，我們只需要修改一下依賴配置即可，代碼并不需要任何變動，因為代碼中也僅僅是調(diào)用了接口。

2、自己完成一個SPI

那么現(xiàn)在，我們也來以一個最簡單的日志接口為例，實(shí)現(xiàn)自己的SPI。

(1) 定義SPI接口

先新建一個空的Maven項目log-interface，然后在里面創(chuàng)建一個日志接口，聲明日志接口具備的方法（功能）：

package com.gitee.swsk33.loginterface.spi;
/**
 * 定義日志接口
 */
public interface Logger {
	/**
	 * INFO級別日志方法
	 *
	 * @param message 日志打印消息
	 */
	void info(String message);
	/**
	 * DEBUG級別日志方法
	 *
	 * @param message 日志打印消息
	 */
	void debug(String message);
}

這樣，我們便定義了這么一個日志接口，并聲明日志接口需要有info和debug這兩個日志功能。

然后就是編寫服務(wù)類，這個服務(wù)類是這里最為重要的地方，它的作用是掃描所有實(shí)現(xiàn)了Logger接口的實(shí)現(xiàn)類并加載進(jìn)來，然后供調(diào)用者去調(diào)用。

先看代碼：

package com.gitee.swsk33.loginterface.service;
import com.gitee.swsk33.loginterface.spi.Logger;
import java.util.ArrayList;
import java.util.List;
import java.util.ServiceLoader;
/**
 * 服務(wù)，用于加載所有服務(wù)使用者的實(shí)現(xiàn)類，以及供外部調(diào)用
 * 該類為一個單例
 */
public class LoggerService {
	/**
	 * 該類唯一單例
	 */
	private static final LoggerService LOGGER = new LoggerService();
	/**
	 * 默認(rèn)的Logger實(shí)現(xiàn)類
	 */
	private final Logger defaultLogger;
	/**
	 * 所有的Logger實(shí)現(xiàn)類列表
	 */
	private final List<Logger> allLoggers = new ArrayList<>();
	/**
	 * 私有化構(gòu)造器
	 */
	private LoggerService() {
		// 加載全部Logger接口的實(shí)現(xiàn)類
		ServiceLoader<Logger> loader = ServiceLoader.load(Logger.class);
		// 將實(shí)現(xiàn)類放入我們的Logger實(shí)現(xiàn)類列表
		for (Logger logger : loader) {
			allLoggers.add(logger);
		}
		// 這里取出第一個作為默認(rèn)實(shí)現(xiàn)類
		if (!allLoggers.isEmpty()) {
			defaultLogger = allLoggers.get(0);
		} else {
			defaultLogger = null;
		}
		System.out.println("加載到" + allLoggers.size() + "個服務(wù)實(shí)現(xiàn)！");
	}
	/**
	 * 獲取該服務(wù)類的唯一單例
	 *
	 * @return 該服務(wù)類的唯一單例
	 */
	public static LoggerService getInstance() {
		return LOGGER;
	}
	/**
	 * 調(diào)用默認(rèn)的實(shí)現(xiàn)類的info日志打印方法
	 *
	 * @param message 消息
	 */
	public void info(String message) {
		if (defaultLogger == null) {
			System.err.println("沒有找到實(shí)現(xiàn)了Logger接口的類！");
			return;
		}
		defaultLogger.info(message);
	}
	/**
	 * 調(diào)用默認(rèn)的實(shí)現(xiàn)類的debug日志打印方法
	 *
	 * @param message 消息
	 */
	public void debug(String message) {
		if (defaultLogger == null) {
			System.err.println("沒有找到實(shí)現(xiàn)了Logger接口的類！");
			return;
		}
		defaultLogger.debug(message);
	}
}

首先這個類是一個單例的類，在構(gòu)造器中，我們使用ServiceLoader這個類來將實(shí)現(xiàn)了Logger接口的所有類都掃描進(jìn)來，并存入我們的實(shí)現(xiàn)類列表，然后我們?nèi)〕隽斜碇械牡谝粋€作為默認(rèn)實(shí)現(xiàn)。

在下面我們定義了info和debug來完成對接口的默認(rèn)實(shí)現(xiàn)類的調(diào)用。

最后，在項目目錄下執(zhí)行mvn install命令將其安裝至本地Maven倉庫，以便后續(xù)服務(wù)提供者引入并實(shí)現(xiàn)。

(2) 完成一個接口的實(shí)現(xiàn)

現(xiàn)在再新建一個空的Maven項目logservice-one，并引入上面接口項目為依賴：

然后編寫實(shí)現(xiàn)類：

package com.gitee.swsk33.logserviceone.service;
import com.gitee.swsk33.loginterface.spi.Logger;
/**
 * Logger SPI的實(shí)現(xiàn)類
 */
public class LogOne implements Logger {
	@Override
	public void info(String s) {
		System.out.println("[LogOne INFO] " + s);
	}
	@Override
	public void debug(String s) {
		System.out.println("[LogOne DEBUG] " + s);
	}
}

然后在resources目錄下創(chuàng)建目錄META-INF/services，這個目錄中是用于聲明該服務(wù)實(shí)現(xiàn)中有哪些實(shí)現(xiàn)類實(shí)現(xiàn)了什么接口。

在這個目錄下我們新建一個文件名為com.gitee.swsk33.loginterface.spi.Logger，文件中的內(nèi)容為：

com.gitee.swsk33.logserviceone.service.LogOne

可見，該目錄下文件名是要實(shí)現(xiàn)的接口的全限定類名（包名 + 類名），而文件中內(nèi)容是實(shí)現(xiàn)了該接口的實(shí)現(xiàn)類的全限定類名。

大家參考這里的文件名及其中的內(nèi)容，與我們上述的接口全限定類名、實(shí)現(xiàn)類全限定類名對比一下就知道了！

如果說這個項目中有多個類實(shí)現(xiàn)了Logger接口，那么我們都需要在文件中聲明，一行一個實(shí)現(xiàn)類的全限定類名。

最終整個項目結(jié)構(gòu)如下：

同樣地，最后記得在項目目錄下執(zhí)行mvn install命令將其安裝至本地Maven倉庫，以便調(diào)用者調(diào)用。

(3) 測試接口

這里再新建一個Maven空項目log-test，作為接口的調(diào)用者，在依賴中引入實(shí)現(xiàn)者：

然后創(chuàng)建一個主類調(diào)用一下接口試試：

package com.gitee.swsk33.logtest;
import com.gitee.swsk33.loginterface.service.LoggerService;
public class Main {
	private static final LoggerService LOGGER = LoggerService.getInstance();
	public static void main(String[] args) {
		LOGGER.info("測試info消息");
		LOGGER.debug("測試debug消息");
	}
}

結(jié)果：

可見，我們成功地調(diào)用了Logger接口中的方法。

通常調(diào)用者的依賴中可能會同時引入SPI接口依賴和服務(wù)提供者（實(shí)現(xiàn)）的依賴，這樣也沒問題，不過通常服務(wù)提供者本身就依賴于SPI接口，因此只引入服務(wù)提供者依賴，也會間接地引入SPI接口依賴，不影響我們調(diào)用SPI接口。

我們這里只有一個服務(wù)提供者logservice-one，如果說還有logservice-two等等多個服務(wù)提供者，我們只需要在依賴中更換一下即可，代碼完全不需要改變。

也可見調(diào)用者在調(diào)用接口的時候，只需要關(guān)注接口就行了，不需要關(guān)心實(shí)現(xiàn)類。

3、再看ServiceLoader

可見在SPI接口中，我們使用ServiceLoader完成了對所有實(shí)現(xiàn)了Logger接口的類的掃描和加載，那么具體的過程是什么樣的呢？

如果大家去查看這個類的源碼，可以發(fā)現(xiàn)它實(shí)現(xiàn)了Iterable接口，這也說明我們可以通過迭代的方式去完成多個實(shí)現(xiàn)類的切換。

然后在其源碼中，有這么一個常量定義：

static final String PREFIX = "META-INF/services/";

這就說明，ServiceLoader會去掃描服務(wù)提供者的classpath路徑下的META-INF/services目錄，來掃描哪些類實(shí)現(xiàn)了指定接口，而其靜態(tài)方法load的參數(shù)，正是指定了被實(shí)現(xiàn)的接口。也因此我們要在服務(wù)提供者的項目的resources目錄下創(chuàng)建這個目錄并申明接口和對應(yīng)實(shí)現(xiàn)類的全限定類名。

在Maven項目中，resources目錄就對應(yīng)的是classpath的根目錄。

簡而言之，ServiceLoader加載實(shí)現(xiàn)類的過程如下：

先是調(diào)用load方法并指定要掃描的接口
然后掃描項目中META-INF/services目錄，這包括調(diào)用者項目以及它所引入的所有依賴包中的META-INF/services目錄下的聲明
掃描到所有實(shí)現(xiàn)類后，根據(jù)其類名，先判斷是否跟SPI接口為同一類型，如果是則利用反射的方式將所有實(shí)現(xiàn)類實(shí)例化，加載進(jìn)內(nèi)存，并返回所有實(shí)現(xiàn)類的實(shí)例列表

可見，這就是JDK中SPI機(jī)制加載服務(wù)的大致過程，事實(shí)上，現(xiàn)在很多框架也利用SPI機(jī)制實(shí)現(xiàn)了靈活地擴(kuò)展。

示例倉庫地址：傳送門

以上就是一文帶你掌握J(rèn)ava SPI的原理和實(shí)踐的詳細(xì)內(nèi)容，更多關(guān)于Java SPI的資料請關(guān)注腳本之家其它相關(guān)文章！

您可能感興趣的文章: