首頁  >  文章  >  Java  >  Java中的SPI機制是什麼

Java中的SPI機制是什麼

王林
王林轉載
2023-05-17 23:40:553157瀏覽

1: SPI機制簡介

SPI 全名為 Service Provider Interface,是一種 JDK 內建的動態載入實作擴充點的機制,透過 SPI 技術我們可以動態取得介面的實作類,不用自己來創建。這不是什麼特別的技術,只是 一種設計理念。

2: SPI原理

Java中的SPI機制是什麼

Java SPI 其實是基於介面的程式設計+策略模式+設定檔組合實作的動態載入機制。

系統設計的各個抽象,往往有很多不同的實作方案,在面向的物件的設計裡,一般推薦模組之間基於介面編程,模組之間不對實作類別進行硬編碼。如果程式碼中引用了特定的實作類,那麼就違反了可插拔的原則。為了進行實現的替換,需要對程式碼進行修改。需要一種服務發現機制,以實現在模組組裝時無需在程式中動態指定。

Java SPI提供了一個機制,可以尋找與某個介面相關的服務實作。在模組化設計中,一種類似IOC思想的機制被廣泛使用,即將組件的組裝控制權轉移到程式之外。所以SPI的核心思想就是解耦。

3: 使用場景

呼叫者根據實際使用需求 啟用、擴充、或取代框架的實作策略

以下是一些使用了該機制的場景

  • JDBC驅動,載入不同資料庫的驅動類別

  • Spring中大量使用了SPI,例如:對servlet3.0規格對ServletContainerInitializer的實作、自動類型轉換Type Conversion SPI(Converter SPI、Formatter SPI)等

  • #Dubbo中也大量使用SPI的方式實現框架的擴展, 不過它對Java提供的原生SPI做了封裝,允許使用者擴充實作Filter介面

  • Tomcat 載入META-INF/services下找需要載入的類別

  • SpringBoot專案中使用@SpringBootApplication註解時,會開始自動配置,而啟動配置則會去掃描META-INF/spring.factories下的配置類別

4: 源碼論證

4.1 應用程序呼叫ServiceLoader.load方法

ServiceLoader.load方法內先建立一個新的ServiceLoader,並實例化該類別中的成員變數

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


  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();
    }

	/** 
     * 
     * 在调用该方法之后,迭代器方法的后续调用将延迟地从头开始查找和实例化提供程序,就像新创建的加载程序所做的		  那样
     */
   public void reload() {
        providers.clear(); //清除此加载程序的提供程序缓存,以便重新加载所有提供程序。
        lookupIterator = new LazyIterator(service, loader);
    }

	private class LazyIterator implements Iterator<S>{

        Class<S> service;
        ClassLoader loader;
        Enumeration<URL> configs = null;
        Iterator<String> pending = null;
        String nextName = null;


        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
        }

5: 實戰

#步驟1 新建以下類別

public interface IService {

    /**
     * 获取价格
     * @return
     */
    String getPrice();

    /**
     * 获取规格信息
     * @return
     */
    String getSpecifications();
}
public class GoodServiceImpl implements IService {

    @Override
    public String getPrice() {
        return "2000.00元";
    }

    @Override
    public String getSpecifications() {
        return "200g/件";
    }
}
public class MedicalServiceImpl implements IService {

    @Override
    public String getPrice() {
        return "3022.12元";
    }

    @Override
    public String getSpecifications() {
        return "30粒/盒";
    }
}

步驟2、在src/main/resources/ 下建立/META-INF/services 目錄, 新增一個以介面命名的文件org.example.IService.txt 。內容是要應用的實作類,我這邊需要放入的資料如下

org.example.GoodServiceImpl
org.example.MedicalServiceImpl

#步驟3、使用ServiceLoader 來載入設定檔中指定的實作。

public class Main {
    public static void main(String[] args) {
        final ServiceLoader<IService> serviceLoader = ServiceLoader.load(IService.class);
        serviceLoader.forEach(service -> {
            System.out.println(service.getPrice() + "=" + service.getSpecifications());
        });
    }
}

輸出:

2000.00元=200g/件
3022.12元=30粒/盒

6: 優缺點

6.1 優點

解耦 使得第三方服務模組的組裝控制的邏輯與呼叫者的業務代碼分離,而不是耦合在一起,應用程式可以根據實際業務情況啟用框架擴展或替換框架組件。相較於使用提供介面jar包,供第三方服務模組實現介面的方式,SPI的方式使得來源框架,不必關心介面的實作類別的路徑

6.2 缺點

  • 雖然ServiceLoader也算是使用的延遲加載,但是基本上只能透過遍歷全部獲取,也就是接口的實現類別全部加載並實例化一遍。如果某些實作類別被載入並實例化,但你並不需要使用它們,那麼就會造成資源浪費。取得特定實作類別的方式過於受限,只能使用迭代器形式來取得,無法基於特定參數取得對應的實作類別

  • #多個並發多執行緒使用ServiceLoader類別的實例是不安全的

以上是Java中的SPI機制是什麼的詳細內容。更多資訊請關注PHP中文網其他相關文章!

陳述:
本文轉載於:yisu.com。如有侵權,請聯絡admin@php.cn刪除