gRPC-cpp使用总结(1)

gRPC 官方文档中文版

简介

gRPC 是一个高性能、开源和通用的 RPC 框架，面向移动和 HTTP/2 设计。目前提供 C、Java 和 Go 语言版本，分别是：grpc, grpc-java, grpc-go. 其中 C 版本支持 C, C++, Node.js, Python, Ruby, Objective-C, PHP 和 C# 支持.
gRPC 基于 HTTP/2 标准设计，带来诸如双向流、流控、头部压缩、单 TCP 连接上的多复用请求等特。这些特性使得其在移动设备上表现更好，更省电和节省空间占用。gRPC 一开始由 google 开发，是一款语言中立、平台中立、开源的远程过程调用(RPC)系统。

gRPC 是什么？

在 gRPC 里客户端应用可以像调用本地对象一样直接调用另一台不同的机器上服务端应用的方法，使得您能够更容易地创建分布式应用和服务。与许多 RPC 系统类似，gRPC 也是基于以下理念：定义一个服务，指定其能够被远程调用的方法（包含参数和返回类型）。在服务端实现这个接口，并运行一个 gRPC 服务器来处理客户端调用。在客户端拥有一个存根能够像服务端一样的方法。

gRPC 客户端和服务端可以在多种环境中运行和交互 - 从 google 内部的服务器到你自己的笔记本，并且可以用任何 gRPC 支持的语言来编写。所以，你可以很容易地用 Java 创建一个 gRPC 服务端，用 Go、Python、Ruby 来创建客户端。此外，Google 最新 API 将有 gRPC 版本的接口，使你很容易地将 Google 的功能集成到你的应用里。

使用 protocol buffers

gRPC 默认使用 protocol buffers，这是 Google 开源的一套成熟的结构数据序列化机制（当然也可以使用其他数据格式如 JSON）。正如你将在下方例子里所看到的，你用 proto files 创建 gRPC 服务，用 protocol buffers 消息类型来定义方法参数和返回类型。你可以在 Protocol Buffers 文档找到更多关于 Protocol Buffers 的资料。

Protocol buffers 版本

尽管 protocol buffers 对于开源用户来说已经存在了一段时间，例子内使用的却一种名叫 proto3 的新风格的 protocol buffers，它拥有轻量简化的语法、一些有用的新功能，并且支持更多新语言。当前针对 Java 和 C++ 发布了 beta 版本，针对 JavaNano（即 Android Java）发布 alpha 版本，在protocol buffers Github 源码库里有 Ruby 支持， 在golang/protobuf Github 源码库里还有针对 Go 语言的生成器， 对更多语言的支持正在开发中。 你可以在 proto3 语言指南里找到更多内容， 在与当前默认版本的发布说明比较，看到两者的主要不同点。更多关于 proto3 的文档很快就会出现。虽然你可以使用 proto2 (当前默认的 protocol buffers 版本)， 我们通常建议你在 gRPC 里使用 proto3，因为这样你可以使用 gRPC 支持全部范围的的语言，并且能避免 proto2 客户端与 proto3 服务端交互时出现的兼容性问题，反之亦然。

了解其工作机制最简单的方法是看一个简单的例子。 Hello World 将带领你创建一个简单的客户端——服务端应用，向你展示：

• 通过一个 protocol buffers 模式，定义一个简单的带有 Hello World 方法的 RPC 服务。
• 用你最喜欢的语言(如果可用的话)来创建一个实现了这个接口的服务端。
• 用你最喜欢的(或者其他你愿意的)语言来访问你的服务端。

这个例子完整的代码在我们 GitHub 源码库的 examples 目录下。

• 准备
  本节解释了如何在你本机上准备好例子代码的运行环境。如果你只是想读一下例子，你可以直接到下一步。

• 安装 Git
  你可以从http://git-scm.com/download下载和安装 Git。安装好 Git 后，你应该能访问 git 命令行工具。你需要的主要命令如下：
  git clone … ： 从远程代码库克隆一份到本机。
  git checkout … ： 检出一个特殊分支或一个标签版本的代码来改进。

• 安装 gRPC
  针对你选择的语言构建和安装 gRPC 插件和相关工具，可以参照快速开始。 Java gRPC 除了 JDK 外不需要其他工具。

• C++
  例子代码在 GitHub 源码库的 examples 目录。你可以运行如下命令克隆源码到本地：

$ git clone https：//github.com/grpc/grpc.git
切换当前目录到 examples/cpp/helloworld
$ cd examples/cpp/helloworld/

定义服务

创建我们例子的第一步是定义一个服务：一个 RPC 服务通过参数和返回类型来指定可以远程调用的方法。就像你在 概览 里所看到的， gRPC 通过 protocol buffers 来实现。
我们使用 protocol buffers 接口定义语言来定义服务方法，用 protocol buffer 来定义参数和返回类型。客户端和服务端均使用服务定义生成的接口代码。
这里有我们服务定义的例子，在 helloworld.proto 里用 protocol buffers IDL 定义的。Greeter 服务有一个方法 SayHello ，可以让服务端从远程客户端接收一个包含用户名的 HelloRequest 消息后，在一个 HelloReply 里发送回一个 Greeter。这是你可以在 gRPC 里指定的最简单的 RPC - 你可以在教程里找到针对你选择的语言更多类型的例子。

