OpenMix 出品:https://openmix.org
PHP gRPC based on Swoole coroutine, including protoc code generator, server, and client
基于 Swoole 协程的 PHP gRPC 库,包含 protoc 代码生成器、服务器、客户端
由于 PHP-FPM 的特殊生命周期,导致 PHP 的 gRPC 官方代码生成器只能生成数据结构和客户端代码,无法像 golang/node.js/python 一样能同时生成服务器代码;传统方式如果要搭建 PHP gRPC 服务器只能借助 nginx+h2+phpfpm 来搭建,这样就不需要 server 代码了,但是短生命周期又无法很好的支持服务注册,因为这些原因导致 PHP 在 gRPC 中一直都是充当 Client 的角色,Mix gRPC 提供了基于 Swoole 的方案:
让 PHP 编写 gRPC 和 Golang 一样方便快捷,同时性能强劲
推荐搭配以下数据库使用 (支持协程和连接池):
知乎:https://www.zhihu.com/people/onanying
官方QQ群:284806582 , 825122875 敲门暗号:grpc
--enable-http2
composer require mix/grpc
以上 2 个二进制文件,我都帮你们编译好了,包含多个常用 OS 类型,直接下载即可:
win/macos/linux
下载完成后 linux、macOS 将二进制文件放入系统 /usr/local/bin
目录,win 放入 C:\WINDOWS\system32
首先我们编写一个 proto 文件:
syntax = "proto3";
package php.micro.grpc.greeter;
service Say {
rpc Hello(Request) returns (Response) {}
}
message Request {
string name = 1;
}
message Response {
string msg = 1;
}
然后使用 protoc 生成代码:
protoc --php_out=. --mix_out=. greeter.proto
执行命令后将在当前目录生成以下文件:
|-- GPBMetadata
| `-- Greeter.php
|-- Php
| `-- Micro
| `-- Grpc
| `-- Greeter
| |-- Request.php
| |-- Response.php
| |-- SayClient.php
| `-- SayInterface.php
`-- greeter.proto
其中 Request.php、Response.php 为 --php_out
生成,SayClient.php SayInterface.php 由 --mix_out
生成。
接下来我们将生成的文件加入到 composer autoload 中,我们修改 composer.json:
"autoload-dev": {
"psr-4": {
"GPBMetadata\\": "protodir/GPBMetadata/",
"Php\\": "protodir/Php/"
}
}
修改后执行 composer dump-autoload
使其生效。
我们用原生 PHP 代码来编写一个 gRPC 服务器:
// 编写一个服务,实现 protoc-gen-mix 生成的接口 class SayService implements Php\Micro\Grpc\Greeter\SayInterface { public function Hello(Mix\Grpc\Context $context, Php\Micro\Grpc\Greeter\Request $request): Php\Micro\Grpc\Greeter\Response { $response = new Php\Micro\Grpc\Greeter\Response(); $response->setMsg(sprintf('hello, %s', $request->getName())); return $response; } } $grpc = new Mix\Grpc\Server(); $grpc->register(SayService::class); // or $grpc->register(new SayService());
Swoole 多进程 (异步) 中使用
$http = new Swoole\Http\Server('0.0.0.0', 9595); $http->on('Request', $grpc->handler()); $http->set([ 'worker_num' => 4, 'open_http2_protocol' => true, 'http_compression' => false, ]); $http->start();
开启多进程协程
$http->on('Request', $grpc->handler()); $http->on('WorkerStart', function ($server, $workerId) { // 协程初始化 // 比如:启动 mix/database mix/redis 的连接池 }); $http->set([ 'enable_coroutine' => true, 'worker_num' => 4, 'open_http2_protocol' => true, 'http_compression' => false, ]);
Swoole 单进程 (协程) 中使用
Swoole\Coroutine\run(function () use ($grpc) { $server = new Swoole\Coroutine\Http\Server('0.0.0.0', 9595, false); $server->handle('/', $grpc->handler()); $server->set([ 'open_http2_protocol' => true, 'http_compression' => false, ]); $server->start(); });
通过 IP 端口调用 gRPC 服务,复用客户端时请注意:协程环境中,不可在并发请求中使用单例
Swoole\Coroutine\run(function () { $client = new Mix\Grpc\Client('127.0.0.1', 9595); // 推荐复用该客户端 $say = new Php\Micro\Grpc\Greeter\SayClient($client); $request = new Php\Micro\Grpc\Greeter\Request(); $request->setName('xiaoming'); $ctx = new Mix\Grpc\Context(); $response = $say->Hello($ctx, $request); var_dump($response->getMsg()); $client->close(); // 使用完必须关闭,否则会残留在内存 });
设置 header
$ctx->withHeader('foo', 'bar'); $response = $say->Hello($ctx, $request);
设置 timeout
$ctx->withTimeout(5.0); $response = $say->Hello($ctx, $request);
像我们传统 PHP FPM 模式中,我们作为客户端调用 gRPC 比 Mix gRPC 提供的客户端要复杂很多,但是我们也经常需要用到,比如在 thinkphp laravel 中调用 Mix gRPC 或者 Mix Go 编写的 gRPC 服务,推荐阅读以下文章:
网上的文章都缺少重要的一环,就是:
protoc --php_out=. greeter.proto
命令执行时,只会生成数据结构的 class 文件,不会生成 grpc 服务的客户端 class 文件
service Say {
rpc Hello(Request) returns (Response) {}
}
以上服务没有被处理,没有生成出 SayClient.php
,需要修改编译命令
protoc --php_out=. --grpc_out=. --plugin=protoc-gen-grpc=/path/grpc_php_plugin greeter.proto
命令中指定了一个 grpc_php_plugin
文件是由 grpc/grpc 提供的源码,官方没有像 protoc
一样提供编译好的二进制可以下载,只能自己编译。然而这个库依赖的大量的子仓库,在国内几乎无法拉取成功,其次 win 的 cmake 编译很多人不会弄,导致大量的人无法编译出这个文件,因此我这里直接提供编译好的二进制供大家下载。
win/macos/linux
Apache License Version 2.0, http://www.apache.org/licenses/
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4