php在windows使用grpc和protobuf入门（超详细）

置顶 Shaw同学

已于 2023-03-27 15:07:36 修改

阅读量1.7k

点赞数 1

分类专栏： PHP 笔记大全文章标签： php 开发语言

于 2023-03-27 01:20:11 首次发布

本文链接：https://blog.csdn.net/qq_31065757/article/details/129787461

版权

笔记大全同时被 2 个专栏收录

6 篇文章 0 订阅

订阅专栏

PHP

5 篇文章 0 订阅

订阅专栏

背景：php作为客户端使用grpc和protobuf调用其他服务

1、自己先了解：grpc、protobuf

2、环境：php7.3、composer

设置php全局变量

php -version查看PHP版本是php7.3.4nts，所以要选（NTS）那个

3、给php安装grpc扩展

下载grpc扩展：

PECL :: Package :: gRPC 1.42.0 for Windows

或者根据自己的php版本去库里选择：https://pecl.php.net/package/gRPC

下载后解压，把php_grpc.dll这个文件复制到php\php7.3.4nts\ext这个目录下

找到php.ini这个文件加入 extension=php_grpc.dll

phpstorm终端输入php -m 查看扩展是否安装成功；

或者用 var_dump(phpinfo()); 看看有没有

4、新建项目目录：protobuf_test

引入grpc和protobuf的PHP类库，在目录下新建文件composer.json，如下：

{
    "name": "xxs/grpc",
    "require": {
        "grpc/grpc": "^v1.4.0",
        "google/protobuf": "^v3.3.0"
    },
    "autoload":{
        "psr-4":{
            "GPBMetadata\\":"GPBMetadata/",
            "Helloworld\\":"Helloworld/"
        }
    }
}

【composer 需配置全局变量】在目录下执行composer install

顺带执行：composer dump-autoload

如下图，我这里执行完是1.52.0和3.22.2，composer ^ 符号的解释：php composer 版本号 ^ 与～_小镇学者的博客-CSDN博客

5、下载protoc.exe可执行程序

Releases · protocolbuffers/protobuf · GitHub

我下载的v22.2：https://github.com/protocolbuffers/protobuf/releases/download/v22.2/protoc-22.2-win64.zip

解压后复制bin目录的路径，去配置全局变量，我的是D:\protoc22.2\bin

win+R打开cmd查看：protoc --version

6、万事具备，只欠东风！！！

官方的grpc未提供windows下的php plugin的exe文件，这个用来生成客户端文件，看了一堆博客，几乎没有这一步……

去这里下载 https://github.com/lifenglsf/grpc_for_windows

解压复制到项目底下grpc_for_windows/x64/grpc_php_plugin.exe

7、新建文件protobuf_test/helloworld.proto

syntax = "proto3";
package helloworld;

// The greeting service definition.
service Greeter {
  // Sends a greeting
  rpc SayHello (HelloRequest) returns (HelloReply) {}

  rpc SayHelloStreamReply (HelloRequest) returns (stream 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;
}

8、终端protobuf_test下执行命令

protoc --proto_path=. --php_out=. --grpc_out=. --plugin=protoc-gen-grpc=./grpc_for_windows/x64/grpc_php_plugin.exe ./helloworld.proto

生成代码结构，如果没有grpc_php_plugin.exe这个插件是不会生成GreeterClient.php这个客户端文件的，我们的目的就是用php作为客户端调用服务的！

9、为了方便测试自己搞个测试服

定义服务protobuf_test/Helloworld/GreeterStub.php,如上图；代码如下:

<?php
namespace Helloworld;
/**
 * The greeting service definition.
 */
class GreeterStub {
    /**
     * Sends a greeting
     * @param \Helloworld\HelloRequest $request client request
     * @param \Grpc\ServerContext $context server request context
     * @return \Helloworld\HelloReply for response data, null if if error occured
     *     initial metadata (if any) and status (if not ok) should be set to $context
     */
    public function SayHello(
        \Helloworld\HelloRequest $request,
        \Grpc\ServerContext $context
    ): ?\Helloworld\HelloReply {
        $context->setStatus(\Grpc\Status::unimplemented());
        return null;
    }

    /**
     * Get the method descriptors of the service for server registration
     *
     * @return array of \Grpc\MethodDescriptor for the service methods
     */
    public final function getMethodDescriptors(): array
    {
        return [
            '/helloworld.Greeter/SayHello' => new \Grpc\MethodDescriptor(
                $this,
                'SayHello',
                '\Helloworld\HelloRequest',
                \Grpc\MethodDescriptor::UNARY_CALL
            ),
        ];
    }
}
实现这个服务，protobuf_test/server.php

<?php
require dirname(__FILE__) . '/vendor/autoload.php';
class Greeter extends Helloworld\GreeterStub
{
    public function SayHello(
        \Helloworld\HelloRequest $request,
        \Grpc\ServerContext $serverContext
    ): ?\Helloworld\HelloReply {
        $name = $request->getName();
        echo 'Received request: ' . $name . PHP_EOL;
        $response = new \Helloworld\HelloReply();
        $response->setMessage("Hello " . $name);
        return $response;
    }
}
$port = 50051;
$server = new \Grpc\RpcServer();
$server->addHttp2Port('0.0.0.0:'.$port);
$server->handle(new Greeter());
echo 'Listening on port :' . $port . PHP_EOL;
$server->run();

10、protobuf_test/client.php 调用服务

<?php
require dirname(__FILE__) . '/vendor/autoload.php';
function greet($hostname, $name)
{
    $client = new Helloworld\GreeterClient($hostname, [
        'credentials' => Grpc\ChannelCredentials::createInsecure(),
    ]);
    $request = new Helloworld\HelloRequest();
    $request->setName($name);
    list($response, $status) = $client->SayHello($request)->wait();
    if ($status->code !== Grpc\STATUS_OK) {
        echo "ERROR: " . $status->code . ", " . $status->details . PHP_EOL;
        exit(1);
    }
    echo $response->getMessage() . PHP_EOL;
}
$name = !empty($argv[1]) ? $argv[1] : 'world';
$hostname = !empty($argv[2]) ? $argv[2] : 'localhost:50051';
greet($hostname, $name);

11、最终文件结构