基础教程

本教程为 Ruby 开发人员提供了一个使用 gRPC 的基础入门指南。

通过此示例，您将学习如何

• 在 .proto 文件中定义服务。
• 使用协议缓冲区编译器生成服务器和客户端代码。
• 通过使用 Ruby gRPC API，为您自己的服务编写一个简单的客户端和服务器。

本教程假设您已经阅读过 gRPC 简介，并且熟悉 Protocol Buffers。请注意，本教程中的示例使用的是 proto3 版本的 Protocol Buffers 语言：您可以在 proto3 语言指南 中了解更多信息。

为什么使用 gRPC？

我们的示例是一个简单的路线映射应用程序，它允许客户端获取其路线上特征的信息，创建其路线摘要，并与服务器及其他客户端交换路线信息（例如交通更新）。

使用 gRPC，我们可以一次在 .proto 文件中定义服务，并生成 gRPC 支持的任何语言的客户端和服务器。这些客户端和服务器可以在各种环境中运行，从大型数据中心内的服务器到您的平板电脑，应有尽有——不同语言和环境之间通信的所有复杂性都由 gRPC 为您处理。我们还可以获得使用 Protocol Buffers 的所有优势，包括高效的序列化、简单的 IDL 和易于更新的接口。

示例代码和设置

本教程的示例代码位于 grpc/grpc/examples/ruby/route_guide。要下载该示例，请运行以下命令克隆 grpc 仓库：

git clone -b v1.78.1 --depth 1 --shallow-submodules https://github.com/grpc/grpc
cd grpc

然后将当前目录切换到 examples/ruby/route_guide：

cd examples/ruby/route_guide

您还应该安装生成服务器和客户端接口代码的相关工具——如果尚未安装，请按照快速入门中的设置说明进行操作。

定义服务

我们的第一步（您从 gRPC 简介 中应该已经知道）是使用 Protocol Buffers 来定义 gRPC 服务以及方法请求和响应类型。您可以在 examples/protos/route_guide.proto 中查看完整的 .proto 文件。

要定义服务，请在您的 .proto 文件中指定一个命名的service

service RouteGuide {
   ...
}

然后，您在服务定义中定义 rpc 方法，并指定它们的请求和响应类型。gRPC 允许您定义四种服务方法，所有这些方法都在 RouteGuide 服务中使用

• 简单 RPC：客户端使用存根向服务器发送请求，并等待响应返回，就像普通的函数调用一样。

  // Obtains the feature at a given position.
  rpc GetFeature(Point) returns (Feature) {}
  

• 服务端流式 RPC：客户端向服务器发送请求，并获得一个用于读取一系列消息的流。客户端会读取返回的流，直到没有更多消息为止。正如您在我们的示例中所见，通过在响应类型前放置 stream 关键字，可以指定服务端流式方法。

  // Obtains the Features available within the given Rectangle.  Results are
  // streamed rather than returned at once (e.g. in a response message with a
  // repeated field), as the rectangle may cover a large area and contain a
  // huge number of features.
  rpc ListFeatures(Rectangle) returns (stream Feature) {}
  

• 客户端流式 RPC：客户端写入一系列消息并通过提供的流发送给服务器。一旦客户端完成了消息写入，它将等待服务器读取所有消息并返回其响应。通过在请求类型前放置 stream 关键字，可以指定客户端流式方法。

  // Accepts a stream of Points on a route being traversed, returning a
  // RouteSummary when traversal is completed.
  rpc RecordRoute(stream Point) returns (RouteSummary) {}
  

• 双向流式 RPC：双方都使用读写流发送一系列消息。这两个流独立操作，因此客户端和服务器可以按任何他们喜欢的顺序读取和写入：例如，服务器可以等待接收所有客户端消息后再写入其响应，或者交替读取一条消息然后写入一条消息，亦或是其他读写组合。每条流中消息的顺序都会得到保留。通过在请求和响应之前都放置 stream 关键字，可以指定这种类型的方法。

  // Accepts a stream of RouteNotes sent while a route is being traversed,
  // while receiving other RouteNotes (e.g. from other users).
  rpc RouteChat(stream RouteNote) returns (stream RouteNote) {}
  

我们的 .proto 文件还包含我们服务方法中使用的所有请求和响应类型的协议缓冲区消息类型定义——例如，这是 Point 消息类型

// Points are represented as latitude-longitude pairs in the E7 representation
// (degrees multiplied by 10**7 and rounded to the nearest integer).
// Latitudes should be in the range +/- 90 degrees and longitude should be in
// the range +/- 180 degrees (inclusive).
message Point {
  int32 latitude = 1;
  int32 longitude = 2;
}

