reatang/grpc-php-abstract

兼容 php 的 grpc 原生客户端和 grpc-gateway 调用

0.4.0 2024-05-07 09:08 UTC

README

抽象 grpc 和 grpc-gateway

  • 提供 grpc 原生客户端和 grcp-gateway 调用的抽象层
  • 添加解析 protobuf Any 参数的工具 UtilAny
  • 一元请求重试中间件
  • 支持配置化的默认调用行为
  • 支持 OpenTelemetry 链路追踪(grpc、gateway 都已支持)
  • 开发自动生成 grpc 原生客户端抽象层 protoc-gen-php-abs-grpc
  • 开发自动生成 grpc-gateway 抽象层: --php-abs-grpc_opt=genType=gateway 则生成 gateway 抽象层

安装

> composer require reatang/grpc-php-abstract

使用

本教程假定您已经了解 protobufgrpc 的基础知识,并预先学习了 protoc-gen-php-abs-grpc 生成器的功能。

<?php

use \Path\To\ServerName\SomeServerAbsRpc;

// ... 

// 初始化php-abs-grpc生成的客户端
$client = new SomeServerAbsRpc("127.0.0.1:8080");

// 调用方法
$response = $client->ping(new \Path\To\ServerName\PB\PingRequest(['ping' => 'hello world']));

echo $response->getPong() . PHP_EOL;

业务错误信息传递方案

在 golang 的 grpc 业务处理中,一般返回值是两个:

return response, error

这第二个 error 参数如果不是标准的 grpc 错误码,则对应的 grpc 的 status 则是:code:2, details: error 的内容。那么我就可以利用这个 error 的内容做一个简单的数据格式用来携带错误。我的 details 内容格式则是:

!int:string
!错误码:错误信息

如:
!100:您的操作有误

按照这种格式传输的 details,则会自动抛出 GrpcBusinessException 异常。

注意

  • 2023-07-06:protobuf 3.23 是支持 php7.4 的最后一个版本,使用 php7.4 的同学不要再使用更新的版本了,相关新闻

文档列表

鸣谢

jetbrains

感谢jetbrains 对开源项目提供的支持