支持新协议

学习如何添加一个新协议到bRPC。

server端多协议

brpc server一个端口支持多种协议，大部分时候这对部署和运维更加方便。由于不同协议的格式大相径庭，严格地来说，一个端口很难无二义地支持所有协议。出于解耦和可扩展性的考虑，也不太可能集中式地构建一个针对所有协议的分类器。我们的做法就是把协议归三类后逐个尝试：

  • 第一类协议：标记或特殊字符在最前面，比如baidu_std，hulu_pbrpc的前4个字符分别是PRPC和HULU，解析代码只需要检查前4个字节就可以知道协议是否匹配，最先尝试这类协议。这些协议在同一个连接上也可以共存。
  • 第二类协议：有较为复杂的语法，没有固定的协议标记或特殊字符，可能在解析一段输入后才能判断是否匹配，目前此类协议只有http。
  • 第三类协议：协议标记或特殊字符在中间，比如nshead的magic_num在第25-28字节。由于之前的字段均为二进制，难以判断正确性，在没有读取完28字节前，我们无法判定消息是不是nshead格式的，所以处理起来很麻烦，若其解析排在http之前，那么<=28字节的http消息便可能无法被解析，因为程序以为是“还未完整的nshead消息”。

考虑到大多数链接上只会有一种协议，我们会记录前一次的协议选择结果，下次首先尝试。对于长连接，这几乎把甄别协议的开销降到了0；虽然短连接每次都得运行这段逻辑，但由于短连接的瓶颈也往往不在于此，这套方法仍旧是足够快的。在未来如果有大量的协议加入，我们可能得考虑一些更复杂的启发式的区分方法。

client端多协议

不像server端必须根据连接上的数据动态地判定协议，client端作为发起端，自然清楚自己的协议格式，只要某种协议只通过连接池或短链接发送，即独占那个连接，那么它可以是任意复杂（或糟糕的）格式。因为client端发出时会记录所用的协议，等到response回来时直接调用对应的解析函数，没有任何甄别代价。像memcache，redis这类协议中基本没有magic number，在server端较难和其他协议区分开，但让client端支持却没什么问题。

支持新协议

brpc就是设计为可随时扩展新协议的，步骤如下：

以nshead开头的协议有统一支持，看这里。

增加ProtocolType

在options.proto的ProtocolType中增加新协议类型，如果你需要的话可以联系我们增加，以确保不会和其他人的需求重合。

目前的ProtocolType（18年中）:

  1. enum ProtocolType {
  2.     PROTOCOL_UNKNOWN = 0;
  3.     PROTOCOL_BAIDU_STD = 1;
  4.     PROTOCOL_STREAMING_RPC = 2;
  5.     PROTOCOL_HULU_PBRPC = 3;
  6.     PROTOCOL_SOFA_PBRPC = 4;
  7.     PROTOCOL_RTMP = 5;
  8.     PROTOCOL_HTTP = 6;
  9.     PROTOCOL_PUBLIC_PBRPC = 7;
  10.     PROTOCOL_NOVA_PBRPC = 8;
  11.     PROTOCOL_NSHEAD_CLIENT = 9;        // implemented in brpc-ub
  12.     PROTOCOL_NSHEAD = 10;
  13.     PROTOCOL_HADOOP_RPC = 11;
  14.     PROTOCOL_HADOOP_SERVER_RPC = 12;
  15.     PROTOCOL_MONGO = 13;               // server side only
  16.     PROTOCOL_UBRPC_COMPACK = 14;
  17.     PROTOCOL_DIDX_CLIENT = 15;         // Client side only
  18.     PROTOCOL_REDIS = 16;               // Client side only
  19.     PROTOCOL_MEMCACHE = 17;            // Client side only
  20.     PROTOCOL_ITP = 18;
  21.     PROTOCOL_NSHEAD_MCPACK = 19;
  22.     PROTOCOL_DISP_IDL = 20;            // Client side only
  23.     PROTOCOL_ERSDA_CLIENT = 21;        // Client side only
  24.     PROTOCOL_UBRPC_MCPACK2 = 22;       // Client side only
  25.     // Reserve special protocol for cds-agent, which depends on FIFO right now
  26.     PROTOCOL_CDS_AGENT = 23;           // Client side only
  27.     PROTOCOL_ESP = 24;                 // Client side only
  28.     PROTOCOL_THRIFT = 25;              // Server side only
  29. }

实现回调

均定义在struct Protocol中，该结构定义在protocol.h。其中的parse必须实现，除此之外server端至少要实现process_request，client端至少要实现serialize_request，pack_request，process_response。

实现协议回调还是比较困难的，这块的代码不会像供普通用户使用的那样，有较好的提示和保护，你得先靠自己搞清楚其他协议中的类似代码，然后再动手，最后发给我们做code review。

