Protobuf 与 gRPC 在 PHP 中的服务代码生成详解

浅涛姑娘_8966

浅涛姑娘_8966

2026-09-29

429人浏览

原创

Protobuf 与 gRPC 在 PHP 中的服务代码生成详解

PHP 的 Protobuf 编译器(protoc)默认不生成服务接口代码;需额外启用 gRPC 插件并指定 --grpc_out,才能生成服务类(如 SearchService)、客户端存根及服务端抽象基类。

php 的 protobuf 编译器(protoc)默认不生成服务接口代码;需额外启用 grpc 插件并指定 `--grpc_out`,才能生成服务类(如 searchservice)、客户端存根及服务端抽象基类。

在使用 Protocol Buffers 定义 RPC 服务(如 service SearchService)时,许多开发者会误以为仅运行 protoc --php_out=... 即可生成完整 PHP 代码——但实际该命令仅生成消息类型(message)的序列化类(如 SearchRequest 和 SearchResponse),完全忽略 service 定义。

这是因为:

  • --php_out 由官方 protoc-gen-php 插件提供,其设计目标是纯数据序列化/反序列化,不支持服务契约生成;
  • 服务接口(RPC 方法、客户端调用桩、服务端抽象类)必须由 gRPC 官方 PHP 插件 grpc_php_plugin 负责生成,且需显式启用 --grpc_out。

✅ 正确编译命令如下(Linux/macOS):

protoc \
  --php_out=./src \
  --grpc_out=./src \
  --plugin=protoc-gen-grpc=$(which grpc_php_plugin) \
  ./proto/example.proto

⚠️ 注意事项:

btpanel phpsite 宝塔面板PHP网站
btpanel phpsite 宝塔面板PHP网站

宝塔面板 PHP 网站管理:站点创建、删除、启停、PHP 版本切换、域名管理、SSL证书管理、伪静态管理、数据库管理

下载
  • grpc_php_plugin 需提前安装:通过 gRPC PHP 源码编译 或 Composer 安装 grpc/grpc 扩展后获取;
  • $(which grpc_php_plugin) 须能正确解析路径(常见位置:/usr/local/bin/grpc_php_plugin 或 vendor/bin/grpc_php_plugin);
  • 输出目录(./src)需存在且可写,建议与 --php_out 保持一致以统一命名空间结构;
  • 生成后,除 SearchRequest.php 和 SearchResponse.php 外,还将得到:
    • SearchService/Client.php:客户端调用桩(含 search() 方法);
    • SearchService/Service.php:服务端需继承的抽象基类(含 search() 抽象方法)。

? 补充:若使用 Composer 管理依赖,推荐在 composer.json 中声明:

"require": {
  "grpc/grpc": "^1.60",
  "google/protobuf": "^4.0"
}

并确保 protoc 版本 ≥ 3.15(兼容 proto3 service + stream 语法)。

完整实践示例可参考开源项目:php-protobuf — gRPC Server & Client Example,其中包含服务实现、Swoole 集成及单元测试,助你快速落地。

php免费学习视频:立即使用
踏上前端学习之旅,开启通往精通之路!从前端基础到项目实战,循序渐进,一步一个脚印,迈向巅峰!

相关文章

PHP速学教程(入门到精通)
PHP速学教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

php php教程 php功能

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
php文件怎么打开
php文件怎么打开

打开php文件步骤:1、选择文本编辑器;2、在选择的文本编辑器中,创建一个新的文件,并将其保存为.php文件;3、在创建的PHP文件中,编写PHP代码;4、要在本地计算机上运行PHP文件,需要设置一个服务器环境;5、安装服务器环境后,需要将PHP文件放入服务器目录中;6、一旦将PHP文件放入服务器目录中,就可以通过浏览器来运行它。

2023.09.01

9564

6

php怎么取出数组的前几个元素
php怎么取出数组的前几个元素

取出php数组的前几个元素的方法有使用array_slice()函数、使用array_splice()函数、使用循环遍历、使用array_slice()函数和array_values()函数等。本专题为大家提供php数组相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

5761

5

php反序列化失败怎么办
php反序列化失败怎么办

php反序列化失败的解决办法检查序列化数据。检查类定义、检查错误日志、更新PHP版本和应用安全措施等。本专题为大家提供php反序列化相关的文章、下载、课程内容,供大家免费下载体验。

2023.10.11

2055

5

php怎么连接mssql数据库
php怎么连接mssql数据库

连接方法:1、通过mssql_系列函数;2、通过sqlsrv_系列函数;3、通过odbc方式连接;4、通过PDO方式;5、通过COM方式连接。想了解php怎么连接mssql数据库的详细内容,可以访问下面的文章。

2023.10.23

3588

4

php连接mssql数据库的方法
php连接mssql数据库的方法

php连接mssql数据库的方法有使用PHP的MSSQL扩展、使用PDO等。想了解更多php连接mssql数据库相关内容,可以阅读本专题下面的文章。

2023.10.23

4274

6

html怎么上传
html怎么上传

html通过使用HTML表单、JavaScript和PHP上传。更多关于html的问题详细请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.03

3351

9

PHP出现乱码怎么解决
PHP出现乱码怎么解决

PHP出现乱码可以通过修改PHP文件头部的字符编码设置、检查PHP文件的编码格式、检查数据库连接设置和检查HTML页面的字符编码设置来解决。更多关于php乱码的问题详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.09

4757

8

php文件怎么在手机上打开
php文件怎么在手机上打开

php文件在手机上打开需要在手机上搭建一个能够运行php的服务器环境,并将php文件上传到服务器上。再在手机上的浏览器中输入服务器的IP地址或域名,加上php文件的路径,即可打开php文件并查看其内容。更多关于php相关问题,详情请看本专题下面的文章。php中文网欢迎大家前来学习。

2023.11.13

3722

8

sprintf函数用法详解
sprintf函数用法详解

sprintf函数的用法:1、格式化字符串;2、指定输出宽度和精度;3、返回值。更多关于sprintf函数用法详解的内容,大家可以阅读下面的文章。

2023.11.27

11722

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习