前言
在现代分布式系统中,gRPC 作为高性能、跨语言的 RPC 框架越来越受欢迎。它基于 HTTP/2 协议,使用 Protocol Buffers(Protobuf)作为接口定义语言,支持多种编程语言,能够高效地实现不同语言之间的远程过程调用。本文将手把手教你如何从零开始构建一个完整的 gRPC 通信系统,使用 C++ 实现服务端,C# 实现客户端。
如何使用 gRPC 框架实现 C++ 服务端与 C# 客户端的跨语言通信。内容包括环境搭建(安装 protoc、gRPC 库、.NET SDK)、定义 proto 接口文件、生成代码、编写服务端逻辑与主程序、配置 C# 客户端及测试验证。文中还涵盖了常见问题排查与性能优化建议,提供了完整的编译运行步骤与流程总结表,帮助开发者快速构建高性能微服务通信系统。

在现代分布式系统中,gRPC 作为高性能、跨语言的 RPC 框架越来越受欢迎。它基于 HTTP/2 协议,使用 Protocol Buffers(Protobuf)作为接口定义语言,支持多种编程语言,能够高效地实现不同语言之间的远程过程调用。本文将手把手教你如何从零开始构建一个完整的 gRPC 通信系统,使用 C++ 实现服务端,C# 实现客户端。
Protocol Buffers 是一种轻便高效的结构化数据存储格式,gRPC 使用它来定义服务接口和数据结构。你需要下载并安装 Protocol Buffers 编译器 protoc,下载地址为:https://github.com/protocolbuffers/protobuf/releases。安装完成后,确保将 protoc 添加到系统的 PATH 环境变量中,这样在命令行中就可以直接使用它。
对于 C++ 开发,你需要安装 gRPC 和 protobuf 库。在 Ubuntu 系统上,可以使用以下命令进行安装:
sudo apt install libgrpc++-dev libprotobuf-dev protobuf-compiler grpc-plugins
C# 开发需要安装 .NET SDK(版本 ≥ 6.0),你可以从 https://dotnet.microsoft.com/download 下载并安装。安装完成后,在 C# 项目中添加必要的 NuGet 包:
dotnet add package Grpc.Net.Client
dotnet add package Google.Protobuf
dotnet add package Grpc.Tools
首先,我们需要创建一个 .proto 文件来定义服务接口和数据结构。创建一个名为 sample_service.proto 的文件,内容如下:
syntax = "proto3";
option csharp_namespace = "SampleService.Client";
package sampleservice;
// 请求消息
message CalculationRequest {
double a = 1;
double b = 2;
}
// 响应消息
message CalculationResult {
double result = 1;
}
// 服务定义
service Calculator {
// 加法运算
rpc Add (CalculationRequest) returns (CalculationResult);
// 减法运算
rpc Subtract (CalculationRequest) returns (CalculationResult);
}
在这个 .proto 文件中,我们定义了一个名为 Calculator 的服务,包含两个方法:Add 和 Subtract,分别用于执行加法和减法运算。同时,我们还定义了请求消息 CalculationRequest 和响应消息 CalculationResult。
为了根据 .proto 文件生成 C++ 代码,我们需要创建一个脚本 generate.sh:
#!/bin/bash
protoc -I=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` sample_service.proto
protoc -I=. --cpp_out=. sample_service.proto
运行这个脚本后,会生成以下文件:
sample_service.grpc.pb.h:包含服务接口的定义。sample_service.grpc.pb.cc:服务接口的实现代码。sample_service.pb.h:消息类型的定义。sample_service.pb.cc:消息类型的实现代码。创建 calculator_service.h 文件,实现服务逻辑的头文件:
#include <grpcpp/grpcpp.h>
#include "sample_service.grpc.pb.h"
using grpc::ServerContext;
using grpc::Status;
using sampleservice::CalculationRequest;
using sampleservice::CalculationResult;
using sampleservice::Calculator;
class CalculatorServiceImpl final : public Calculator::Service {
public:
Status Add(ServerContext* context, const CalculationRequest* request, CalculationResult* response) override;
Status Subtract(ServerContext* context, const CalculationRequest* request, CalculationResult* response) override;
};
然后,创建 calculator_service.cpp 文件,实现具体的服务逻辑:
#include "calculator_service.h"
Status CalculatorServiceImpl::Add(ServerContext* context, const CalculationRequest* request, CalculationResult* response) {
double result = request->a() + request->b();
response->set_result(result);
return Status::OK;
}
Status CalculatorServiceImpl::Subtract(ServerContext* context, const CalculationRequest* request, CalculationResult* response) {
double result = request->a() - request->b();
response->set_result(result);
return Status::OK;
}
创建 server.cpp 文件,实现服务端的主程序:
#include <iostream>
#include <memory>
#include <string>
#include <grpcpp/grpcpp.h>
#include "calculator_service.h"
using grpc::Server;
using grpc::ServerBuilder;
using grpc::ServerContext;
using grpc::Status;
void RunServer() {
std::string server_address("0.0.0.0:50051");
CalculatorServiceImpl 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() {
RunServer();
return 0;
}
为了编译服务端代码,我们需要创建一个 CMakeLists.txt 文件:
cmake_minimum_required(VERSION 3.10)
project(grpc_server)
set(CMAKE_CXX_STANDARD 17)
find_package(Protobuf REQUIRED)
find_package(gRPC REQUIRED)
add_executable(server server.cpp calculator_service.cpp sample_service.pb.cc sample_service.grpc.pb.cc)
target_link_libraries(server PRIVATE gRPC::grpc++ gRPC::grpc protobuf::libprotobuf)
然后,按照以下步骤进行编译和运行:
mkdir build && cd build
cmake .. && make
./server
使用以下命令创建一个新的 C# 控制台项目:
dotnet new console -n GrpcClient
cd GrpcClient
dotnet add package Grpc.Net.Client
dotnet add package Google.Protobuf
dotnet add package Grpc.Tools
将之前创建的 sample_service.proto 文件复制到 C# 项目目录下,并修改 .csproj 文件,添加以下内容:
<ItemGroup>
<Protobuf Include="sample_service.proto" GrpcServices="Client" />
</ItemGroup>
修改 Program.cs 文件,实现客户端代码:
using System;
using System.Threading.Tasks;
using Grpc.Net.Client;
using SampleService.Client;
class Program {
static async Task Main(string[] args) {
using var channel = GrpcChannel.ForAddress("http://localhost:50051");
var client = new Calculator.CalculatorClient(channel);
try {
// 加法示例
var addRequest = new CalculationRequest { A = 5, B = 3 };
var addResult = await client.AddAsync(addRequest);
Console.WriteLine($"5 + 3 = {addResult.Result}");
// 减法示例
var subRequest = new CalculationRequest { A = 10, B = 4 };
var subResult = await client.SubtractAsync(subRequest);
Console.WriteLine($"10 - 4 = {subResult.Result}");
} catch (Grpc.Core.RpcException ex) {
Console.WriteLine($"RPC failed: {ex.Status.Detail}");
}
}
}
在项目目录下,使用以下命令运行客户端:
dotnet run
在终端中运行编译好的服务端程序:
./server
服务端启动后,会监听 0.0.0.0:50051 端口。
在另一个终端中,进入 C# 客户端项目目录,运行客户端程序:
dotnet run
如果一切正常,你将看到以下输出:
5 + 3 = 8
10 - 4 = 6
这表明客户端成功调用了服务端的方法,并得到了正确的结果。
InsecureServerCredentials),客户端也应该使用不安全连接。.proto 文件是服务端和客户端通信的契约,必须保证两端的 .proto 文件内容完全相同。.proto 文件,需要重新生成代码,并清理和重新编译服务端和客户端项目。以下是按照步骤,用表格形式总结的基于 gRPC 实现跨语言通信(C++ 服务端、C# 客户端)的流程:
| 步骤 | 任务具体内容 | 详细描述 |
|---|---|---|
| 1. 环境准备 | 安装必要的工具和库 | 安装 Protocol Buffers 编译器(protoc),如在 Windows 系统中下载安装包并配置环境变量,使其可在命令行中直接调用;安装 gRPC 相关工具,包括 gRPC 插件(如 grpc_cpp_plugin 和 grpc_csharp_plugin),用于生成对应语言的源代码;安装.NET 环境(如.NET SDK),用于 C# 客户端开发,可通过官网下载对应版本安装包并安装,安装完成后可通过命令行运行 dotnet --version 验证安装是否成功;此外,还需安装 C++ 开发环境(如 Visual Studio),用于 C++ 服务端的开发,安装时选择对应的开发工作负载,如'桌面开发'等 |
| 2. 定义服务接口 | 使用.proto文件定义服务接口和数据结构 | 创建.proto文件来定义服务接口及数据结构,例如定义一个名为MyService的服务,其中包含一个SayHello方法,该方法接收一个HelloRequest消息类型作为参数,并返回一个HelloReply消息类型,.proto文件中会包含对应的message定义来具体描述HelloRequest和HelloReply的字段,如string name字段等 |
| 3. 生成代码 | 根据.proto文件生成 C++ 和 C# 代码 | 在命令行中使用 protoc 编译器,结合相应的 gRPC 插件来生成代码,对于 C++,运行类似 protoc --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin path/to/your/service.proto 的命令,生成 C++ 服务端的桩代码;对于 C#,运行类似 protoc --grpc_out=. --plugin=protoc-gen-grpc=grpc_csharp_plugin path/to/your/service.proto 的命令,生成 C# 客户端的存根代码 |
| 4. 实现服务端 | 在 C++ 中实现服务端逻辑,并编译运行 | 根据生成的 C++ 桩代码,在 C++ 项目中实现服务端的具体逻辑,如实现 MyService 服务中的 SayHello 方法的业务逻辑,编写一个 SayHello 的重写方法,在该方法中根据输入的 HelloRequest 来构造 HelloReply 作为返回值;之后配置 C++ 项目的编译链接环境,添加必要的 gRPC、Protocol Buffers 库依赖等,编译生成服务端可执行文件,并运行服务端 |
| 5. 实现客户端 | 在 C# 中实现客户端代码,并运行客户端进行测试 | 根据生成的 C# 存根代码,在 C# 项目(如使用.NET SDK 创建的控制台应用程序项目)中实现客户端逻辑,创建 Channel 连接到服务端地址,创建客户端实例,并调用服务端的方法,如调用 SayHello 方法,构造 HelloRequest 并发送请求,接收服务端返回的 HelloReply;配置 C# 项目依赖,添加 gRPC、Protocol Buffers 相关的 NuGet 包引用,运行客户端进行测试 |
| 6. 测试与验证 | 启动服务端和客户端,验证通信是否正常 | 先启动服务端,确保服务端处于运行状态并监听端口;然后启动客户端,客户端会发送请求到服务端,服务端处理后返回响应给客户端,观察客户端是否能正确接收到预期的响应结果,如在控制台输出'Hello, [name]'之类的响应信息来验证通信是否成功 |
| 7. 问题解决 | 遇到问题时,根据具体情况进行排查和解决 | 如果服务端和客户端无法通信,可以检查网络连接是否正常,如端口是否被正确监听和连接;检查服务端和客户端的.proto文件版本是否一致,以及生成的代码是否正确;检查是否所有必要的依赖库都已正确安装和配置;通过查看日志信息、调试程序等方式来定位问题并解决,根据问题具体表现来逐步排查原因 |
希望这个表格能帮助你清晰地梳理整个 gRPC 跨语言通信实现的流程。
通过以上步骤,我们完成了一个完整的 gRPC 跨语言通信系统的搭建,实现了 C++ 服务端和 C# 客户端之间的通信。这个示例展示了 gRPC 的核心功能,你可以基于此扩展更复杂的业务逻辑。gRPC 的强大之处在于它的跨语言特性和高性能通信能力,非常适合微服务架构。

微信公众号「极客日志」,在微信中扫描左侧二维码关注。展示文案:极客日志 zeeklog
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具,Base64 字符串编码/解码在线工具,online
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具,Base64 文件转换器在线工具,online
将 Markdown(GFM)转为 HTML 片段,浏览器内 marked 解析;与 HTML 转 Markdown 互为补充。 在线工具,Markdown 转 HTML在线工具,online
将 HTML 片段转为 GitHub Flavored Markdown,支持标题、列表、链接、代码块与表格等;浏览器内处理,可链接预填。 在线工具,HTML 转 Markdown在线工具,online
通过删除不必要的空白来缩小和压缩JSON。 在线工具,JSON 压缩在线工具,online
将JSON字符串修饰为友好的可读格式。 在线工具,JSON美化和格式化在线工具,online