各種SPI實(shí)現(xiàn)均通過(guò)ClassLoader加載, 如何獲取ClassLoader, 可以參考各框架源碼, 或參考鏈接:
http://www.reibang.com/p/8c0adcdbafa5

1.SPI概述

SPI 全稱為 Service Provider Interface，是一種服務(wù)發(fā)現(xiàn)機(jī)制.

比如你有個(gè)接口缅阳，該接口有3個(gè)實(shí)現(xiàn)類沈自，那么在系統(tǒng)運(yùn)行時(shí),這個(gè)接口到底選擇哪個(gè)實(shí)現(xiàn)類呢？
這就需要SPI了绰精，需要根據(jù)指定的配置或者是默認(rèn)的配置，找到對(duì)應(yīng)的實(shí)現(xiàn)類加載進(jìn)來(lái)，然后使用該實(shí)現(xiàn)類的實(shí)例.
#如:
接口A => 實(shí)現(xiàn)A1纵穿，實(shí)現(xiàn)A2如迟，實(shí)現(xiàn)A3
配置一下收毫，接口A = 實(shí)現(xiàn)A2
在系統(tǒng)實(shí)際運(yùn)行的時(shí)候攻走，會(huì)加載你的配置，用實(shí)現(xiàn)A2實(shí)例化一個(gè)對(duì)象來(lái)提供服務(wù)

比如說(shuō)你要通過(guò)jar包的方式給某個(gè)接口提供實(shí)現(xiàn)此再，
然后你就在自己jar包的META-INF/services/目錄下放一個(gè)接口同名文件昔搂，
指定接口的實(shí)現(xiàn)是自己這個(gè)jar包里的某個(gè)類.

ok了，別人用了一個(gè)接口输拇，然后用了你的jar包摘符，就會(huì)在運(yùn)行的時(shí)候通過(guò)你的jar包的那個(gè)文件找到這個(gè)接口該用哪個(gè)實(shí)現(xiàn)類.
這是JDK提供的一個(gè)功能.

比如你有個(gè)工程A，有個(gè)接口A策吠，接口A在工程A是沒(méi)有實(shí)現(xiàn)類的,那么問(wèn)題來(lái)了,系統(tǒng)運(yùn)行時(shí),怎么給接口A選擇一個(gè)實(shí)現(xiàn)類呢?
你可以自己搞一個(gè)jar包逛裤，META-INF/services/,放上一個(gè)文件,文件名即接口名，接口A猴抹，接口A的實(shí)現(xiàn)類=com.javaedge.service.實(shí)現(xiàn)類A2
讓工程A來(lái)依賴你的jar包,然后在系統(tǒng)運(yùn)行時(shí),工程A跑起來(lái),對(duì)于接口A,
就會(huì)掃描依賴的jar包,看看有沒(méi)有META-INF/services文件夾,
如果有,看再看有沒(méi)有名為接口A的文件,如果有,
在里面找一下指定的接口A的實(shí)現(xiàn)是你的jar包里的哪個(gè)類!


經(jīng)典的思想體現(xiàn)带族，其實(shí)大家平時(shí)都在用，比如說(shuō)JDBC
Java定義了一套JDBC的接口蟀给，但是并沒(méi)有提供其實(shí)現(xiàn)類
但實(shí)際上項(xiàng)目運(yùn)行時(shí),要使用JDBC接口的哪些實(shí)現(xiàn)類呢?
一般來(lái)說(shuō)蝙砌，我們要根據(jù)自己使用的數(shù)據(jù)庫(kù)，比如
MySQL,你就將mysql-jdbc-connector.jar
oracle跋理，你就將oracle-jdbc-connector.jar引入
系統(tǒng)運(yùn)行時(shí),碰到你使用JDBC的接口,就會(huì)在底層使用你引入的那個(gè)jar中提供的實(shí)現(xiàn)類

2.jdk中的SPI機(jī)制(jdk1.6開(kāi)始)

2.1基本要求

