java中的SPI機制

介紹

SPI全稱Service Provider Interface，是Java提供的一套用來被第三方實現或者擴展的API，它可以用來啟用框架擴展和替換組件。

使用

定義一個接口，可以飛的

public interface Flyable {

  void fly();
}

定義兩個實現類，老鷹和鴿子

public class Eagle implements Flyable {

  @Override
  public void fly() {
    System.out.println("eagle fly");
  }
}

public class Dove implements Flyable {

  @Override
  public void fly() {
    System.out.println("dove fly");
  }
}

public class Client {
  public static void main(String[] args) {
    ServiceLoader<Flyable> serviceLoader = ServiceLoader.load(Flyable.class);
    for (Flyable flyable : serviceLoader) {
      flyable.fly();
    }
  }
}

在resources目錄下創建META-INF目錄，META-INF下創建services目錄，services下創建文件名為接口的全限定名的文件，內容為接口的實現類的全限定名，每個一行。
輸出結果：

dove fly
eagle fly

原理

我們看一下ServiceLoader的內部實現原理

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 LinkedHashMap<String,S> providers = new LinkedHashMap<>();
// 延遲迭代器 在hasNext時才真正解析文件
    private LazyIterator lookupIterator;

    private class LazyIterator implements Iterator<S> {	
	//判斷是否有下一條記錄是才真正解析文件
	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
        }
    }
}

在jdbc的Driver的加載過程中就用到了SPI。

mysql的配置文件