Java中的SPI機制案例分享
更新時間：2022年04月28日 10:07:57 作者：CoderJie?
這篇文章主要介紹了Java中的SPI機制案例分享，文章基于Java的相關資料展開SPI的詳細介紹，SPI的全稱是Service?Provider?Interface，服務提供者接口，下文更多相關內(nèi)容介紹需要的小伙伴可以參考一下
1 簡單介紹
當我們封裝了一套接口，其它項目想要調用我們的接口只需要引入我們寫好的包，但是其它項目如果想要對我們的接口進行擴展，由于接口是被封裝在依賴包中的，想要擴展并不容易，這時就需要依賴于Java為我們提供的SPI機制。
SPI的全稱是Service Provider Interface，服務提供者接口，而與之最接近的概念就是API，全稱Application Programming Interface，應用程序編程接口。那么這兩者主要的區(qū)別是什么呢？
API的調用方只能依賴使用提供方已有的實現(xiàn)，而SPI就是可定制化的API，調用方可以自定義實現(xiàn)替換API提供的默認實現(xiàn)。
SPI機制是非常重要的，尤其是對于框架來說，它可以用來啟用框架擴展和替換組件，我們在讀框架源碼時也會看到大量的SPI的應用。
SPI的作用就是為這些被擴展的API尋找服務實現(xiàn)。
2 SPI 案例
創(chuàng)建一個工程，一個做SPI的服務提供者，一個做SPI服務引入擴展的測試，此案例構建最簡單的Maven子父工程即可，在spi-test工程引入spi-provider的依賴。
spi-test添加依賴
<dependencies>
<dependency>
<groupId>org.example</groupId>
<artifactId>spi-provider</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
</dependencies>在spi-provider中，提供接口和一個默認的實現(xiàn)類
在資源文件中加上如下圖文件，并在改文件中指定接口的默認實現(xiàn)類
spi-test中構建可執(zhí)行的測試方法，直接執(zhí)行，會拿到默認的實現(xiàn)
我們可以在spi-test中擴展，這個接口，如下圖所示：
這時我們的擴展并不能生效，我們?nèi)孕枰谫Y源文件下，為接口指定我們擴展的實現(xiàn)類，這時在運行上述測試方法即可得到我們擴展后的結果，這就是SPI機制。
3 SPI 的原理剖析
ServiceLoader這個類包含了SPI的核心原理，從開頭指定的路徑前綴，我們就能猜到為什么我們必須將文件放入這個路徑下才會生效。
通過load方法，創(chuàng)建一個ServiceLoader的對象，進入其構造方法，進行reload， 會創(chuàng)建一個新的LazyIterator迭代器，LazyIterator是一個內(nèi)部類，它負責掃描META-INF/services/下的配置文件，并parse所有接口的名字，然后通過全限定類名通過反射進行實現(xiàn)類的加載。
public final class ServiceLoader<S>
implements Iterable<S>
{
// 掃描路徑前綴
private static final String PREFIX = "META-INF/services/";
// 被加載的類或者接口
private final Class<S> service;
// 用于定位、加載和實例化需要加載類的類加載器
private final ClassLoader loader;
// 上下文對象
private final AccessControlContext acc;
// 按照實例化的順序緩存已經(jīng)實例化的類
private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
// 懶查找迭代器
private LazyIterator lookupIterator;
// 重新加載
public void reload() {
// 清理緩存
providers.clear();
// 新的懶查找迭代器
lookupIterator = new LazyIterator(service, loader);
}
// 構造方法
private ServiceLoader(Class<S> svc, ClassLoader cl) {
service = Objects.requireNonNull(svc, "Service interface cannot be null");
loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
reload();
}
private static void fail(Class<?> service, String msg, Throwable cause)
throws ServiceConfigurationError
{
throw new ServiceConfigurationError(service.getName() + ": " + msg,
cause);
}
private static void fail(Class<?> service, String msg)
throws ServiceConfigurationError
{
throw new ServiceConfigurationError(service.getName() + ": " + msg);
}
private static void fail(Class<?> service, URL u, int line, String msg)
throws ServiceConfigurationError
{
fail(service, u + ":" + line + ": " + msg);
}
private int parseLine(Class<?> service, URL u, BufferedReader r, int lc,
List<String> names)
throws IOException, ServiceConfigurationError
{
String ln = r.readLine();
if (ln == null) {
return -1;
}
int ci = ln.indexOf('#');
if (ci >= 0) ln = ln.substring(0, ci);
ln = ln.trim();
int n = ln.length();
if (n != 0) {
if ((ln.indexOf(' ') >= 0) || (ln.indexOf('\t') >= 0))
fail(service, u, lc, "Illegal configuration-file syntax");
int cp = ln.codePointAt(0);
if (!Character.isJavaIdentifierStart(cp))
fail(service, u, lc, "Illegal provider-class name: " + ln);
for (int i = Character.charCount(cp); i < n; i += Character.charCount(cp)) {
cp = ln.codePointAt(i);
if (!Character.isJavaIdentifierPart(cp) && (cp != '.'))
fail(service, u, lc, "Illegal provider-class name: " + ln);
}
if (!providers.containsKey(ln) && !names.contains(ln))
names.add(ln);
}
return lc + 1;
}
private Iterator<String> parse(Class<?> service, URL u)
throws ServiceConfigurationError
{
InputStream in = null;
BufferedReader r = null;
ArrayList<String> names = new ArrayList<>();
try {
in = u.openStream();
r = new BufferedReader(new InputStreamReader(in, "utf-8"));
int lc = 1;
while ((lc = parseLine(service, u, r, lc, names)) >= 0);
} catch (IOException x) {
fail(service, "Error reading configuration file", x);
} finally {
try {
if (r != null) r.close();
if (in != null) in.close();
} catch (IOException y) {
fail(service, "Error closing configuration file", y);
}
}
return names.iterator();
}
private class LazyIterator
implements Iterator<S>
{
Class<S> service;
ClassLoader loader;
Enumeration<URL> configs = null;
Iterator<String> pending = null;
String nextName = null;
private LazyIterator(Class<S> service, ClassLoader loader) {
this.service = service;
this.loader = loader;
}
private boolean hasNextService() {
if (nextName != null) {
return true;
}
if (configs == null) {
try {
String fullName = PREFIX + service.getName();
if (loader == null)
configs = ClassLoader.getSystemResources(fullName);
else
configs = loader.getResources(fullName);
} catch (IOException x) {
fail(service, "Error locating configuration files", x);
}
}
while ((pending == null) || !pending.hasNext()) {
if (!configs.hasMoreElements()) {
return false;
}
pending = parse(service, configs.nextElement());
}
nextName = pending.next();
return true;
}
private S nextService() {
if (!hasNextService())
throw new NoSuchElementException();
String cn = nextName;
nextName = null;
Class<?> c = null;
try {
c = Class.forName(cn, false, loader);
} catch (ClassNotFoundException x) {
fail(service,
"Provider " + cn + " not found");
}
if (!service.isAssignableFrom(c)) {
fail(service,
"Provider " + cn + " not a subtype");
}
try {
S p = service.cast(c.newInstance());
providers.put(cn, p);
return p;
} catch (Throwable x) {
fail(service,
"Provider " + cn + " could not be instantiated",
x);
}
throw new Error(); // This cannot happen
}
public boolean hasNext() {
if (acc == null) {
return hasNextService();
} else {
PrivilegedAction<Boolean> action = new PrivilegedAction<Boolean>() {
public Boolean run() { return hasNextService(); }
};
return AccessController.doPrivileged(action, acc);
}
}
public S next() {
if (acc == null) {
return nextService();
} else {
PrivilegedAction<S> action = new PrivilegedAction<S>() {
public S run() { return nextService(); }
};
return AccessController.doPrivileged(action, acc);
}
}
public void remove() {
throw new UnsupportedOperationException();
}
}
public Iterator<S> iterator() {
return new Iterator<S>() {
Iterator<Map.Entry<String,S>> knownProviders
= providers.entrySet().iterator();
public boolean hasNext() {
if (knownProviders.hasNext())
return true;
return lookupIterator.hasNext();
}
public S next() {
if (knownProviders.hasNext())
return knownProviders.next().getValue();
return lookupIterator.next();
}
public void remove() {
throw new UnsupportedOperationException();
}
};
}
public static <S> ServiceLoader<S> load(Class<S> service) {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
return ServiceLoader.load(service, cl);
}
public static <S> ServiceLoader<S> loadInstalled(Class<S> service) {
ClassLoader cl = ClassLoader.getSystemClassLoader();
ClassLoader prev = null;
while (cl != null) {
prev = cl;
cl = cl.getParent();
}
return ServiceLoader.load(service, prev);
}
public String toString() {
return "java.util.ServiceLoader[" + service.getName() + "]";
}
}從上面的源碼中，我們不難發(fā)現(xiàn)ServiceLoader并沒有額外的加鎖機制，所以會存在并發(fā)問題，再就是獲取對應的實現(xiàn)類不夠靈活，需要使用迭代器的方式獲取已知接口的所有具體實現(xiàn)類，所以每次都要加載和實例化所有的實現(xiàn)類，擴展如果依賴了其它的擴展，做不到自動注入和裝配，擴展很難和其它框架集成。
也正是基于這種種原因，許多框架中不會去直接使用ServiceLoader這種原生的SPI機制而是會去基于這種思想進行一定的擴展，使其的功能更加強大，典型的案例就是dubbo的SPI，SpringBoot的SPI。
小編的這篇文章《SpringBoot借助spring.factories文件跨模塊實例化Bean》就是講SpringBoot中的SPI機制，感興趣的同學可以閱讀一下。
到此這篇關于Java中的SPI機制案例分享的文章就介紹到這了,更多相關Java中的SPI機制內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
SpringBoot整合MyBatis逆向工程及 MyBatis通用Mapper實例詳解
這篇文章主要介紹了SpringBoot整合MyBatis逆向工程及 MyBatis通用Mapper實例詳解 ,需要的朋友可以參考下2017-09-09
這篇文章主要為大家介紹了Spring?Data?JPA注解Entity使用示例詳解，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步，早日升職加薪2022-09-09
springboot新建項目jdk只有17/21,無法選中1.8解決辦法
最近博主也有創(chuàng)建springboot項目,發(fā)現(xiàn)了IntelliJ IDEA在通過Spring Initilizer初始化項目的時候已經(jīng)沒有java8版本的選項了,這里給大家總結下,這篇文章主要給大家介紹了springboot新建項目jdk只有17/21,無法選中1.8的解決辦法,需要的朋友可以參考下2023-12-12
這篇文章主要為大家詳細介紹了Java實現(xiàn)簡單計算器小程序，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2021-07-07
這篇文章主要為大家詳細介紹了java實現(xiàn)商品信息管理系統(tǒng)，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下2019-11-11
下面小編就為大家分享一篇基于JVM 中常見垃圾收集算法介紹，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2018-01-01
Java實現(xiàn)世界上最快的排序算法Timsort的示例代碼
Timsort?是一個混合、穩(wěn)定的排序算法，簡單來說就是歸并排序和二分插入排序算法的混合體，號稱世界上最好的排序算法。本文將詳解Timsort算法是定義與實現(xiàn)，需要的可以參考一下2022-07-07
springboot如何使用thymeleaf模板訪問html頁面
springboot中推薦使用thymeleaf模板，使用html作為頁面展示。那么如何通過Controller來訪問來訪問html頁面呢？下面通過本文給大家詳細介紹，感興趣的朋友跟隨腳本之家小編一起看看吧2018-05-05
這篇文章主要介紹了java實現(xiàn)屏幕共享功能的方法,以實例形式分析了屏幕共享功能的客戶端與服務端的詳細實現(xiàn)方法,是非常具有實用價值的技巧,需要的朋友可以參考下2014-12-12
這篇文章主要為大家介紹了Java數(shù)據(jù)結構和算法之鏈表 ，具有一定的參考價值，感興趣的小伙伴們可以參考一下，希望能夠給你帶來幫助2022-01-01