0.定義一個(gè)接口, 以及接口對(duì)應(yīng)的實(shí)現(xiàn)類
1.配置文件要求
1.1必須在classpath下, 即resources目錄下建立META-INF/services/目錄
1.2以接口全限定名為文件名, 實(shí)現(xiàn)類全限定名寫在對(duì)應(yīng)接口文件中, 多個(gè)實(shí)現(xiàn)類時(shí), 換行展示

2.ServiceLoader<S>類實(shí)現(xiàn)了Iterable<S>接口, 以便于遍歷某接口下的所有實(shí)現(xiàn)類

3.ServiceLoader<S>類通過(guò)ClassLoader來(lái)讀取classpath下META-INF/services/目錄的文件:
默認(rèn)使用"Thread.currentThread().getContextClassLoader()"來(lái)加載, 也可指定其他類加載器

4.ServiceLoader<S>類的私有內(nèi)部類LazyIterator實(shí)現(xiàn)了Iterable<S>接口,功能 & 要求如下:
4.1支持懶加載機(jī)制(可通過(guò)某實(shí)現(xiàn)類中添加'靜態(tài)代碼塊', 該實(shí)現(xiàn)類不配置到META-INF/services文件中來(lái)驗(yàn)證)
4.2由于在其遍歷時(shí),通過(guò)反射new了實(shí)現(xiàn)類, 因此接口實(shí)現(xiàn)類必須要有空參構(gòu)造器, 否則加載失敗

5.Java SPI 實(shí)際上是“基于接口的編程＋策略模式＋配置文件”組合實(shí)現(xiàn)的動(dòng)態(tài)加載機(jī)制择克。

JAVA-SPI機(jī)制.png

ServiceLoader--部分源碼.png

JDK-SPI示例結(jié)構(gòu).png

jdk-SPI.png

package com.zy.netty.spi;

/**
 * jdk的spi機(jī)制
 */
public interface SpiService {
    void sayHello(String name);
}

package com.zy.netty.spi;

public class SpiChineseServiceImpl implements SpiService {
    @Override
    public void sayHello(String name) {
        System.out.println(name + ", 你好啊!");
    }
}

package com.zy.netty.spi;

public class SpiEnglishServiceImpl implements SpiService {
    @Override
    public void sayHello(String name) {
        System.out.println(name + ", hello!");
    }
}

在src/main/resources 下創(chuàng)建META-INF/services/目錄,然后新建文件:
文件名為接口的全限定名,接口中的內(nèi)容按行分開(kāi),每一行是實(shí)現(xiàn)類的全限定名

SPI-META-INF配置.png

@Test
public void fn03() {
   ServiceLoader<SpiService> loader = ServiceLoader.load(SpiService.class);
     Iterator<SpiService> it = loader.iterator();
     while (it.hasNext()) {
         it.next().sayHello("tom");
   }
}

3.dubbo中的SPI機(jī)制

http://dubbo.apache.org/zh-cn/docs/source_code_guide/dubbo-spi.html
http://dubbo.apache.org/zh-cn/docs/dev/SPI.html
http://www.reibang.com/p/764cec6ebb3d (Dubbo SPI重點(diǎn)參考)

3.1基本要求

1.定義一個(gè)接口, 接口必須加 '@SPI'注解, 否則報(bào)錯(cuò)
1.1由于通過(guò)反射new了實(shí)現(xiàn)類, 因此接口實(shí)現(xiàn)類必須要有空參構(gòu)造器, 否則加載失敗

2.配置文件要求
2.1必須在classpath下, 即resources目錄下建立目錄, 目錄名分三類
2.2以接口全限定名為文件名, 實(shí)現(xiàn)類全限定名寫在對(duì)應(yīng)接口文件中(k-v結(jié)構(gòu)), 多個(gè)實(shí)現(xiàn)類時(shí), 換行展示

3.ExtensionLoader通過(guò)ClassLoader加載目錄

Dubbo-SPI部分源碼.png

ExtensionLoader加載目錄.png

ExtensionLoader通過(guò)ClassLoader加載目錄.png

使用示例

dubbo提供了多種通信協(xié)議類型, 如dubbo類型, http類型, hessian類型等
若想在項(xiàng)目中使用其中一種類型, 可行的配置如下圖所示

