1. 簡介
Dubbo 並未使用 Java 原生的 SPI 機制，而是對其進行了增強，使其能夠更好的滿足需求。在 Dubbo 中，SPI 是一個非常重要的模組。基於 SPI，我們可以很容易的對 Dubbo 進行擴充。
2. 原始碼分析
Dubbo SPI 的相關邏輯被封裝在了 ExtensionLoader 類中，通過 ExtensionLoader，我們可以載入指定的實現類。Dubbo SPI 所需的配置檔案需放置在 META-INF/dubbo 路徑下。
我們首先通過 ExtensionLoader 的 getExtensionLoader 方法獲取一個 ExtensionLoader 例項，然後再通過 ExtensionLoader 的 getExtension 方法獲取擴充類物件。這其中，getExtensionLoader 方法用於從快取中獲取與擴充類對應的 ExtensionLoader，若快取未命中，則建立一個新的例項。該方法的邏輯比較簡單，本章就不進行分析了。
下面我們從 ExtensionLoader 的 getExtension 方法作為入口，對擴充類物件的獲取過程進行詳細的分析。
public T getExtension(String name) {
if (name == null || name.length() == 0)
throw new IllegalArgumentException("Extension name == null");
if ("true".equals(name)) {
// 獲取預設的擴充實現類
return getDefaultExtension();
}
// Holder，顧名思義，用於持有目標物件
Holder<Object> holder = cachedInstances.get(name);
if (holder == null) {
cachedInstances.putIfAbsent(name, new Holder<Object>());
holder = cachedInstances.get(name);
}
Object instance = holder.get();
// 雙重檢查
if (instance == null) {
synchronized (holder) {
instance = holder.get();
if (instance == null) {
// 建立擴充例項
instance = createExtension(name);
// 設定例項到 holder 中
holder.set(instance);
}
}
}
return (T) instance;
}
複製程式碼上面程式碼的邏輯比較簡單，首先檢查快取，快取未命中則建立擴充物件。下面我們來看一下建立擴充物件的過程是怎樣的。
private T createExtension(String name) {
// 從配置檔案中載入所有的擴充類，可得到“配置項名稱”到“配置類”的對映關係表
Class<?> clazz = getExtensionClasses().get(name);
if (clazz == null) {
throw findException(name);
}
try {
T instance = (T) EXTENSION_INSTANCES.get(clazz);
if (instance == null) {
// 通過反射建立例項
EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.newInstance());
instance = (T) EXTENSION_INSTANCES.get(clazz);
}
// 向例項中注入依賴
injectExtension(instance);
Set<Class<?>> wrapperClasses = cachedWrapperClasses;
if (wrapperClasses != null && !wrapperClasses.isEmpty()) {
// 迴圈建立 Wrapper 例項
for (Class<?> wrapperClass : wrapperClasses) {
// 將當前 instance 作為引數傳給 Wrapper 的構造方法，並通過反射建立 Wrapper 例項。
// 然後向 Wrapper 例項中注入依賴，最後將 Wrapper 例項再次賦值給 instance 變數
instance = injectExtension(
(T) wrapperClass.getConstructor(type).newInstance(instance));
}
}
return instance;
} catch (Throwable t) {
throw new IllegalStateException("...");
}
}
複製程式碼createExtension 方法的邏輯稍複雜一下，包含了如下的步驟：
- 通過 getExtensionClasses 獲取所有的擴充類
- 通過反射建立擴充物件
- 向擴充物件中注入依賴
- 將擴充物件包裹在相應的 Wrapper 物件中
以上步驟中，第一個步驟是載入擴充類的關鍵，第三和第四個步驟是 Dubbo IOC 與 AOP 的具體實現。在接下來的章節中，將會重點分析 getExtensionClasses 方法的邏輯，以及簡單介紹 Dubbo IOC 的具體實現。
3. 獲取所有的擴充類
我們在通過名稱獲取擴充類之前，首先需要根據配置檔案解析出擴充項名稱到擴充類的對映關係表（Map<名稱, 擴充類>），之後再根據擴充項名稱從對映關係表中取出相應的擴充類即可。相關過程的程式碼分析如下：
private Map<String, Class<?>> getExtensionClasses() {
// 從快取中獲取已載入的擴充類
Map<String, Class<?>> classes = cachedClasses.get();
// 雙重檢查
if (classes == null) {
synchronized (cachedClasses) {
classes = cachedClasses.get();
if (classes == null) {
// 載入擴充類
classes = loadExtensionClasses();
cachedClasses.set(classes);
}
}
}
return classes;
}
複製程式碼這裡也是先檢查快取，若快取未命中，則通過 synchronized 加鎖。加鎖後再次檢查快取，並判空。此時如果 classes 仍為 null，則通過 loadExtensionClasses 載入擴充類。下面分析 loadExtensionClasses 方法的邏輯。
private Map<String, Class<?>> loadExtensionClasses() {
// 獲取 SPI 註解，這裡的 type 變數是在呼叫 getExtensionLoader 方法時傳入的
final SPI defaultAnnotation = type.getAnnotation(SPI.class);
if (defaultAnnotation != null) {
String value = defaultAnnotation.value();
if ((value = value.trim()).length() > 0) {
// 對 SPI 註解內容進行切分
String[] names = NAME_SEPARATOR.split(value);
// 檢測 SPI 註解內容是否合法，不合法則丟擲異常
if (names.length > 1) {
throw new IllegalStateException("more than 1 default extension name on extension...");
}
// 設定預設名稱，參考 getDefaultExtension 方法
if (names.length == 1) {
cachedDefaultName = names[0];
}
}
}
Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
// 載入指定資料夾下的配置檔案
loadDirectory(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
loadDirectory(extensionClasses, DUBBO_DIRECTORY);
loadDirectory(extensionClasses, SERVICES_DIRECTORY);
return extensionClasses;
}
複製程式碼loadExtensionClasses 方法總共做了兩件事情，一是對 SPI 註解進行解析，二是呼叫 loadDirectory 方法載入指定資料夾配置檔案。SPI 註解解析過程比較簡單，無需多說。下面我們來看一下 loadDirectory 做了哪些事情。
private void loadDirectory(Map<String, Class<?>> extensionClasses, String dir) {
// fileName = 資料夾路徑 + type 全限定名
String fileName = dir + type.getName();
try {
Enumeration<java.net.URL> urls;
ClassLoader classLoader = findClassLoader();
// 根據檔名載入所有的同名檔案
if (classLoader != null) {
urls = classLoader.getResources(fileName);
} else {
urls = ClassLoader.getSystemResources(fileName);
}
if (urls != null) {
while (urls.hasMoreElements()) {
java.net.URL resourceURL = urls.nextElement();
// 載入資源
loadResource(extensionClasses, classLoader, resourceURL);
}
}
} catch (Throwable t) {
logger.error("...");
}
}
複製程式碼loadDirectory 方法先通過 classLoader 獲取所有資源連結，然後再通過 loadResource 方法載入資源。我們繼續跟下去，看一下 loadResource 方法的實現。
private void loadResource(Map<String, Class<?>> extensionClasses,
ClassLoader classLoader, java.net.URL resourceURL) {
try {
BufferedReader reader = new BufferedReader(
new InputStreamReader(resourceURL.openStream(), "utf-8"));
try {
String line;
// 按行讀取配置內容
while ((line = reader.readLine()) != null) {
// 定位 # 字元
final int ci = line.indexOf('#');
if (ci >= 0) {
// 擷取 # 之前的字串，# 之後的內容為註釋，需要忽略
line = line.substring(0, ci);
}
line = line.trim();
if (line.length() > 0) {
try {
String name = null;
int i = line.indexOf('=');
if (i > 0) {
// 以等於號 = 為界，擷取鍵與值
name = line.substring(0, i).trim();
line = line.substring(i + 1).trim();
}
if (line.length() > 0) {
// 載入類，並通過 loadClass 方法對類進行快取
loadClass(extensionClasses, resourceURL,
Class.forName(line, true, classLoader), name);
}
} catch (Throwable t) {
IllegalStateException e = new IllegalStateException("Failed to load extension class...");
}
}
}
} finally {
reader.close();
}
} catch (Throwable t) {
logger.error("Exception when load extension class...");
}
}
複製程式碼loadResource 方法用於讀取和解析配置檔案，並通過反射載入類，最後呼叫 loadClass 方法進行其他操作。loadClass 方法用於主要用於操作快取，該方法的邏輯如下：
private void loadClass(Map<String, Class<?>> extensionClasses, java.net.URL resourceURL,
Class<?> clazz, String name) throws NoSuchMethodException {
if (!type.isAssignableFrom(clazz)) {
throw new IllegalStateException("...");
}
// 檢測目標類上是否有 Adaptive 註解
if (clazz.isAnnotationPresent(Adaptive.class)) {
if (cachedAdaptiveClass == null) {
// 設定 cachedAdaptiveClass快取
cachedAdaptiveClass = clazz;
} else if (!cachedAdaptiveClass.equals(clazz)) {
throw new IllegalStateException("...");
}
// 檢測 clazz 是否是 Wrapper 型別
} else if (isWrapperClass(clazz)) {
Set<Class<?>> wrappers = cachedWrapperClasses;
if (wrappers == null) {
cachedWrapperClasses = new ConcurrentHashSet<Class<?>>();
wrappers = cachedWrapperClasses;
}
// 儲存 clazz 到 cachedWrapperClasses 快取中
wrappers.add(clazz);
// 程式進入此分支，表明 clazz 是一個普通的擴充類
} else {
// 檢測 clazz 是否有預設的構造方法，如果沒有，則丟擲異常
clazz.getConstructor();
if (name == null || name.length() == 0) {
// 如果 name 為空，則嘗試從 Extension 註解中獲取 name，或使用小寫的類名作為 name
name = findAnnotationName(clazz);
if (name.length() == 0) {
throw new IllegalStateException("...");
}
}
// 切分 name
String[] names = NAME_SEPARATOR.split(name);
if (names != null && names.length > 0) {
Activate activate = clazz.getAnnotation(Activate.class);
if (activate != null) {
// 如果類上有 Activate 註解，則使用 names 陣列的第一個元素作為鍵，
// 儲存 name 到 Activate 註解物件的對映關係
cachedActivates.put(names[0], activate);
}
for (String n : names) {
if (!cachedNames.containsKey(clazz)) {
// 儲存 Class 到名稱的對映關係
cachedNames.put(clazz, n);
}
Class<?> c = extensionClasses.get(n);
if (c == null) {
// 儲存名稱到 Class 的對映關係
extensionClasses.put(n, clazz);
} else if (c != clazz) {
throw new IllegalStateException("...");
}
}
}
}
}
複製程式碼如上，loadClass 方法操作了不同的快取，比如 cachedAdaptiveClass、cachedWrapperClasses 和 cachedNames 等等。除此之外，該方法沒有其他什麼邏輯了。
到此，關於快取類載入的過程就分析完了。整個過程沒什麼特別複雜的地方，大家按部就班的分析即可，不懂的地方可以除錯一下。接下來，我們來聊聊 Dubbo IOC 方面的內容。
4. Dubbo IOC
Dubbo IOC 是通過 setter 方法注入依賴。Dubbo 首先會通過反射獲取到例項的所有方法，然後再遍歷方法列表，檢測方法名是否具有 setter 方法特徵。若有，則通過 ObjectFactory 獲取依賴物件，最後通過反射呼叫 setter 方法將依賴設定到目標物件中。整個過程對應的程式碼如下：
private T injectExtension(T instance) {
try {
if (objectFactory != null) {
// 遍歷目標類的所有方法
for (Method method : instance.getClass().getMethods()) {
// 檢測方法是否以 set 開頭，且方法僅有一個引數，且方法訪問級別為 public
if (method.getName().startsWith("set")
&& method.getParameterTypes().length == 1
&& Modifier.isPublic(method.getModifiers())) {
// 獲取 setter 方法引數型別
Class<?> pt = method.getParameterTypes()[0];
try {
// 獲取屬性名，比如 setName 方法對應屬性名 name
String property = method.getName().length() > 3 ?
method.getName().substring(3, 4).toLowerCase() +
method.getName().substring(4) : "";
// 從 ObjectFactory 中獲取依賴物件
Object object = objectFactory.getExtension(pt, property);
if (object != null) {
// 通過反射呼叫 setter 方法設定依賴
method.invoke(instance, object);
}
} catch (Exception e) {
logger.error("fail to inject via method...");
}
}
}
}
} catch (Exception e) {
logger.error(e.getMessage(), e);
}
return instance;
}
複製程式碼在上面程式碼中，objectFactory 變數的型別為 AdaptiveExtensionFactory，AdaptiveExtensionFactory 內部維護了一個 ExtensionFactory 列表，用於儲存其他型別的 ExtensionFactory。Dubbo 目前提供了兩種 ExtensionFactory，分別是 SpiExtensionFactory 和 SpringExtensionFactory。前者用於建立自適應的擴充，後者是用於從 Spring 的 IOC 容器中獲取所需的擴充。這兩個類的類的程式碼不是很複雜，這裡就不一一分析了。
Dubbo IOC 目前僅支援 setter 方式注入，總的來說，邏輯比較簡單易懂。
5. 總結
本篇文章簡單分別介紹了 Java SPI 與 Dubbo SPI 用法，並對 Dubbo SPI 的載入擴充類的過程進行了分析。另外，在 Dubbo SPI 中還有一塊重要的邏輯這裡沒有進行分析，即 Dubbo SPI 的擴充套件點自適應機制。該機制的邏輯較為複雜，我們將會在下一篇文章中進行詳細的分析。
歡迎大家加入Java高階架構群 378461078