parse

  1. typedef ParseResult (*Parse)(butil::IOBuf* source, Socket *socket, bool read_eof, const void *arg);

用于把消息从source上切割下来，client端和server端使用同一个parse函数。返回的消息会被递给process_request(server端)或process_response(client端)。

参数：source是读取到的二进制内容，socket是对应的连接，read_eof为true表示连接已被对端关闭，arg在server端是对应server的指针，在client端是NULL。

ParseResult可能是错误，也可能包含一个切割下来的message，可能的值有：

  • PARSE_ERROR_TRY_OTHERS ：不是这个协议，框架会尝试下一个协议。source不能被消费。
  • PARSE_ERROR_NOT_ENOUGH_DATA : 到目前为止数据内容不违反协议，但不构成完整的消息。等到连接上有新数据时，新数据会被append入source并重新调用parse。如果不确定数据是否一定属于这个协议，source不应被消费，如果确定数据属于这个协议，也可以把source的内容转移到内部的状态中去。比如http协议解析中即使source不包含一个完整的http消息，它也会被http parser消费掉，以避免下一次重复解析。
  • PARSE_ERROR_TOO_BIG_DATA : 消息太大，拒绝掉以保护server，连接会被关闭。
  • PARSE_ERROR_NO_RESOURCE : 内部错误，比如资源分配失败。连接会被关闭。
  • PARSE_ERROR_ABSOLUTELY_WRONG : 应该是这个协议（比如magic number匹配了），但是格式不符合预期。连接会被关闭。

serialize_request

  1. typedef bool (*SerializeRequest)(butil::IOBuf* request_buf,
  2.                                  Controller* cntl,
  3.                                  const google::protobuf::Message* request);

把request序列化进request_buf，client端必须实现。发生在pack_request之前，一次RPC中只会调用一次。cntl包含某些协议（比如http）需要的信息。成功返回true，否则false。

pack_request

  1. typedef int (*PackRequest)(butil::IOBuf* msg, 
  2.                            uint64_t correlation_id,
  3.                            const google::protobuf::MethodDescriptor* method,
  4.                            Controller* controller,
  5.                            const butil::IOBuf& request_buf,
  6.                            const Authenticator* auth);

把request_buf打包入msg，每次向server发送消息前（包括重试）都会调用。当auth不为空时，需要打包认证信息。成功返回0，否则-1。

process_request

  1. typedef void (*ProcessRequest)(InputMessageBase* msg_base);

处理server端parse返回的消息，server端必须实现。可能会在和parse()不同的线程中运行。多个process_request可能同时运行。

在r34386后必须在处理结束时调用msg_base->Destroy()，为了防止漏调，考虑使用DestroyingPtr<>。

process_response

  1. typedef void (*ProcessResponse)(InputMessageBase* msg_base);

处理client端parse返回的消息，client端必须实现。可能会在和parse()不同的线程中运行。多个process_response可能同时运行。

在r34386后必须在处理结束时调用msg_base->Destroy()，为了防止漏调，考虑使用DestroyingPtr<>。

verify

  1. typedef bool (*Verify)(const InputMessageBase* msg);

处理连接的认证，只会对连接上的第一个消息调用，需要支持认证的server端必须实现，不需要认证或仅支持client端的协议可填NULL。成功返回true，否则false。

parse_server_address

  1. typedef bool (*ParseServerAddress)(butil::EndPoint* out, const char* server_addr_and_port);

把server_addr_and_port(Channel.Init的一个参数)转化为butil::EndPoint，可选。一些协议对server地址的表达和理解可能是不同的。

get_method_name

  1. typedef const std::string& (*GetMethodName)(const google::protobuf::MethodDescriptor* method,
  2.                                             const Controller*);

定制method name，可选。

supported_connection_type

标记支持的连接方式。如果支持所有连接方式，设为CONNECTION_TYPE_ALL。如果只支持连接池和短连接，设为CONNECTION_TYPE_POOLED_AND_SHORT。

name

协议的名称，会出现在各种配置和显示中，越简短越好，必须是字符串常量。

注册到全局

实现好的协议要调用RegisterProtocol注册到全局，以便brpc发现。就像这样：

  1. Protocol http_protocol = { ParseHttpMessage,
  2.                            SerializeHttpRequest, PackHttpRequest,
  3.                            ProcessHttpRequest, ProcessHttpResponse,
  4.                            VerifyHttpRequest, ParseHttpServerAddress,
  5.                            GetHttpMethodName,
  6.                            CONNECTION_TYPE_POOLED_AND_SHORT,
  7.                            "http" };
  8. if (RegisterProtocol(PROTOCOL_HTTP, http_protocol) != 0) {
  9.     exit(1);
  10. }

修改于 2023年8月2日: Release bRPC 1.6.0 (#155) (346a029)