PHP 怎么PHP gRPC 协议

wen PHP项目 2026-07-31 182

本文目录导读：

PHP 怎么PHP gRPC 协议

安装 gRPC 扩展
定义 Proto 文件
生成 PHP 代码
创建 gRPC 服务器
创建 gRPC 客户端
异步调用
流式调用
错误处理和重试
性能优化建议
使用示例 - 完整的配置
常见问题与解决

我来详细讲解 PHP 中使用 gRPC 协议的完整流程：

安装 gRPC 扩展

使用 PECL 安装

# 安装 gRPC 扩展
pecl install grpc
# 安装 protobuf 扩展（推荐）
pecl install protobuf

在 php.ini 中添加

extension=grpc.so
extension=protobuf.so

使用 Composer 安装依赖

composer require grpc/grpc
composer require google/protobuf

定义 Proto 文件

创建 hello.proto 文件：

syntax = "proto3";
package helloworld;
service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply) {}
}
message HelloRequest {
  string name = 1;
}
message HelloReply {
  string message = 1;
}

生成 PHP 代码

安装 protoc 编译器

# 安装 protoc
apt-get install -y protobuf-compiler
# 安装 PHP 插件
composer require grpc/grpc

生成代码

protoc --php_out=generated/ \
       --grpc_out=generated/ \
       --plugin=protoc-gen-grpc=/usr/local/bin/grpc_php_plugin \
       hello.proto

生成的代码结构：

generated/
├── GPBMetadata/
│   └── Hello.php
├── Helloworld/
│   ├── GreeterClient.php
│   ├── GreeterStub.php
│   ├── HelloRequest.php
│   └── HelloReply.php

创建 gRPC 服务器

<?php
// server.php
require_once 'vendor/autoload.php';
require_once 'generated/autoload.php';
use Grpc\Server;
use Helloworld\GreeterStub;
use Helloworld\HelloReply;
use Helloworld\HelloRequest;
class GreeterService extends GreeterStub
{
    public function SayHello(HelloRequest $request, $context)
    {
        // 创建响应
        $reply = new HelloReply();
        $reply->setMessage('Hello ' . $request->getName());
        // 设置状态码
        $context->setStatus(\Grpc\Status::OK, '');
        return $reply;
    }
}
// 创建服务器
$server = new Server();
$server->addHttp2Port('0.0.0.0:50051');
// 注册服务
$service = new GreeterService();
$server->addService($service);
// 启动服务器
$server->start();
echo "gRPC server started on port 50051\n";
// 等待请求
$server->wait();

创建 gRPC 客户端

<?php
// client.php
require_once 'vendor/autoload.php';
require_once 'generated/autoload.php';
use Helloworld\GreeterClient;
use Helloworld\HelloRequest;
// 创建客户端
$client = new GreeterClient('localhost:50051', [
    'credentials' => \Grpc\ChannelCredentials::createInsecure(),
]);
// 创建请求
$request = new HelloRequest();
$request->setName('World');
// 调用 RPC
list($reply, $status) = $client->SayHello($request)->wait();
if ($status->code === \Grpc\STATUS_OK) {
    echo "Response: " . $reply->getMessage() . "\n";
} else {
    echo "Error: " . $status->details . "\n";
}

异步调用

<?php
// async_client.php
require_once 'vendor/autoload.php';
require_once 'generated/autoload.php';
use Helloworld\GreeterClient;
use Helloworld\HelloRequest;
$client = new GreeterClient('localhost:50051', [
    'credentials' => \Grpc\ChannelCredentials::createInsecure(),
]);
$request = new HelloRequest();
$request->setName('Async User');
// 异步调用
$call = $client->SayHello($request);
// 等待响应（非阻塞）
$call->wait();
// 或者设置超时
$call->setDeadline(time() + 5); // 5秒超时
// 获取响应
list($reply, $status) = $call->wait();
if ($status->code === \Grpc\STATUS_OK) {
    echo "Async Response: " . $reply->getMessage() . "\n";
}

流式调用

服务端流式（Server Streaming）

service Greeter {
  rpc SayHellos (HelloRequest) returns (stream HelloReply) {}
}

// 服务端
public function SayHellos(HelloRequest $request, $context)
{
    $names = ['First', 'Second', 'Third', 'Fourth'];
    foreach ($names as $name) {
        $reply = new HelloReply();
        $reply->setMessage("Hello $name, from " . $request->getName());
        yield $reply;
    }
}

客户端流式

service Greeter {
  rpc SayMultipleHellos (stream HelloRequest) returns (HelloReply) {}
}

// 客户端
$call = $client->SayMultipleHellos();
$names = ['First', 'Second', 'Third', 'Fourth'];
foreach ($names as $name) {
    $request = new HelloRequest();
    $request->setName($name);
    $call->write($request);
}
// 完成写入
$call->writesDone();
// 获取响应
list($reply, $status) = $call->wait();
echo "Response: " . $reply->getMessage() . "\n";

错误处理和重试

<?php
// error_handling.php
use Grpc\ChannelCredentials;
use Grpc\Interceptor;
class RetryInterceptor extends Interceptor
{
    private $maxRetries;
    public function __construct($maxRetries = 3)
    {
        $this->maxRetries = $maxRetries;
    }
    public function newClientStreamingCall($method, $argument, $deserialize, $metadata, $options)
    {
        return parent::newClientStreamingCall($method, $argument, $deserialize, $metadata, $options);
    }
}
$client = new GreeterClient('localhost:50051', [
    'credentials' => ChannelCredentials::createInsecure(),
    'interceptors' => [new RetryInterceptor()],
    'timeout' => 5000, // 5秒超时
]);
try {
    $request = new HelloRequest();
    $request->setName('World');
    list($reply, $status) = $client->SayHello($request)->wait();
    if ($status->code !== \Grpc\STATUS_OK) {
        throw new Exception("gRPC error: {$status->details}");
    }
    echo $reply->getMessage();
} catch (Exception $e) {
    echo "Error: " . $e->getMessage() . "\n";
}

性能优化建议

<?php
// 配置连接池和性能参数
$client = new GreeterClient('localhost:50051', [
    // 使用安全连接（生产环境）
    'credentials' => \Grpc\ChannelCredentials::createSsl(
        file_get_contents('ca.pem')
    ),
    // 连接选项
    'grpc.primary_user_agent' => 'PHP gRPC Client',
    'grpc.max_receive_message_length' => 10 * 1024 * 1024, // 10MB
    'grpc.max_send_message_length' => 10 * 1024 * 1024,
    'grpc.keepalive_time_ms' => 10000,
    'grpc.keepalive_timeout_ms' => 5000,
    'grpc.enable_retries' => 1,
    'grpc.max_reconnect_backoff_ms' => 3000,
    'grpc.min_reconnect_backoff_ms' => 500,
]);

使用示例 - 完整的配置

<?php
// config.php
return [
    'grpc' => [
        'server' => [
            'host' => '0.0.0.0',
            'port' => 50051,
        ],
        'client' => [
            'credentials' => \Grpc\ChannelCredentials::createInsecure(),
            'options' => [
                'timeout' => 5000,
                'retry' => 3,
                'interceptors' => [],
            ],
        ],
        'path' => [
            'proto_dir' => __DIR__ . '/proto',
            'generated_dir' => __DIR__ . '/generated',
        ],
    ],
];