生成客户端和服务器代码

接下来，我们需要从 .proto 服务定义中生成 gRPC 客户端和服务器接口。我们使用 Protocol Buffer 编译器 protoc 配合专用的 gRPC Ruby 插件来完成此操作。

如果您想亲自运行此示例，请确保已安装 gRPC 和 protoc。

一旦完成，可以使用以下命令来生成 Ruby 代码。

grpc_tools_ruby_protoc -I ../../protos --ruby_out=../lib --grpc_out=../lib ../../protos/route_guide.proto

运行此命令会在 lib 目录下重新生成以下文件：

• lib/route_guide.pb 定义了一个模块 Examples::RouteGuide
  • 该文件包含所有用于填充、序列化和检索请求与响应消息类型的 Protocol Buffer 代码。
• lib/route_guide_services.pb 将 Examples::RouteGuide 扩展为包含存根（stub）和服务类。
  • 一个 Service 类，在定义 RouteGuide 服务实现时可用作基类。
  • 一个 Stub 类，可用于访问远程 RouteGuide 实例。

创建服务器

首先让我们看看如何创建一个 RouteGuide 服务器。如果您只对创建 gRPC 客户端感兴趣，您可以跳过此部分并直接跳到创建客户端（尽管您可能仍然会觉得它很有趣！）。

使我们的 RouteGuide 服务正常工作需要两部分

• 实现从我们的服务定义生成的服务接口：完成我们服务的实际“工作”。
• 运行 gRPC 服务器以侦听来自客户端的请求并返回服务响应。

您可以在 examples/ruby/route_guide/route_guide_server.rb 中找到我们的 RouteGuide 服务器示例。让我们仔细看看它是如何工作的。

实现 RouteGuide

如您所见，我们的服务器有一个继承自生成的 RouteGuide::Service 的 ServerImpl 类。

# ServerImpl provides an implementation of the RouteGuide service.
class ServerImpl < RouteGuide::Service

ServerImpl 实现了我们所有的服务方法。让我们先看看最简单的类型 GetFeature，它从客户端获取一个 Point，并从其数据库中返回相应的 Feature 信息。

def get_feature(point, _call)
  name = @feature_db[{
    'longitude' => point.longitude,
    'latitude' => point.latitude }] || ''
  Feature.new(location: point, name: name)
end

该方法接收一个 RPC 调用上下文（_call）、客户端的 Point Protocol Buffer 请求，并返回一个 Feature Protocol Buffer。在方法内部，我们创建带有适当信息的 Feature，然后将其 return。

现在让我们看看稍微复杂一点的内容 —— 流式 RPC。ListFeatures 是一个服务端流式 RPC，因此我们需要向客户端发送多个 Feature。

# in ServerImpl

  def list_features(rectangle, _call)
    RectangleEnum.new(@feature_db, rectangle).each
  end

如您所见，这里的请求对象是一个 Rectangle，客户端希望在其中查找 Feature。但我们返回的不是一个简单的响应，而是需要返回一个 Enumerator 来生成响应。在该方法中，我们使用辅助类 RectangleEnum 作为 Enumerator 的实现。

类似地，客户端流式处理方法 record_route 使用了一个 Enumerable，但这里它是从调用对象中获取的（我们在前面的例子中忽略了这一点）。call.each_remote_read 会依次获取客户端发送的每条消息。

call.each_remote_read do |point|
  ...
end

最后，让我们看看我们的双向流式 RPC route_chat。

def route_chat(notes)
  RouteChatEnumerator.new(notes, @received_notes).each_item
end

这里该方法接收一个 Enumerable，同时也返回一个 Enumerator 来生成响应。尽管每一方收到的消息顺序与其写入的顺序一致，但客户端和服务器都可以以任何顺序进行读写 —— 这两个流的操作是完全独立的。

启动服务器

一旦我们实现了所有方法，我们还需要启动一个 gRPC 服务器，以便客户端能够实际使用我们的服务。以下代码片段展示了我们如何为 RouteGuide 服务执行此操作

port = '0.0.0.0:50051'
s = GRPC::RpcServer.new
s.add_http2_port(port, :this_port_is_insecure)
GRPC.logger.info("... running insecurely on #{port}")
s.handle(ServerImpl.new(feature_db))
# Runs the server with SIGHUP, SIGINT and SIGQUIT signal handlers to
#   gracefully shutdown.
# User could also choose to run server via call to run_till_terminated
s.run_till_terminated_or_interrupted([1, 'int', 'SIGQUIT'])

