C++ gRPC Quick Start

简介

gRPC是一种由Google推出的RPC框架,开源,跨语言,跨平台,高性能。

gRPC主要是基于protobuf设计实现的。

本文主要介绍如何在C++中使用gRPC。

安装

不像Java,配置一个maven插件,添加相应的maven依赖,就可以搭建好gRPC环境。

C++一般需要下载gRPC的源码,然后编译构建,得到需要的库文件,protoc编译器,以及gRPC插件。

  1. 下载源码
git clone --recurse-submodules -b v1.41.0 https://github.com/grpc/grpc
cd grpc
  1. 创建cmake构建目录
mkdir -p cmake/build
cd cmake/build
  1. 生成makefile
cmake -DgRPC_INSTALL=ON \
      -DgRPC_BUILD_TESTS=OFF \
      -DCMAKE_INSTALL_PREFIX=$MY_INSTALL_DIR \
      ../..

MY_INSTALL_DIR变量指定了最终生成的库文件,protoc的安装位置,linux系统一般为/usr/local

  1. 构建
make -j
  1. 安装
make install

此命令会根据第三部指定的MY_INSTALL_DIR的,将构建出来的库安装到相应的位置。比如protoc就放在${MY_INSTALL_DIR}/bin目录下,

头文件就放在${MY_INSTALL_DIR}/include/grpc目录下。

当然,执行上述命令需要安装g++, cmake, git等工具。

HelloWorld

使用gRPC首先需要写proto文件,描述rpc,供客户端和服务端使用。

  1. 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) {}
}
  1. 服务端

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;
}
  1. 客户端

客户端调用服务端的,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;
}

编译运行

  1. 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

  1. 服务端
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运行

  1. 客户端
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++ 入门教程

3 声望
0 粉丝
0 条评论
推荐阅读
使用 gitlab 实现 proto 文件的 semantic version 管理(2) - 配置篇
最终目标:所有 proto 文件的改动都体现在版本号中;开发者不需要手动编译 proto 文件;同一个版本号在各个语言中是通用的;配置方案:配置 gitlab CI,实现 merge request 通过之后自动打包并生成版本号;每个版...

Airy2阅读 3.1k评论 2

麒麟操作系统 (kylinos) 从入门到精通 - 研发环境 - 第二十一篇 C++/C语言开发环境搭建
类别:笔记本型号:中国长城 NF14C硬件平台:飞腾处理器(ArmV8 指令集)系统:银河麒麟操作系统 V10 SP1(2203) 关键词:信创,麒麟系统,linux,c++,c,内核飞腾,arm

码上世界1阅读 2.5k评论 1

封面图
万字避坑指南!C++的缺陷与思考(下)
导读 | 在万字避坑指南!C++的缺陷与思考(上)一文中,微信后台开发工程师胡博豪,分享了C++的发展历史、右值引用与移动语义、类型说明符等内容,深受广大开发者喜爱!此篇,我们邀请作者继续总结其在C++开发过...

腾讯云开发者5阅读 522评论 1

写给go开发者的gRPC教程-通信模式
本篇为【写给go开发者的gRPC教程系列】第二篇第一篇:protobuf基础第二篇:通信模式上一篇介绍了如何编写 protobuf 的 idl,并使用 idl 生成了 gRPC 的代码,现在来看看如何编写客户端和服务端的代码Simple RPC (...

liangwt2阅读 1k

封面图
DBoS 系统说明
程序员TianSong以单片机开发入门,后续又做了 Qt 相关工作,有时间后开始进行 linux 相关的学习,恰巧在二一年十一月份,百问网的韦东山老师进行了三个月的 linux 驱动直播,于是有了开发 DBoS 的念头。

TianSong1阅读 1.1k

【Qt】简单桌面
[链接]简介简单桌面是一款小巧便捷的桌面背景管理软件。由编程爱好者个人开发,不收集使用者个人信息、不连接网络、不弹窗。下载功能支持单静态图片及多静态图片轮播(轮播时间可设置)支持GIF动画背景支持视频背...

TianSong3阅读 2.1k

写给go开发者的gRPC教程-protobuf基础
序列化协议。gRPC使用protobuf,首先使用protobuf定义服务,然后使用这个文件来生成客户端和服务端的代码。因为pb是跨语言的,因此即使服务端和客户端语言并不一致也是可以互相序列化和反序列化的

liangwt1阅读 991评论 1

封面图
3 声望
0 粉丝
宣传栏