Dubbo-Protocol.png

項(xiàng)目中配置Dubbo-Protocol的類型.png

3.2 Dubbo SPI 擴(kuò)展實(shí)現(xiàn)

http://dubbo.apache.org/zh-cn/docs/dev/impls/filter.html

Dubbo SPI 擴(kuò)展實(shí)現(xiàn).png

引入下述依賴后, 即可看到相關(guān)擴(kuò)展實(shí)現(xiàn)類

<dependency>
    <groupId>org.apache.dubbo</groupId>
    <artifactId>dubbo</artifactId>
    <version>2.7.3</version>
</dependency>

原生SPI擴(kuò)展實(shí)現(xiàn)類.png

3.3 @Activate

3.3.1 @Activate 源碼示例 org.apache.dubbo.rpc.Filter

http://www.reibang.com/p/f390bb88574d

關(guān)于激活的過(guò)濾器：
都需要在擴(kuò)展類的配置文件中標(biāo)識(shí) 過(guò)濾器名=xxx.xxx.xxx.xxxFilter
1.默認(rèn)過(guò)濾器
>> 需要被@Activate標(biāo)識(shí)
>> 如果需要在服務(wù)暴露時(shí)裝載，那么group="provider"
>> 如果需要在服務(wù)引用的時(shí)候裝載前普，那么group="consumer"
>> 如果想被暴露和引用時(shí)同時(shí)被裝載肚邢，那么group={"consumer", "provider"}
>> 如果需要url中有某個(gè)特定的值才被加載，那么value={"token", "bb"}
那么就需要配置一個(gè)token, value數(shù)組與URL中的某一個(gè)屬性相同就行了
2.普通自定義過(guò)濾器
>> 需要配置在url上 比如
過(guò)濾器擴(kuò)展類上可以有@Activate也可以沒(méi)有（自定義的就不要加了）
3.去掉某個(gè)過(guò)濾器
在filter屬性上使用-號(hào)標(biāo)識(shí)需要去掉的過(guò)濾器 比如:
registry://192.168.1.7:9090/org.apache.dubbo.service1?server.filter=-defalut,value1 去掉默認(rèn)的拭卿，添加value1
registry://192.168.1.7:9090/org.apache.dubbo.service1?server.filter=value1,-value2 去掉value2骡湖，添加value1

dubbo filter官網(wǎng)
http://dubbo.apache.org/zh-cn/docs/dev/impls/filter.html

將dubbo中filter聚合的wrapper

org.apache.dubbo.rpc.protocol.ProtocolFilterWrapper
該類實(shí)現(xiàn)了程序啟動(dòng)時(shí), 將所有filter搞成一個(gè)鏈表, 然后調(diào)用時(shí)候, 依次調(diào)用.

Dubbo 自定義一個(gè) Filter

Dubbo 自定義一個(gè) Filter.png

3.3.2 @Activate 源碼分析

3.3.3 @Activate小demo

demo結(jié)構(gòu)及接口層實(shí)現(xiàn).png

IActivate接口實(shí)現(xiàn)類.png

test

package com.zy.activate;

import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.extension.ExtensionLoader;
import org.junit.Test;
import java.util.List;

/**
 * 參考鏈接
 * http://www.reibang.com/p/bc523348f519
 *
 * @Activate 適用場(chǎng)景
 *  主要用在filter上，有的 filter 需要在 provider 邊需要加的记劈，有的需要在 consumer 邊需要加的勺鸦，
 *  根據(jù)URL中的參數(shù)指定，當(dāng)前的環(huán)境是 provider 還是 consumer目木，運(yùn)行時(shí)決定哪些 filter 需要被引入執(zhí)行换途。
 *
 */
public class ActivateTest {

    /**
     * @Activate 注解中聲明一個(gè) group
     */
    @Test
    public void fn01() {
        ExtensionLoader<IActivate> loader = ExtensionLoader.getExtensionLoader(IActivate.class);
        URL url = URL.valueOf("activate://127.0.0.1/activate");
        // 查詢 group 為 default_group 的 IActivate 的實(shí)現(xiàn)
        List<IActivate> list = loader.getActivateExtension(url, new String[]{}, "default_group");
        list.forEach(e -> System.out.println(e.getClass()));
    }

