简介
gRPC 是一种由 Google 推出的 RPC 框架,开源,跨语言,跨平台,高性能。
gRPC 次要是基于 protobuf 设计实现的。
本文次要介绍如何在 C ++ 中应用 gRPC。
装置
不像 Java,配置一个 maven 插件,增加相应的 maven 依赖,就能够搭建好 gRPC 环境。
C++ 个别须要下载 gRPC 的源码,而后编译构建,失去须要的库文件,protoc 编译器,以及 gRPC 插件。
- 下载源码
git clone --recurse-submodules -b v1.41.0 https://github.com/grpc/grpc
cd grpc
- 创立 cmake 构建目录
mkdir -p cmake/build
cd cmake/build
- 生成 makefile
cmake -DgRPC_INSTALL=ON \
-DgRPC_BUILD_TESTS=OFF \
-DCMAKE_INSTALL_PREFIX=$MY_INSTALL_DIR \
../..
MY_INSTALL_DIR 变量指定了最终生成的库文件,protoc 的装置地位,linux 零碎个别为 /usr/local
- 构建
make -j
- 装置
make install
此命令会依据第三部指定的 MY_INSTALL_DIR 的,将构建进去的库装置到相应的地位。比方 protoc 就放在 ${MY_INSTALL_DIR}/bin 目录下,
头文件就放在 ${MY_INSTALL_DIR}/include/grpc 目录下。
当然,执行上述命令须要装置 g ++, cmake, git 等工具。
HelloWorld
应用 gRPC 首先须要写 proto 文件,形容 rpc,供客户端和服务端应用。
- proto 文件接口定义
hello.proto
// protobuf 版本
syntax = "proto3";
// rpc 申请的定义
message HelloRequest {optional string name = 1;}
// rpc 响应的定义
message HelloReply {optional string message = 1;}
// rpc 服务的定义,两个函数
service HelloWorld {rpc SayHello (HelloRequest) returns (HelloReply) {}
rpc SayHelloAgain (HelloRequest) returns (HelloReply) {}}
- 服务端
proto 仅定义了接口,还须要在服务端写程序,实现 rpc。server.cc
#include "hello.grpc.pb.h"
#include <string>
#include <grpcpp/grpcpp.h>
// rpc 服务实现
class HelloServiceImpl : public HelloWorld::Service
{grpc::Status SayHello(grpc::ServerContext* context, const HelloRequest* req, HelloReply* rsp)
{std::cout << "Request SayHello From" << context->peer() << std::endl;
rsp->set_message("hello" + req->name() + "!");
return grpc::Status::OK;
}
grpc::Status SayHelloAgain(grpc::ServerContext* context, const HelloRequest* req, HelloReply* rsp)
{std::cout << "Request SayHelloAgain From" << context->peer() << std::endl;
rsp->set_message("hello" + req->name() + "again!!");
return grpc::Status::OK;
}
};
// 启动运行
int main(int argc, char** argv)
{std::string address("localhost:5000");
HelloServiceImpl service;
grpc::ServerBuilder builder;
builder.AddListeningPort(address, grpc::InsecureServerCredentials());
builder.RegisterService(&service);
std::unique_ptr<grpc::Server> server(builder.BuildAndStart());
std::cout << "Server Listening on port:" << address << std::endl;
server->Wait();
return 0;
}
- 客户端
客户端调用服务端的,client.cc
#include "hello.grpc.pb.h"
#include <string>
#include <iostream>
#include <sstream>
#include <grpcpp/grpcpp.h>
// 客户端
class HelloClient
{
public:
HelloClient(std::shared_ptr<grpc::Channel> channel) : _stub(HelloWorld::NewStub(channel))
{}
std::string SayHello(const std::string& name)
{
HelloRequest req;
HelloReply rsp;
req.set_name(name);
grpc::ClientContext context;
grpc::Status status = _stub->SayHello(&context, req, &rsp);
if(status.ok())
{return rsp.message();
}
else
{
std::ostringstream out;
out << status.error_code() << ":" << status.error_message();
return out.str();}
}
std::string SayHelloAgain(const std::string& name)
{
HelloRequest req;
HelloReply rsp;
req.set_name(name);
grpc::ClientContext context;
grpc::Status status = _stub->SayHelloAgain(&context, req, &rsp);
if(status.ok())
{return rsp.message();
}
else
{
std::ostringstream out;
out << status.error_code() << ":" << status.error_message();
return out.str();}
}
private:
std::unique_ptr<HelloWorld::Stub> _stub;
};
// 调用 rpc
int main(int argc, char** argv)
{std::string address("0.0.0.0:5000");
HelloClient client(grpc::CreateChannel(address, grpc::InsecureChannelCredentials()));
std::string name("bazel");
std::cout << client.SayHello(name) << std::endl;
std::cout << client.SayHelloAgain(name) << std::endl;
return 0;
}
编译运行
- proto 编译
protoc --cpp_out=. --grpc_out=. --plugin=protoc-gen-grpc=`which grpc_cpp_plugin` hello.proto
上述命令会生成 hello.pb.h/cc 和 hello.grpc.pb.h/cc
- 服务端
g++ -std=c++11 \
`pkg-config --cflags protobuf grpc` \
`pkg-config --libs protobuf grpc++` \
-framework CoreFoundation \ // 仅 MacOS 须要加
-o server \
hello.pb.cc hello.grpc.pb.cc server.cc
其中 pkg-config --cflags protobuf grpc
指定了头文件的地位,pkg-config --libs protobuf grpc++
指定了库文件的地位,-framework CoreFoundation
仅在 MacOS 中须要增加,这是因为 grpc 的 abseil 的 time 库在 MacOS 下用的是 CoreFoundation 中的
而后./server 运行
- 客户端
g++ -std=c++11 \
`pkg-config --cflags protobuf grpc` \
`pkg-config --libs protobuf grpc++`
-framework CoreFoundation \ // 仅 MacOS 须要加
-o client \
hello.pb.cc hello.grpc.pb.cc client.cc
而后./client 运行
参考
Quick start | C++ | gRPC
gRPC C++ 入门教程