gRPC 跨语言通信实战：C++ 服务端对接 C# 客户端

#!/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：消息类型的实现代码。

2. 实现服务逻辑

创建 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;
}

3. 实现服务端主程序

创建 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;
}

4. 编译服务端

为了编译服务端代码，我们需要创建一个 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# 客户端实现

1. 创建 C# 项目

使用以下命令创建一个新的 C# 控制台项目：

dotnet new console -n GrpcClient
cd GrpcClient
dotnet add package Grpc.Net.Client
dotnet add package Google.Protobuf
dotnet add package Grpc.Tools

2. 添加 proto 文件

将之前创建的 sample_service.proto 文件复制到 C# 项目目录下，并修改 .csproj 文件，添加以下内容：

<ItemGroup>
    <Protobuf Include="sample_service.proto" GrpcServices="Client" />
</ItemGroup>

3. 实现客户端

修改 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}");
        }
    }
}

4. 运行客户端

在项目目录下，使用以下命令运行客户端：

dotnet run

五、测试与验证

1. 启动 C++ 服务端

在终端中运行编译好的服务端程序：

./server

服务端启动后，会监听 0.0.0.0:50051 端口。

2. 运行 C# 客户端

在另一个终端中，进入 C# 客户端项目目录，运行客户端程序：

dotnet run

如果一切正常，你将看到以下输出：

5 + 3 = 8
10 - 4 = 6

这表明客户端成功调用了服务端的方法，并得到了正确的结果。

六、常见问题解决

1. 连接失败

• 确保服务端地址正确：检查客户端代码中指定的服务端地址和端口是否与服务端实际监听的地址和端口一致。
• 检查防火墙设置：确保防火墙没有阻止客户端与服务端之间的通信。可以临时关闭防火墙进行测试，或者在防火墙中开放相应的端口。
• 服务端和客户端使用相同的协议：确保客户端和服务端使用相同的协议（HTTP/HTTPS）。如果服务端使用的是不安全连接（InsecureServerCredentials），客户端也应该使用不安全连接。

2. 序列化错误

• 确保 proto 文件在服务端和客户端完全一致：.proto 文件是服务端和客户端通信的契约，必须保证两端的 .proto 文件内容完全相同。
• 重新生成代码后清理并重新编译：如果修改了 .proto 文件，需要重新生成代码，并清理和重新编译服务端和客户端项目。

3. 性能优化

• 对于高频调用，考虑使用连接池：gRPC 本身没有提供连接池的功能，但可以通过第三方库或自定义实现来实现连接池，以减少连接建立和销毁的开销。
• 调整 gRPC 通道参数：可以根据实际情况调整 gRPC 通道的参数，如超时时间、最大消息大小等，以提高性能。

七、流程总结

以下是按照步骤，用表格形式总结的基于 gRPC 实现跨语言通信（C++ 服务端、C# 客户端）的流程：

希望这个表格能帮助你清晰地梳理整个 gRPC 跨语言通信实现的流程。

通过以上步骤，我们完成了一个完整的 gRPC 跨语言通信系统的搭建，实现了 C++ 服务端和 C# 客户端之间的通信。这个示例展示了 gRPC 的核心功能，你可以基于此扩展更复杂的业务逻辑。gRPC 的强大之处在于它的跨语言特性和高性能通信能力，非常适合微服务架构。