如您所见，我们使用 GRPC::RpcServer 来构建并启动服务器。具体步骤如下：

1. 创建我们的服务实现类 ServerImpl 的实例。
2. 使用构建器的 add_http2_port 方法指定我们要监听客户端请求的地址和端口。
3. 将我们的服务实现注册到 GRPC::RpcServer。
4. 在 GRPC::RpcServer 上调用 run，为我们的服务创建并启动一个 RPC 服务器。

创建客户端

在本节中，我们将介绍如何为我们的 RouteGuide 服务创建 Ruby 客户端。您可以在 examples/ruby/route_guide/route_guide_client.rb 中查看我们完整的示例客户端代码。

创建存根

要调用服务方法，我们首先需要创建一个存根。

我们使用从 .proto 文件生成的 RouteGuide 模块中的 Stub 类。

stub = RouteGuide::Stub.new('localhost:50051')

调用服务方法

现在让我们看看如何调用服务方法。请注意，gRPC Ruby 仅提供每个方法的阻塞/同步版本：这意味着 RPC 调用会等待服务器响应，并最终返回响应或抛出异常。

简单 RPC

调用简单的 RPC GetFeature 几乎与调用本地方法一样简单。

GET_FEATURE_POINTS = [
  Point.new(latitude:  409_146_138, longitude: -746_188_906),
  Point.new(latitude:  0, longitude: 0)
]
..
  GET_FEATURE_POINTS.each do |pt|
    resp = stub.get_feature(pt)
	...
    p "- found '#{resp.name}' at #{pt.inspect}"
  end

如您所见，我们创建并填充一个请求 Protocol Buffer 对象（在本例中为 Point），并创建一个供服务器填写的响应 Protocol Buffer 对象。最后，我们在存根上调用该方法，并传入上下文、请求和响应对象。如果该方法返回 OK，我们就可以从响应对象中读取服务器返回的信息。

流式 RPC

现在让我们看看我们的流式方法。如果您已经阅读过 创建服务器，这部分内容可能看起来非常熟悉 —— 流式 RPC 在两端的实现方式是相似的。以下是我们调用服务端流式处理方法 list_features 的方式，它返回一个 Features 的 Enumerable。

resps = stub.list_features(LIST_FEATURES_RECT)
resps.each do |r|
  p "- found '#{r.name}' at #{r.location.inspect}"
end

通过多线程和 return_op: true 标志，可以实现 RPC 流的非阻塞使用。当传入 return_op: true 标志时，RPC 的执行会被延迟，并返回一个 Operation 对象。之后可以通过调用操作的 execute 函数在另一个线程中执行该 RPC。主线程可以利用诸如 status、cancelled? 和 cancel 等上下文方法和获取器来管理 RPC。这对于那些如果阻塞主线程会造成不可接受时间开销的持久性或长时运行的 RPC 会话非常有用。

op = stub.list_features(LIST_FEATURES_RECT, return_op: true)
Thread.new do 
  resps = op.execute
  resps.each do |r|
    p "- found '#{r.name}' at #{r.location.inspect}"
  end
rescue GRPC::Cancelled => e
  p "operation cancel called - #{e}"
end

# controls for the operation
op.status
op.cancelled?
op.cancel # attempts to cancel the RPC with a GRPC::Cancelled status; there's a fundamental race condition where cancelling the RPC can race against RPC termination for a different reason - invoking `cancel` doesn't necessarily guarantee a `Cancelled` status

客户端流式处理方法 record_route 与此类似，区别在于我们需要向服务器传入一个 Enumerable。

...
reqs = RandomRoute.new(features, points_on_route)
resp = stub.record_route(reqs.each)
...

最后，让我们看看我们的双向流式 RPC route_chat。在这种情况下，我们向方法传入一个 Enumerable 并返回一个 Enumerable。

sleeping_enumerator = SleepingEnumerator.new(ROUTE_CHAT_NOTES, 1)
stub.route_chat(sleeping_enumerator.each_item) { |r| p "received #{r.inspect}" }

尽管该示例未充分展示，但每个 Enumerable 都是相互独立的 —— 客户端和服务器都可以以任何顺序进行读写 —— 这两个流的操作是完全独立的。

尝试一下！

在示例目录下进行操作

cd examples/ruby

构建客户端和服务器

gem install bundler && bundle install

运行服务器

bundle exec route_guide/route_guide_server.rb ../python/route_guide/route_guide_db.json

在另一个终端中，运行客户端

bundle exec route_guide/route_guide_client.rb ../python/route_guide/route_guide_db.json