Dubbo插件擴展機制(@Adaptive)

一   dubbo插件機制和java原生的spi區別           

JDK SPI：

JDK 標准的 SPI 會一次性加載所有的擴展實現，如果有的擴展很耗時，但也沒用上，很浪費資源。所以只希望加載某個的實現，就不現實了

DUBBO SPI：

1、對 Dubbo 進行擴展，不需要改動 Dubbo 的源碼

2、延遲加載，可以一次只加載自己想要加載的擴展實現。

3、增加了對擴展點 IOC 和 AOP 的支持，一個擴展點可以直接 setter 注入其

它擴展點。

4、Dubbo 的擴展機制能很好的支持第三方 IoC 容器，默認支持 Spring Bean。

 

二   dubbo @Adaptive  　　

@Adaptive稱為自適應擴展點注解。

一個接口往往會有多種實現類，Dubbo通過URL中的某些參數來動態控制實現類的選擇，這便是Dubbo的擴展點自適應特性.一般用來修飾類和接口方法，類級別的修飾例如：daptiveExtensionFactory和AdaptiveCompiler，大部分在方法上。

(1) 修飾的方法(以dubbo 中的Protocol為列)

　　

@SPI("dubbo")
public interface Protocol {
    
    /**
     * 獲取缺省端口，當用戶沒有配置端口時使用。
     * 
     * @return 缺省端口
     */
    int getDefaultPort();

    /**
     * 暴露遠程服務：<br>
     * 1. 協議在接收請求時，應記錄請求來源方地址信息：RpcContext.getContext().setRemoteAddress();<br>
     * 2. export()必須是冪等的，也就是暴露同一個URL的Invoker兩次，和暴露一次沒有區別。<br>
     * 3. export()傳入的Invoker由框架實現並傳入，協議不需要關心。<br>
     * 
     * @param <T> 服務的類型
     * @param invoker 服務的執行體
     * @return exporter 暴露服務的引用，用於取消暴露
     * @throws RpcException 當暴露服務出錯時拋出，比如端口已占用
     */
    @Adaptive
    <T> Exporter<T> export(Invoker<T> invoker) throws RpcException;

    /**
     * 引用遠程服務：<br>
     * 1. 當用戶調用refer()所返回的Invoker對象的invoke()方法時，協議需相應執行同URL遠端export()傳入的Invoker對象的invoke()方法。<br>
     * 2. refer()返回的Invoker由協議實現，協議通常需要在此Invoker中發送遠程請求。<br>
     * 3. 當url中有設置check=false時，連接失敗不能拋出異常，並內部自動恢復。<br>
     * 
     * @param <T> 服務的類型
     * @param type 服務的類型
     * @param url 遠程服務的URL地址
     * @return invoker 服務的本地代理
     * @throws RpcException 當連接服務提供方失敗時拋出
     */
    @Adaptive
    <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException;

    /**
     * 釋放協議：<br>
     * 1. 取消該協議所有已經暴露和引用的服務。<br>
     * 2. 釋放協議所占用的所有資源，比如連接和端口。<br>
     * 3. 協議在釋放后，依然能暴露和引用新的服務。<br>
     */
    void destroy();

}

　　

export和refer方法都被@Adaptive修飾，Dubbo在初始化擴展點時，會生成一個Protocol$Adaptive類，里面會實現這兩個方法，生成的代碼如下

　　

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);
    }
}

 

    (2)  修飾類級別(以AdaptiveCompiler為列)

　　　　

@Adaptive
public class AdaptiveCompiler implements Compiler {

    private static volatile String DEFAULT_COMPILER;

    public static void setDefaultCompiler(String compiler) {
        DEFAULT_COMPILER = compiler;
    }

    @Override
    public Class<?> compile(String code, ClassLoader classLoader) {
        Compiler compiler;
        ExtensionLoader<Compiler> loader = ExtensionLoader.getExtensionLoader(Compiler.class);
        String name = DEFAULT_COMPILER; // copy reference
        if (name != null && name.length() > 0) {
            compiler = loader.getExtension(name);
        } else {
            compiler = loader.getDefaultExtension();
        }
        return compiler.compile(code, classLoader);
    }

}

 

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

　　

adaptive=com.alibaba.dubbo.common.compiler.support.AdaptiveCompiler
jdk=com.alibaba.dubbo.common.compiler.support.JdkCompiler
javassist=com.alibaba.dubbo.common.compiler.support.JavassistCompiler

這樣在Dubbo加載擴展點時便可以根據adaptive屬性找到AdaptiveComiler實現類，再通過compiler方法決定是調用默認實現，還是指定的實現，默認實現由擴展點接口上的@SPI注解指定。

@SPI("javassist")
public interface Compiler {

    /**
     * Compile java source code.
     *
     * @param code        Java source code
     * @param classLoader classloader
     * @return Compiled class
     */
    Class<?> compile(String code, ClassLoader classLoader);

}

三  demo演示

　　 (1)接口類Animal

　　　　

@SPI("dog")    // 默認的值狗
public interface Animal {
    // 接口的方法需要添加這個注解，在測試代碼中，參數至少要有一個URL類型的參數
    @Adaptive({"animalType"})    // 動物類型方式
    void eat(URL url);
}

   (2)實現類 Cat Dog

　　

public class Dog implements Animal {
    @Override
    public void eat(URL url) {
        System.out.println("hello  dog");
    }
}


public class Cat implements Animal {
    @Override
    public void eat(URL url) {
        System.out.println("hello cat");
    }
}

 (3)配置文件resource/META-INF/services/com.kc.spi.Animal

　　

dog = com.kc.spi.Dog
cat = com.kc.spi.Cat

(4)測試代碼

　　

    public static void main(String[] args) {
           ExtensionLoader<Animal> loader = ExtensionLoader.getExtensionLoader(Animal.class);        
           Animal animal = loader.getAdaptiveExtension();
           //默認加載dog  Aminal注解上指定dog在com.kc.spi.Animal指定的類
           animal.eat(URL.valueOf("http://localhost:9999/xxx"));                  
           animal.eat(URL.valueOf("http://localhost:9999/xxx?animalType=cat"));  
    }

 

(5)測試結果