如何使用 PHP gRPC 扩展替代 grpcurl 命令行调用

本文详解如何通过 php grpc pecl 扩展(非纯 php 实现)原生调用 grpc 服务,替代 shell_exec 调用 grpcurl 的方式,重点说明协议缓冲区代码生成的必要性与正确接入流程。

直接使用 BaseStub 手动构造请求并调用 _simpleRequest 是不可行的——PHP gRPC PECL 扩展不支持运行时动态解析 .proto 文件或手动序列化 JSON 字符串为 Protocol Buffer 二进制格式。它严格依赖由 .proto 文件生成的、类型安全的 PHP 客户端类(含 request/response 消息类和 service stub),所有序列化/反序列化、HTTP/2 传输、TLS 处理均由扩展底层(C++ core)自动完成。

因此,核心步骤不是“手写 stub”,而是:基于 extranet.proto 生成符合 gRPC PECL 规范的 PHP 类文件。推荐使用官方支持的代码生成工具链:

✅ 正确流程:生成强类型客户端代码

  1. 确保环境已安装 protoc 编译器(v3.15+ 推荐)
    下载地址:https://www./link/8e488eaf07b841e692fc4fe103e7b254

  2. 安装 PHP gRPC 插件(已做)
    确认 extension=grpc 已启用,且 php -m | grep grpc 可见输出。

  3. 使用 protoc + gRPC PHP 插件生成代码

    ⚠️ 注意:不能使用 protobuf-php/protobuf-plugin(该库面向纯 PHP 实现,与 PECL gRPC 不兼容);必须使用 grpc_php_plugin。
    # Linux/macOS 示例(Windows 同理,需确保 protoc 和插件在 PATH 中)
    protoc \
      --php_out=src/ \
      --grpc_out=src/ \
      --plugin=protoc-gen-grpc=/path/to/grpc_php_plugin \
      -I . \
      extranet.proto

    ✅ grpc_php_plugin 下载地址:https://www./link/6d1eda42e54a1c2b1083d901f073529a
    (Windows 用户请下载对应平台的 grpc_php_plugin.exe)

  4. 生成结果结构示例
    假设 extranet.proto 中定义了 service BuscaEmpresa 和 rpc Login(LoginRequest) returns (LoginResponse),则生成:

    src/
    └── Extranet/
        ├── V0/
        │   ├── BuscaEmpresaClient.php    # Stub 客户端类
        │   ├── LoginRequest.php          # 请求消息类(含 setUsuario()/setSenha())
        │   └── LoginResponse.php         # 响应消息类
        └── ...
  5. 在 PHP 中调用(完整可运行示例)

     \Grpc\ChannelCredentials::createInsecure()
        ]
    );
    
    // 构造强类型请求对象
    $request = new LoginRequest();
    $request->setUsuario('user');
    $request->setSenha('pass');
    
    // 发起 RPC 调用
    list($response, $status) = $client->Login($request)->wait();
    
    if ($status->code === \Grpc\STATUS_OK) {
        echo "Success:\n";
        var_dump($response->serializeToJsonString()); // 或直接 getXXX() 访问字段
    } else {
        echo "gRPC Error: {$status->details} (code: {$status->code})\n";
    }

❗ 关键注意事项

  • 绝不手动拼接 JSON 或字符串:gRPC 协议要求二进制 Protocol Buffer 序列化,JSON 只是调试表示,serializeToString() 返回的是二进制数据,不是 JSON 字符串。
  • .proto 必须准确:服务端使用的 .proto 版本、包名(package extranet.v0;)、服务路径(extranet.v0.BuscaEmpresa)必须与生成代码完全一致。
  • Windows 路径与权限:确保 protoc 和 grpc_php_plugin.exe 具有执行权限,且路径不含空格或中文。
  • 错误排查建议:开启 gRPC 日志辅助调试:
    putenv('GRPC_VERBOSITY=DEBUG');
    putenv('GRPC_TRACE=all');

遵循此流程,即可完全替代 shell_exec('grpcurl.exe ...'),获得更高性能、更强类型安全及更优的错误处理能力。