SPI是JDK內置的服務提供載入機制，可以為服務介面載入實現類，解耦是其核心思想，也是很多框架和組件的常用手段； ...
目錄
基於【JDK1.8】
一、SPI簡介
1、概念
SPI即service-provider-interface的簡寫；
JDK內置的服務提供載入機制，可以為服務介面載入實現類，解耦是其核心思想，也是很多框架和組件的常用手段；
2、入門案例
2.1 定義介面
就是普通的介面，在SPI的機制中稱為【service】，即服務；
public interface Animal {
String animalName () ;
}
2.2 兩個實現類
提供兩個模擬用來測試，就是普通的介面實現類，在SPI的機制中稱為【service-provider】即服務提供方；
CatAnimal實現類；
public class CatAnimal implements Animal {
@Override
public String animalName() {
System.out.println("Cat-Animal：布偶貓");
return "Ragdoll";
}
}
DogAnimal實現類；
public class DogAnimal implements Animal {
@Override
public String animalName() {
System.out.println("Dog-Animal：哈士奇");
return "husky";
}
}
2.3 配置文件
文件目錄：在代碼工程中創建META-INF.services文件夾；
文件命名：butte.program.basics.spi.inf.Animal，即全限定介面名稱；
文件內容：添加相應實現類的全限定命名；
butte.program.basics.spi.impl.CatAnimal
butte.program.basics.spi.impl.DogAnimal
2.4 測試代碼
通過ServiceLoader載入配置文件中指定的服務實現類，然後遍歷並調用Animal介面方法，從而執行不同服務提供方的具體邏輯；
public class SpiAnaly {
public static void main(String[] args) {
ServiceLoader<Animal> serviceLoader = ServiceLoader.load(Animal.class);
Iterator<Animal> animalIterator = serviceLoader.iterator();
while(animalIterator.hasNext()) {
Animal animal = animalIterator.next();
System.out.println("animal-name:" + animal.animalName());
}
}
}
結果輸出
Cat-Animal：布偶貓 \n animal-name:ragdoll
Dog-Animal：哈士奇 \n animal-name:husky
二、原理分析
1、ServiceLoader結構
很顯然，分析SPI機制的原理，從ServiceLoader源碼中load方法切入即可，但是需要先從核心類的結構開始分析；
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;
// 創建ServiceLoader時採用的訪問控制上下文
private final AccessControlContext acc;
// 按實例化的順序緩存服務提供方
private LinkedHashMap<String,S> providers = new LinkedHashMap<>();
// 惰性查找迭代器
private LazyIterator lookupIterator;
/**
* service：表示服務的介面或抽象類
* loader: 類載入器
*/
public static <S> ServiceLoader<S> load(Class<S> service) {
ClassLoader cl = Thread.currentThread().getContextClassLoader();
return ServiceLoader.load(service, cl);
}
/**
* ServiceLoader構造方法
*/
private ServiceLoader(Class<S> svc, ClassLoader cl) {
loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
reload();
}
public void reload() {
providers.clear();
// 實例化迭代器
lookupIterator = new LazyIterator(service, loader);
}
public static <S> ServiceLoader<S> load(Class<S> service,ClassLoader loader) {
return new ServiceLoader<>(service, loader);
}
private class LazyIterator implements Iterator<S> {
// 服務介面
Class<S> service;
// 類載入器
ClassLoader loader;
// 實現類URL
Enumeration<URL> configs = null;
// 實現類全名
Iterator<String> pending = null;
// 下個實現類全名
String nextName = null;
}
}
斷點截圖：
2、iterator迭代方法
在ServiceLoader類的迭代器方法中，實際使用的是LazyIterator內部類的方法；
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();
}
};
}
3、hasNextService方法
從上面迭代方法的源碼中可知，最終執行的是LazyIterator#hasNextService判斷方法，該方法通過解析最終會得到實現類的全限定名稱；
private class LazyIterator implements Iterator<S> {
private boolean hasNextService() {
// 1、拼接名稱
String fullName = PREFIX + service.getName();
// 2、載入資源文件
configs = loader.getResources(fullName);
// 3、解析文件內容
pending = parse(service, configs.nextElement());
nextName = pending.next();
return true;
}
}
斷點截圖：
4、nextService方法
迭代器的next方法最終執行的是LazyIterator#nextService獲取方法，會基於上面hasNextService方法獲取的實現類全限定名稱，獲取其Class對象，進而得到實例化對象，緩存並返回；
private class LazyIterator implements Iterator<S> {
private S nextService() {
// 1、通過全限定命名獲取Class對象
String cn = nextName;
Class<?> c = Class.forName(cn, false, loader);
// 2、實例化對象
S p = service.cast(c.newInstance());
// 3、放入緩存並返回該對象
providers.put(cn, p);
return p;
}
}
斷點截圖：
三、SPI實踐
1、Driver驅動介面
在JDK中提供了資料庫驅動介面java.sql.Driver，無論是MySQL驅動包還是Druid連接池，都提供了該介面的實現類，通過SPI機制可以載入到這些驅動實現類；
public class DriverManager {
private static void loadInitialDrivers() {
AccessController.doPrivileged(new PrivilegedAction<Void>() {
public Void run() {
ServiceLoader<Driver> loadedDrivers = ServiceLoader.load(java.sql.Driver.class);
Iterator<Driver> driversIterator = loadedDrivers.iterator();
}
});
}
}
斷點截圖：
2、Slf4j日誌介面
SLF4J是門面模式的日誌組件，提供了標準的日誌服務SLF4JServiceProvider介面，在LogFactory日誌工廠類中，負責載入具體的日誌實現類，比如常用的Log4j或Logback日誌組件；
public final class LoggerFactory {
static List<SLF4JServiceProvider> findServiceProviders() {
// 服務載入
ClassLoader classLoaderOfLoggerFactory = org.slf4j.LoggerFactory.class.getClassLoader();
// 重點看該方法：【getServiceLoader()】
ServiceLoader<SLF4JServiceProvider> serviceLoader = getServiceLoader(classLoaderOfLoggerFactory);
// 迭代方法
List<SLF4JServiceProvider> providerList = new ArrayList();
Iterator<SLF4JServiceProvider> iterator = serviceLoader.iterator();
while(iterator.hasNext()) {
safelyInstantiate(providerList, iterator);
}
return providerList;
}
}
斷點截圖：
四、參考源碼
文檔倉庫：
https://gitee.com/cicadasmile/butte-java-note
應用倉庫：
https://gitee.com/cicadasmile/butte-flyer-parent
