Protocol

本文讲解如何通过扩展 org.apache.dubbo.rpc.Protocol SPI，提供自定义的 RPC 协议实现。

在 通信协议 一章中，我们了解了 Dubbo 内置的几个核心 RPC 协议 dubbo、rest、和tri 以及它们的使用方式。本文讲解如何通过扩展 org.apache.dubbo.rpc.Protocol SPI，提供自定义的 RPC 协议实现。

自定义一套私有协议有两种方式，第一种是对原有的协议进行包装，添加一些特定的业务逻辑。另外一种是完全自定义一套协议。前者实现简单，在dubbo中也是有广泛的使用，比如：ProtocolFilterWrapper, QosProtocolWrapper, ProtocolListenerWrapper等。后者实现相对复杂，但却具有最大的灵活性，比如 Dubbo 框架内置的协议 dubbo、triple 协议都可以算作这种实现方式。

本示例的完整源码请参见 dubbo-samples-extensibility。除了本示例之外，Dubbo 核心仓库 apache/dubbo 以及扩展库 apache/dubbo-spi-extensions 中的众多 Protocol 实现，都可以作为扩展参考实现：

# Dubbo对外支持的常用协议
dubbo=org.apache.dubbo.rpc.protocol.dubbo.DubboProtocol
tri=org.apache.dubbo.rpc.protocol.tri.TripleProtocol

任务详情

基于现有的dubbo协议来实现自定义协议edubbo。

实现方式

通过对dubbo协议进行包装来实现edubbo协议。

代码结构

Common
src
 |-main
    |-java
        |-org
            |-apache
                |-dubbo
                    |-samples
                        |-extensibility
                            |-protocol
                                |-common
                                    |-EnhancedProtocol.java (实现Protocol接口)
Provider
src
 |-main
    |-java
        |-org
            |-apache
                |-dubbo
                    |-samples
                        |-extensibility
                            |-protocol
                                |-provider
                                    |-ExtensibilityProtocolProviderApplication.java
                                    |-ExtensibilityProtocolServiceImpl.java
    |-resources
        |-META-INF
            |-application.properties (Dubbo Provider配置文件)
            |-dubbo
                |-org.apache.dubbo.rpc.Protocol (纯文本文件)
Consumer
src
 |-main
    |-java
        |-org
            |-apache
                |-dubbo
                    |-samples
                        |-extensibility
                            |-protocol
                                |-consumer
                                    |-ExtensibilityProtocolConsumerApplication.java
                                    |-ExtensibilityProtocolConsumerTask.java
    |-resources
        |-META-INF
            |-application.properties (Dubbo Consumer配置文件)
            |-dubbo
                |-org.apache.dubbo.rpc.Protocol (纯文本文件)

代码详情

package org.apache.dubbo.samples.extensibility.protocol.common;

import org.apache.dubbo.common.URL;
import org.apache.dubbo.rpc.Protocol;
import org.apache.dubbo.rpc.Invoker;
import org.apache.dubbo.rpc.Exporter;
import org.apache.dubbo.rpc.ProtocolServer;
import org.apache.dubbo.rpc.RpcException;
import org.apache.dubbo.rpc.model.FrameworkModel;
import org.apache.dubbo.rpc.protocol.dubbo.DubboProtocol;

import java.util.List;

public class EnhancedProtocol implements Protocol {

    public EnhancedProtocol(FrameworkModel frameworkModel) {
        this.protocol = new DubboProtocol(frameworkModel);
    }

    private final Protocol protocol;

    @Override
    public int getDefaultPort() {
        return this.protocol.getDefaultPort();
    }

    @Override
    public <T> Exporter<T> export(Invoker<T> invoker) throws RpcException {
        // do something
        return this.protocol.export(invoker);
    }

    @Override
    public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
        // do something
        return this.protocol.refer(type, url);
    }

    @Override
    public void destroy() {
        this.protocol.destroy();
    }

    @Override
    public List<ProtocolServer> getServers() {
        return protocol.getServers();
    }
}

SPI配置

Provider

在resources/META-INF/dubbo/org.apache.dubbo.rpc.Protocol文件中添加如下配置：

edubbo=org.apache.dubbo.samples.extensibility.protocol.common.EnhancedProtocol
Consumer

在resources/META-INF/dubbo/org.apache.dubbo.rpc.Protocol文件中添加如下配置：

edubbo=org.apache.dubbo.samples.extensibility.protocol.common.EnhancedProtocol

配置文件

Provider

在resources/application.properties文件中添加如下配置：

# 自定义协议
dubbo.provider.protocol=edubbo
Consumer

在resources/application.properties文件中添加如下配置：

# 自定义协议
dubbo.consumer.protocol=edubbo

运行结果

以使用本地IDE的方式来运行任务，结果如下：

注册协议

dubbo-samples-extensibility-protocol-output2.jpg

输出结果

dubbo-samples-extensibility-protocol-output1.png

最后修改 September 13, 2024: Refactor website structure (#2860) (1a4b998f54)