C / C++ / 系统课时

接入 Protobuf 消息序列化

接入 Protobuf 消息序列化

本节把 RPC 请求从手写字符串负载升级为 Protobuf 强类型消息。最终会用 .proto 定义请求与响应,通过 Any 携带具体消息类型,并分别识别网络数据损坏、路由不匹配和消息类型不匹配。

学习目标

  • 用 .proto 定义 RPC 信封与业务消息,并生成 C++ 类型。
  • 完成 Protobuf 消息的打包、序列化、解析与反序列化。
  • 区分线格式解析失败和业务消息类型不匹配。

定义消息契约

仅把业务对象直接序列化成字节还不够,服务端还需要知道这些字节属于哪个服务、哪个方法、哪种消息。一个简洁做法是让外层 RpcRequest 保存路由信息,用 google.protobuf.Any 保存具体业务消息。

proto
syntax = "proto3";

package demo;

import "google/protobuf/any.proto";

message EchoRequest {
  string text = 1;
}

message EchoResponse {
  string text = 1;
}

message RpcRequest {
  string service = 1;
  string method = 2;
  google.protobuf.Any payload = 3;
}

message RpcResponse {
  bool ok = 1;
  string error = 2;
  google.protobuf.Any payload = 3;
}

Any 会同时保存序列化后的消息和类型标识。验证这份定义时,先用 protoc 生成 C++ 代码:

bash
protoc --cpp_out=. rpc.proto

预期结果:

text
<PATH>/rpc.pb.h
<PATH>/rpc.pb.cc

实际 <PATH> 取决于执行命令时所在目录。生成成功后,业务代码通过 rpc.pb.h 使用这些强类型消息。

串起序列化与反序列化

下面的完整示例假设已经生成 rpc.pb.h 和 rpc.pb.cc。handleEcho 先解析外层信封,再校验路由,最后用 UnpackTo 验证内部消息类型。

cpp
#include <iostream>
#include <string>

#include "rpc.pb.h"

std::string handleEcho(const std::string& wire) {
    demo::RpcRequest envelope;

    // 第一道检查只负责判断字节流是否是合法的 RpcRequest 线格式。
    if (!envelope.ParseFromString(wire)) {
        return "PARSE_ERROR";
    }

    if (envelope.service() != "EchoService" ||
        envelope.method() != "Echo") {
        return "METHOD_MISMATCH";
    }

    demo::EchoRequest request;
    // Any::UnpackTo 会同时检查类型标识并完成反序列化。
    if (!envelope.payload().UnpackTo(&request)) {
        return "TYPE_MISMATCH";
    }

    return "OK:" + request.text();
}

int main() {
    demo::EchoRequest request;
    request.set_text("hello");

    demo::RpcRequest envelope;
    envelope.set_service("EchoService");
    envelope.set_method("Echo");
    envelope.mutable_payload()->PackFrom(request);

    std::string wire;
    envelope.SerializeToString(&wire);
    std::cout << handleEcho(wire) << '\\n';

    std::cout << handleEcho(std::string(1, static_cast<char>(0xFF))) << '\\n';

    demo::EchoResponse wrongMessage;
    wrongMessage.set_text("wrong type");

    demo::RpcRequest wrongEnvelope;
    wrongEnvelope.set_service("EchoService");
    wrongEnvelope.set_method("Echo");
    wrongEnvelope.mutable_payload()->PackFrom(wrongMessage);

    std::string wrongWire;
    wrongEnvelope.SerializeToString(&wrongWire);
    std::cout << handleEcho(wrongWire) << '\\n';
}

在支持 pkg-config 且已安装 Protobuf C++ 开发库的环境中,可这样编译并运行:

bash
g++ -std=c++17 main.cpp rpc.pb.cc $(pkg-config --cflags --libs protobuf) -pthread -o rpc_demo && ./rpc_demo

预期输出:

text
OK:hello
PARSE_ERROR
TYPE_MISMATCH

不同平台的 Protobuf 头文件和链接参数可能不同,但程序逻辑不依赖这些构建细节。

看清三类失败位置

Protobuf RPC 序列化与失败分支

ParseFromString 失败,说明外层字节连合法的 Protobuf 消息都无法构成;路由不匹配,说明请求到了当前处理器却指向别的方法;UnpackTo 失败,则说明外层信封合法,但内部 Any 不是期望的业务类型。

因此,RPC 框架必须在路由层确定“这个方法期望哪种请求类型”,再由生成代码或适配层执行类型检查。Any 是一种直观实现,但生产框架也可以用方法描述符维护这层映射,避免在每个请求中携带完整类型 URL。

放到 RPC 分发层里的位置

推荐把 Protobuf 放在“路由命中之后、业务函数之前”。注册表先根据 service 和 method 找到目标方法,适配层再把 payload 解成该方法声明的请求类型;业务函数返回强类型响应后,再序列化回 RpcResponse。

这样职责边界很清楚:网络层只收发字节,协议层只负责消息编解码,注册表只负责找方法,业务层只处理强类型对象。消息格式变化时,通常只需要调整 .proto 和适配代码,不必重写底层连接与分发逻辑。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

接入 Protobuf 消息序列化

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通