Java-SPI機制詳解

笨笨的二黃子發表於2023-04-08
Java

Java之SPI機制詳解

1: SPI機制簡介

SPI 全稱是 Service Provider Interface，是一種 JDK 內建的動態載入實現擴充套件點的機制，透過 SPI 技術我們可以動態獲取介面的實現類，不用自己來建立。這個不是什麼特別的技術，只是 一種設計理念。

2: SPI原理

image

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也算是使用的延遲載入，但是基本只能透過遍歷全部獲取，也就是介面的實現類全部載入並例項化一遍。如果你並不想用某些實現類，它也被載入並例項化了，這就造成了浪費。獲取某個實現類的方式不夠靈活，只能透過Iterator形式獲取，不能根據某個引數來獲取對應的實現類
  • 多個併發多執行緒使用ServiceLoader類的例項是不安全的

相關文章