好的，下面将详细介绍如何一步一步地创建文件并完成基于 gRPC 的 C++ 服务端和 Python 客户端之间的通信。我们将涵盖所有的关键点，包括 `.proto` 文件的编写、代码生成以及实际的实现。 --- ### Step 1: 准备环境 首先需要安装好以下工具： - **Protobuf Compiler (`protoc`)** 可以从 [Google's Protocol Buffers](https://github.com/protocolbuffers/protobuf/releases) 下载适合您系统的版本，并将其添加到 PATH 中。 - **gRPC-C++ 和其依赖项** 根据操作系统选择合适的安装方式，例如 Ubuntu 用户可以用 `apt-get install libgrpc++-dev protobuf-compiler-grpc` 来快速安装。 - **Python 的 gRPC 工具链** ```bash pip install grpcio grpcio-tools ``` 确保所有组件都已成功安装后再继续下一步。 --- ### Step 2: 创建项目的目录结构 为了便于组织代码，我们可以按照如下形式安排文件夹： ``` project/ │ ├── proto/ # 存放 .proto 文件的地方 │ └── hello_service.proto │ ├── cpp_server/ # C++ 服务端源码存放处 │ ├── build.sh # 构建脚本（可选） │ ├── greeter_impl.cpp # 主逻辑实现 │ └── CMakeLists.txt # cmake 配置文件 │ └── python_client/ # Python 客户端源码存放处 └── client.py # 调用服务端的功能模块 ``` 接下来开始逐层填充每个部分的内容。 --- ### Step 3: 编写 `.proto` 文件 在 `proto/` 目录下新建名为 `hello_service.proto` 的文本文件，并输入以下内容： ```protobuf // 指定语法为 Proto3 版本 syntax = "proto3"; option java_package = "com.example.tutorial"; option csharp_namespace = "GrpcGreeter"; package tutorial; // 包命名空间声明 service Greeter { rpc SayHello(HelloRequest) returns (HelloReply); // 声明远程调用方法 } message HelloRequest { string name = 1; // 参数字段：用户姓名 } message HelloReply { string message = 1; // 返回值字段：问候信息 } ``` 这个 `.proto` 文件定义了一个 RPC 接口——接收一个名字作为参数，并返回一条包含这个名字的消息字符串给调用者。 --- ### Step 4: 使用 `protoc` 自动生成存根代码 进入终端窗口切换至 `proto/` 文件所在的位置执行以下两条命令行指令分别为目标语言生成配套使用的类模板： #### （a）为 C++ 生产头文件和源文件： ```bash mkdir ../cpp_server/generated_files protoc --cpp_out=../cpp_server/generated_files ./hello_service.proto ``` 此时你会看到新产生的两个文件： - `tutorial.grpc.pb.h`: 描述了协议缓冲区类型的序列化与反序列化的公共接口； - `tutorial.grpc.pb.cc`: 提供具体的序列化及网络传输的支持； 把它们复制进你的工程树下的适当地方备用即可。 #### （b）对 Python 则采用另一种策略： ```bash mkdir ../python_client/generated_stubs python -m grpc_tools.protoc \ -I. \ --python_out=../python_client/generated_stubs \ --grpc_python_out=../python_client/generated_stubs \ ./hello_service.proto ``` 结果同样会得到两样东西放在指定目标里边儿： - `_pb2.py`: 含有纯粹的数据模型对象定义； - `_pb2_grpc.py`: 添加有关服务注册方面的额外增强特性； 至此为止就完成了初步准备工作！ --- ### Step 5: 实现 C++ 服务端的核心业务处理单元 打开编辑器加载刚才提到过的那个叫作 `greeter_impl.cpp` 的空壳子文档。往里面加入如下所示的一段完整示范代码清单吧！ ```cpp #include <iostream> #include <memory> #include <string> /* 引入自动生成出来的头档 */ #include "../generated_files/tutorial.grpc.pb.h" using grpc::Server; using grpc::ServerBuilder; using grpc::ServerContext; using grpc::Status; namespace tutorial { class GreeterServiceImpl final : public GreeterService::Service { public: Status SayHello(ServerContext* context, const HelloRequest* request, HelloReply* reply) override { /* 设置应答消息内容 */ std::string prefix("Hello "); reply->set_message(prefix + request->name()); return Status::OK; } }; } // namespace tutorial void RunServer() { std::string server_address("0.0.0.0:50051"); ::tutorial::GreeterServiceImpl service; ServerBuilder builder; builder.AddListeningPort(server_address, grpc::InsecureServerCredentials()); builder.RegisterService(&service); std::unique_ptr<Server> server(builder.BuildAndStart()); std::cout << "Server listening on port " << server_address << "\n"; server->Wait(); // Keep running until killed manually... } int main(int argc, char** argv){ RunServer(); return EXIT_SUCCESS ; }; ``` 记得调整引用路径适配实际情况哦~ --- ### Step 6: 设计简易版 Python 测试脚本 最后来到我们的最后一站 –– 写出客户端启动后的动作描述！以下是完整的例子演示： ```python #!/usr/bin/env python3 # 导入库资源进来 import grpc from generated_stubs import tutorial_pb2 as pb2 from generated_stubs import tutorial_pb2_grpc as pb2_grpc def get_greeter_stub(): """ Connects to remote host and creates a stub instance """ channel = grpc.insecure_channel('localhost:50051') stub = pb2_grpc.GreeterStub(channel) return stub def make_hello_call(stub): req = pb2.HelloRequest(name="World") try: resp = stub.SayHello(req) print(f"Received greeting from server:\n{resp}") except Exception as e: raise RuntimeError(f"gRPC call failed with error={str(e)}") if __name__ == "__main__": svc_proxy = get_greeter_stub() if not svc_proxy is None: make_hello_call(svc_proxy) ``` 保存上述全部完成后便能正式投入试运行啦～ ---