    /**
     * @Activate 注解中聲明多個(gè) group
     */
    @Test
    public void fn02() {
        ExtensionLoader<IActivate> loader = ExtensionLoader.getExtensionLoader(IActivate.class);
        URL url = URL.valueOf("activate://127.0.0.1/activate");
        // 查詢 group 為 group01 的 IActivate 的實(shí)現(xiàn)
        List<IActivate> list = loader.getActivateExtension(url, new String[]{}, "group01");
        list.forEach(e -> System.out.println(e.getClass()));
    }

    /**
     * @Activate 注解中聲明了 group 與 value
     */
    @Test
    public void fn03() {
        ExtensionLoader<IActivate> loader = ExtensionLoader.getExtensionLoader(IActivate.class);
        URL url = URL.valueOf("activate://127.0.0.1/activate");
        // 根據(jù) key = v1, group = value
        // @Activate(value = {"v1"}, group = {"value_group"}) 來(lái)激活擴(kuò)展
        // com.zy.activate.ValueActivate
        // 這里有個(gè)坑, url 被重新賦值了
        url = url.addParameter("v1", "value_group");
        // 查詢 value 為 v1, group 為 value_group 的 IActivate 的實(shí)現(xiàn)
        List<IActivate> list = loader.getActivateExtension(url, new String[]{}, "value_group");
        list.forEach(e -> System.out.println(e.getClass()));
    }

    /**
     * @Activate 注解中聲明了 order, 低的排序優(yōu)先級(jí)高
     */
    @Test
    public void fn04() {
        ExtensionLoader<IActivate> loader = ExtensionLoader.getExtensionLoader(IActivate.class);
        URL url = URL.valueOf("activate://127.0.0.1/activate");
        List<IActivate> list = loader.getActivateExtension(url, new String[]{}, "group_by_order");
        // 查詢 group 為 group_by_order, 并且有 order 排序的 IActivate 的實(shí)現(xiàn)
        list.forEach(e -> System.out.println(e.getClass()));
    }

}

classpath下文件: com.zy.activate.IActivate

group=com.zy.activate.GroupActivate
order01=com.zy.activate.OrderActivate01
order02=com.zy.activate.OrderActivate02
value=com.zy.activate.ValueActivate
com.zy.activate.DefaultActivate

3.4 @Adaptive

自適應(yīng)擴(kuò)展點(diǎn)注解。
adaptive設(shè)計(jì)的目的是為了識(shí)別固定已知類和擴(kuò)展未知類刽射。

在實(shí)際應(yīng)用場(chǎng)景中军拟，一個(gè)擴(kuò)展接口往往會(huì)有多種實(shí)現(xiàn)類，而Dubbo是基于URL驅(qū)動(dòng)誓禁，
所以在運(yùn)行時(shí)懈息，通過(guò)傳入U(xiǎn)RL中的某些參數(shù)來(lái)動(dòng)態(tài)控制具體實(shí)現(xiàn)，這便是Dubbo的擴(kuò)展點(diǎn)自適應(yīng)特性摹恰。
URL來(lái)自于 ReferenceConfig, ConsumerConfig等各種config, 即yml或XML中的producer或consumer的各種配置.

在Dubbo中辫继，@Adaptive一般用來(lái)修飾類和接口方法怒见，在整個(gè)Dubbo框架中，
只有AdaptiveExtensionFactory和AdaptiveCompiler使用在類級(jí)別上,
其余都標(biāo)注在方法上姑宽。

3.4.1 修飾方法級(jí)別

當(dāng)擴(kuò)展點(diǎn)的方法被@Adaptive修飾時(shí)遣耍，
在Dubbo初始化擴(kuò)展點(diǎn)時(shí)會(huì)自動(dòng)生成和編譯一個(gè)動(dòng)態(tài)的Adaptive類。

