下面是一个详细的 gRPC 示例，展示如何使用 C++ 实现一个基本的客户端和服务器通信。这个示例将详细体现 gRPC 的使用步骤，包括 .proto 文件的定义、服务端和客户端的实现，以及如何编译和运行这些代码。
gRPC使用教程（C++）
- 1. 定义 `.proto` 文件
- 2. 使用 `protoc` 生成 C++ 代码
- 3. 实现服务器
- 4. 实现客户端
- 5. 编译
- 6. 运行
- 详细的 gRPC 特性
1. 定义 .proto 文件
首先，需要定义一个 .proto 文件来描述 gRPC 服务以及数据结构。
greeter.proto 文件内容：
syntax = "proto3";package greeter;// 定义一个 gRPC 服务
service Greeter {// 定义一个 SayHello RPC 方法rpc SayHello (HelloRequest) returns (HelloReply) {}
}// 定义请求消息
message HelloRequest {string name = 1;
}// 定义响应消息
message HelloReply {string message = 1;
}
2. 使用 protoc 生成 C++ 代码
运行以下命令，使用 Protocol Buffers 编译器 protoc 生成 C++ 代码：
protoc --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` greeter.proto
此命令将生成两个文件：
greeter.pb.h和greeter.pb.cc：这是由 protobuf 生成的 C++ 数据结构代码。greeter.grpc.pb.h和greeter.grpc.pb.cc：这是由 gRPC 生成的服务代码。
3. 实现服务器
服务器端需要实现 Greeter 服务中的 SayHello 方法。可以继承 gRPC 自动生成的服务类并实现它。
server.cpp 文件内容：
#include <iostream>
#include <memory>
#include <string>
#include <grpcpp/grpcpp.h>
#include "greeter.grpc.pb.h"using grpc::Server;
using grpc::ServerBuilder;
using grpc::ServerContext;
using grpc::Status;
using greeter::Greeter;
using greeter::HelloRequest;
using greeter::HelloReply;// 继承并实现生成的 Greeter 服务类
class GreeterServiceImpl final : public Greeter::Service {
public:// 实现 SayHello 方法Status SayHello(ServerContext* context, const HelloRequest* request, HelloReply* reply) override {std::string prefix("Hello ");reply->set_message(prefix + request->name());return Status::OK;}
};// 启动 gRPC 服务器
void RunServer() {std::string server_address("0.0.0.0:50051");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 " << server_address << std::endl;server->Wait();
}int main(int argc, char** argv) {RunServer();return 0;
}
4. 实现客户端
客户端将使用 gRPC 库发起对服务器的请求。
client.cpp 文件内容：
#include <iostream>
#include <memory>
#include <string>
#include <grpcpp/grpcpp.h>
#include "greeter.grpc.pb.h"using grpc::Channel;
using grpc::ClientContext;
using grpc::Status;
using greeter::Greeter;
using greeter::HelloRequest;
using greeter::HelloReply;// GreeterClient 类用于与 gRPC 服务器通信
class GreeterClient {
public:// 构造函数，初始化与服务器的连接GreeterClient(std::shared_ptr<Channel> channel): stub_(Greeter::NewStub(channel)) {}// 客户端调用 SayHello 方法std::string SayHello(const std::string& user) {HelloRequest request;request.set_name(user);HelloReply reply;ClientContext context;// 发起 RPC 调用Status status = stub_->SayHello(&context, request, &reply);if (status.ok()) {return reply.message();} else {std::cout << "RPC failed" << std::endl;return "RPC failed";}}private:std::unique_ptr<Greeter::Stub> stub_;
};int main(int argc, char** argv) {// 创建客户端，连接服务器GreeterClient greeter(grpc::CreateChannel("localhost:50051", grpc::InsecureChannelCredentials()));std::string user("world");std::string reply = greeter.SayHello(user);std::cout << "Greeter received: " << reply << std::endl;return 0;
}
5. 编译
为了编译这两个程序，你需要 gRPC 和 Protocol Buffers 的库。你可以使用 CMake 构建项目，以下是一个简单的 CMakeLists.txt 文件：
cmake_minimum_required(VERSION 3.5.1)project(Greeter)# 查找 gRPC 和 Protocol Buffers
find_package(gRPC REQUIRED)
find_package(Protobuf REQUIRED)set(CMAKE_CXX_STANDARD 11)add_executable(server server.cpp greeter.grpc.pb.cc greeter.pb.cc)
add_executable(client client.cpp greeter.grpc.pb.cc greeter.pb.cc)target_link_libraries(server gRPC::grpc++ protobuf::libprotobuf)
target_link_libraries(client gRPC::grpc++ protobuf::libprotobuf)
6. 运行
-
编译项目：
mkdir build cd build cmake .. make -
运行服务器：
./server -
在另一个终端运行客户端：
./client
将会看到客户端打印出来自服务器的消息：
Greeter received: Hello world
详细的 gRPC 特性
- 多种通信模式：支持普通 RPC、客户端流式、服务器流式、双向流式 RPC。
- 支持多种语言：gRPC 不仅支持 C++，还支持 Python、Java、Go 等。
- 高效通信：基于 HTTP/2 和 protobuf，支持双向通信和高效的二进制序列化。
通过这个示例，能够理解 gRPC 在 C++ 中的基础使用流程，从服务定义到客户端和服务器之间的通信。