快速入门

本指南通过一个简单的示例,帮助您开始使用 PHP 中的 gRPC。

快速入门

本指南通过一个简单的示例,帮助您开始使用 PHP 中的 gRPC。

先决条件

  • PHP 7.0 或更高版本,PECL,Composer
  • grpc 扩展,Protocol Buffers 编译器:有关安装说明,请参阅 gRPC PHP README

获取示例代码

示例代码是 grpc 仓库的一部分。

  1. 克隆 grpc 仓库及其子模块

    git clone --recurse-submodules -b v1.74.0 --depth 1 --shallow-submodules https://github.com/grpc/grpc
    
  2. 切换到快速入门示例目录

    cd grpc/examples/php
    
  3. 安装 grpc Composer 包

    ./greeter_proto_gen.sh
    composer install
    

运行示例

  1. 启动快速入门服务器:例如,按照 Node 快速入门中给出的说明操作。

  2. examples/php 目录下,运行 PHP 客户端

    ./run_greeter_client.sh
    

恭喜!您刚刚运行了一个使用 gRPC 的客户端-服务器应用程序。

更新 gRPC 服务

现在,让我们看看如何通过服务器上的额外方法来更新应用程序,供客户端调用。我们的 gRPC 服务是使用 Protocol Buffers 定义的;您可以在基础教程中找到更多关于如何在 .proto 文件中定义服务的信息。目前您只需要知道,服务器和客户端的“存根”都有一个 SayHello RPC 方法,它接收客户端的 HelloRequest 参数并返回服务器的 HelloResponse,并且该方法定义如下

// The greeting 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;
}

让我们更新它,使 Greeter 服务有两个方法。编辑 examples/protos/helloworld.proto 并使用一个新的 SayHelloAgain 方法进行更新,该方法具有相同的请求和响应类型

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  // Sends another greeting
  rpc SayHelloAgain (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 代码

接下来,我们需要更新应用程序使用的 gRPC 代码,以使用新的服务定义。在 grpc 根目录下

protoc --proto_path=examples/protos \
  --php_out=examples/php \
  --grpc_out=examples/php \
  --plugin=protoc-gen-grpc=bins/opt/grpc_php_plugin \
  ./examples/protos/helloworld.proto

或者,如果您通过源代码构建 grpc-php-plugin,则在 grpc/example/php 目录下运行辅助脚本

./greeter_proto_gen.sh

这将重新生成 protobuf 文件,其中包含我们生成的客户端类,以及用于填充、序列化和检索我们的请求和响应类型的类。

更新并运行应用程序

我们现在有了新的生成客户端代码,但我们仍然需要在示例应用程序的手写部分中实现并调用新方法。

更新服务器

在同一目录下,打开 greeter_server.js。按如下方式实现新方法

function sayHello(call, callback) {
  callback(null, {message: 'Hello ' + call.request.name});
}

function sayHelloAgain(call, callback) {
  callback(null, {message: 'Hello again, ' + call.request.name});
}

function main() {
  var server = new grpc.Server();
  server.addProtoService(hello_proto.Greeter.service,
                         {sayHello: sayHello, sayHelloAgain: sayHelloAgain});
  server.bind('0.0.0.0:50051', grpc.ServerCredentials.createInsecure());
  server.start();
}
...

更新客户端

在同一目录下,打开 greeter_client.php。按如下方式调用新方法

$request = new Helloworld\HelloRequest();
$request->setName($name);
list($reply, $status) = $client->SayHello($request)->wait();
$message = $reply->getMessage();
list($reply, $status) = $client->SayHelloAgain($request)->wait();
$message = $reply->getMessage();

运行!

就像我们之前做的那样,在 grpc-node/examples/helloworld/dynamic_codegen 目录下

  1. 运行服务器

    node greeter_server.js
    
  2. 从另一个终端,在 examples/php 目录下,运行客户端

    ./run_greeter_client.sh
    

接下来