含有@Adaptive的方法中都可以根據(jù)方法參數(shù)動(dòng)態(tài)獲取各自需要真實(shí)的擴(kuò)展點(diǎn)炮车。
它主要是用于SPI咸产，因?yàn)閟pi的類是不固定巾腕、未知的擴(kuò)展類矩屁，所以設(shè)計(jì)了動(dòng)態(tài)$Adaptive類遍膜；
ExtensionLoader.getAdaptiveExtension方法會(huì)返回動(dòng)態(tài)編譯生成的$Adaptive

例如： 
Protocol的spi類有injvm、dubbo扛或、registry绵咱、filter、listener等很多未知擴(kuò)展類告喊，
ExtensionLoader.getAdaptiveExtension會(huì)動(dòng)態(tài)編譯Protocol$Adaptive的類麸拄，
再通過(guò)在動(dòng)態(tài)累的方法中調(diào)用ExtensionLoader.getExtensionLoader(Protocol.class).getExtension(spi類);來(lái)提取對(duì)象派昧。

以Protocol接口為例

package org.apache.dubbo.rpc;

import org.apache.dubbo.common.URL;
import org.apache.dubbo.common.extension.Adaptive;
import org.apache.dubbo.common.extension.SPI;

@SPI("dubbo")
public interface Protocol {
    int getDefaultPort();
    @Adaptive
    <T> Exporter<T> export(Invoker<T> invoker) throws RpcException;
    @Adaptive
    <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException;
    void destroy();
}

export 和 refer 兩個(gè)方法被 @Adaptive 注解修飾
Dubbo在初始化擴(kuò)展點(diǎn)時(shí)(即provider或consumer向注冊(cè)中心注冊(cè)黔姜，會(huì)生成一個(gè)Protocol$Adaptive類，
該動(dòng)態(tài)代理類會(huì)實(shí)現(xiàn)這兩個(gè)方法蒂萎，方法里會(huì)有一些抽象的通用邏輯秆吵，
根據(jù)解析URL得到的信息，找到并調(diào)用真正的實(shí)現(xiàn)類五慈。
生成的代碼如下：

package org.apache.dubbo.rpc;
import org.apache.dubbo.common.extension.ExtensionLoader;
public class Protocol$Adaptive implements org.apache.dubbo.rpc.Protocol {
    public void destroy()  {
        throw new UnsupportedOperationException("The method public abstract void org.apache.dubbo.rpc.Protocol.destroy() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!");
    }
    
    public int getDefaultPort()  {
        throw new UnsupportedOperationException("The method public abstract int org.apache.dubbo.rpc.Protocol.getDefaultPort() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!");
    }
    
    public org.apache.dubbo.rpc.Exporter export(org.apache.dubbo.rpc.Invoker arg0) throws org.apache.dubbo.rpc.RpcException {
        if (arg0 == null) 
            throw new IllegalArgumentException("org.apache.dubbo.rpc.Invoker argument == null");
        if (arg0.getUrl() == null) 
            throw new IllegalArgumentException("org.apache.dubbo.rpc.Invoker argument getUrl() == null");
        org.apache.dubbo.common.URL url = arg0.getUrl();
        String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );
        if(extName == null) 
            throw new IllegalStateException("Failed to get extension (org.apache.dubbo.rpc.Protocol) name from url (" + url.toString() + ") use keys([protocol])");
        org.apache.dubbo.rpc.Protocol extension = (org.apache.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);
        return extension.export(arg0);
    }
    
    public org.apache.dubbo.rpc.Invoker refer(java.lang.Class arg0, org.apache.dubbo.common.URL arg1) throws org.apache.dubbo.rpc.RpcException {
        if (arg1 == null) 
            throw new IllegalArgumentException("url == null");
        org.apache.dubbo.common.URL url = arg1;
        String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );
        if(extName == null) 
            throw new IllegalStateException("Failed to get extension (org.apache.dubbo.rpc.Protocol) name from url (" + url.toString() + ") use keys([protocol])");
        org.apache.dubbo.rpc.Protocol extension = (org.apache.dubbo.rpc.Protocol)ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);
        return extension.refer(arg0, arg1);
    }
}