syntax = "proto3";
option java_package = "io.grpc.examples";
package helloworld;

// The greeter service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}
// The request message containing the user's name.
message HelloRequest {
  string name = 1;
}
// The response message containing the greetings
message HelloReply {
  string message = 1;
}

生成 gRPC 代码

一旦定义好服务，我们可以使用 protocol buffer 编译器 protoc 来生成创建应用所需的特定客户端和服务端的代码 - 你可以生成任意 gRPC 支持的语言的代码，当然 PHP 和 Objective-C 仅支持创建客户端代码。生成的代码同时包括客户端的存根和服务端要实现的抽象接口，均包含 Greeter 所定义的方法。

(假如你没有在系统里安装 gRPC 插件和 protoc ，并且仅仅是要看一下这个例子，你可以跳过这一步，直接到下一步来查看生成的代码。)
生成客户端和服务端接口，运行：

make helloworld.grpc.pb.cc helloworld.pb.cc

这从内部调用 protocol buffer 编译器：

$ protoc -I …/…/protos/ --grpc_out=. --plugin=protoc-gen-grpc=grpc_cpp_plugin …/…/protos/helloworld.proto
$ protoc -I …/…/protos/ --cpp_out=. …/…/protos/helloworld.proto

生成：
helloworld.pb.h 声明了用于填充、序列化、提取 HelloRequest 和 HelloResponse 消息类型的类，并且还有它的实现 helloworld.pb.cc 。
helloworld.grpc.pb.h，声明了我们生成的服务类和它的实现 helloworld.grpc.pb.cc 。

写一个服务器

现在让我们写点代码！首先我们将创建一个服务应用来实现服务(你会记起来，我们可以是使用除了Objective-C and PHP 外的其他所有语言来实现)。
greeter_server.cc 实现了 Greeter 服务所需要的行为。
正如你所见，GreeterServiceImpl 类通过实现 sayHello 方法，实现了从 proto 服务定义生成的Greeter：：Service 接口 。

class GreeterServiceImpl final ： public Greeter：：Service {
Status SayHello(ServerContext* context, const HelloRequest* request,
                HelloReply* reply) override {
  std：：string prefix("Hello ");
  reply->set_message(prefix + request->name());
  return Status：：OK;
}
};

在此我们实现同步版本的 Greeter，它提供了默认的 gRPC 服务行为（这里也有一个异步的接口，Greeter：：AsyncService）。
sayHello 有三个参数：

• ServerContext： RPC上下文对象。
• HelloRequest ： 请求。
• HelloReply ：应答。
  为了返回给客户端应答并且完成调用：
  用我们的激动人心的消息构建并填充一个在我们接口定义的 HelloReply 应答对象。
  将 Status::OK 返回给客户端，表明我们已经完成了对 RPC 的处理。

服务端实现

需要提供一个 gRPC 服务的另一个主要功能是让这个服务实在在网络上可用。
greeter_server.cc 提供了以下代码作为 C++ 的例子。

void RunServer() {
std：：string server_address("124.0.0.1：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();
}

写一个客户端

客户端的 gRPC 非常简单。在这一步，我们将用生成的代码写一个简单的客户程序来访问我们在上一节里创建的 Greeter 服务器。

连接服务
首先我们看一下我们如何连接 Greeter 服务器。我们需要创建一个 gRPC 频道，指定我们要连接的主机名和服务器端口。然后我们用这个频道创建存根实例。

int main(int argc, char** argv) {
GreeterClient greeter(
    grpc：：CreateChannel("localhost：50051", grpc：：InsecureCredentials(),
                        ChannelArguments()));
...
}
...
class GreeterClient {
public：
GreeterClient(std：：shared_ptr<ChannelInterface> channel)
    ： stub_(Greeter：：NewStub(channel)) {}
...
private：
std：：unique_ptr<Greeter：：Stub> stub_;
};

调用 RPC

现在我们可以联系服务并获得一个 greeting ：

• 我们创建并填充一个 HelloRequest 发送给服务。
• 我们用请求调用存根的 SayHello()，如果 RPC 成功，会得到一个填充的 HelloReply ，从其中我们可以获得 greeting。

std：：string SayHello(const std：：string& user) {
  HelloRequest request;
  request.set_name(user);
  HelloReply reply;
  ClientContext context;
  Status status = stub_->SayHello(&context, request, &reply);
  if (status.ok()) {
    return reply.message();
  } else {
    return "Rpc failed";
  }
}

你可以在 greeter_client.cc 里查看完整的客户端代码。
你可以尝试用同一个语言在客户端和服务端构建并运行例子。或者你可以尝试 gRPC 最有用的一个功能 - 不同的语言间的互操作性，即在不同的语言运行客户端和服务端。每个服务端和客户端使用从同一过 proto 文件生成的接口代码，则意味着任何 Greeter 客户端可以与任何 Greeter 服务端对话。