Protocol$Adaptive.png

解釋下上述生成的export(org.apache.dubbo.rpc.Invoker arg0)方法

1.String extName = ( url.getProtocol() == null ? "dubbo" : url.getProtocol() );
從arg0中解析出擴(kuò)展點(diǎn)名稱extName纳寂，extName的默認(rèn)值為@SPI的value。
這是adaptive的精髓：每一個(gè)方法都可以根據(jù)方法參數(shù)動(dòng)態(tài)獲取各自需要的擴(kuò)展點(diǎn)泻拦。

2.Protocol extension = (Protocol)ExtensionLoader.getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);
根據(jù)extName重新獲取指定的Protocol.class擴(kuò)展點(diǎn)毙芜。
如果所有擴(kuò)展點(diǎn)中含有Wrapper（listener,fiter）則ExtensionLoader.getExtension()
會(huì)將真正的實(shí)現(xiàn)類通過(guò) Wrapper（listener,fiter）包裝后返回。
如
>> ProtocolListenerWrapper
>> ProtocolFilterWrapper
>> QosProtocolWrapper
>> StubProxyFactoryWrapper

3.extension.export(arg0)
執(zhí)行目標(biāo)類的目標(biāo)方法

3.4.2 修飾類級(jí)別

以AdaptiveCompiler類為例争拐，它作為Compiler擴(kuò)展點(diǎn)的實(shí)現(xiàn)類腋粥，被@Adaptive在類級(jí)別修飾。

在類所在工程的resource/META-INF/dubbo/internal路徑下可以找到擴(kuò)展點(diǎn)配置文件:
org.apache.dubbo.common.compiler.Compiler

這樣在Dubbo加載擴(kuò)展點(diǎn)時(shí)便可以根據(jù)adaptive屬性找到AdaptiveComiler實(shí)現(xiàn)類架曹，
再通過(guò)compiler方法決定是調(diào)用默認(rèn)實(shí)現(xiàn)隘冲，還是指定的實(shí)現(xiàn)，默認(rèn)實(shí)現(xiàn)由擴(kuò)展點(diǎn)接口上的@SPI注解指定绑雄。
此處: 
@SPI("javassist")
public interface Compiler { ... }

對(duì)比方法級(jí)別展辞，類級(jí)別省略了生成動(dòng)態(tài)代理類的過(guò)程，由指定類決定具體實(shí)現(xiàn)万牺，
另外對(duì)于同一個(gè)擴(kuò)展點(diǎn)罗珍，類級(jí)別的Adaptive只能有一個(gè)洽腺。

// 1. 為什么AdaptiveCompiler這個(gè)類是固定已知的？
因?yàn)檎麄€(gè)框架僅支持Javassist和JdkCompiler覆旱；
// 2. 為什么AdaptiveExtensionFactory這個(gè)類是固定已知的已脓？
因?yàn)檎麄€(gè)框架僅支持2個(gè)objFactory,一個(gè)是spi,另一個(gè)是spring；
ExtensionLoader.getAdaptiveExtension方法會(huì)直接返回這個(gè)類的實(shí)例

4.Spring中的SPI機(jī)制

Spring-SPI部分源碼.png

關(guān)于何時(shí)加載classpath下的spring.factories文件, 參考下文
http://www.reibang.com/p/5d5890645165

參考資源
http://www.reibang.com/p/08b41189eb4c (dubbo-spi)
http://www.reibang.com/p/0d196ad23915 (spring-spi)
https://www.cnblogs.com/leeego-123/p/10906674.html
https://blog.csdn.net/vbirdbest/article/details/79863883
http://www.reibang.com/p/bc523348f519 (@Activate擴(kuò)展)
https://www.cnblogs.com/qiaozhuangshi/p/11007032.html (@Activate擴(kuò)展)
http://www.reibang.com/p/7e116f480165 (@Activate擴(kuò)展示例)
https://blog.csdn.net/qq_30051265/article/details/82776395 (Dubbo 中的 filter)
https://blog.csdn.net/u011212394/article/details/102762197 (@Adaptiv)