README

Protobuf for PHP 是 Google Protocol Buffers 的 PHP 实现，支持二进制数据序列化，包括从 .proto 文件生成 PHP 类的 protoc 插件。

为了生成包含各种类型提示的 PHP 文件，以帮助 IDE 进行自动补全，投入了大量精力。因此，它不仅可以用于与 Protocol Buffers 服务进行通信，还可以作为任何最终序列化方式的 数据对象 生成工具。

有关更多信息，请参阅包含的手册页面。

要求

PHP 5.3
Pear 的 Console_CommandLine（用于 protoc 包装工具）
Google 的 protoc 编译器版本 2.3 或更高
GMP 或 BC Math 扩展 ¹

¹ 仅在 int32、int64 或 fixed64 类型中的负值时需要。请参阅 已知问题 部分。

功能

运行中

标准类型（数字、字符串、枚举、消息等）
可插拔的序列化后端（编解码器）
- 标准二进制格式
- 标准 TextFormat ¹
- PhpArray
- JSON
- ProtoJson（TagMap 和 Indexed 变体）
- XML
用于生成 PHP 类的 Protoc 编译器插件
扩展
未知字段
打包字段
反射
支持带注解的动态消息
生成服务接口
在生成的文件中包含 .proto 文件中的注释
方便安装的 Pear 软件包

¹ 仅支持序列化

未来

速度优化代码生成模式
支持超出 PHP 本身限制的数字

示例用法

<?php
require_once 'DrSlump/Protobuf.php';
\DrSlump\Protobuf::autoload();

$person = new Tutorial\Person();
$person->name = 'DrSlump';
$person->setId(12);

$book = new Tutorial\AddressBook();
$book->addPerson($person);

// Use default codec
$data = $book->serialize();

// Use custom codec
$codec = new \DrSlump\Protobuf\Codec\Binary();
$data = $codec->encode($book);
// ... or ...
$data = $book->serialize($codec);

安装

使用 Pear 安装

pear channel-discover pear.pollinimini.net
pear install drslump/Protobuf-beta

您也可以通过在您的计算机上检出存储库的副本来获取最新版本。

已知问题

类型

PHP 在处理数字时非常薄弱。已经应用了几个解决方案来减少 Protobuf 类型与 PHP 类型之间的不兼容性。

Protobuf 使用 IEEE 754 标准存储浮点值，对于 double 类型使用 64 位字，对于 float 类型使用 32 位。PHP 本身支持 IEEE 754，尽管精度依赖于平台，但通常支持 64 位双精度浮点数。这意味着如果您的 PHP 是用 64 位大小的双精度浮点数（或更大）编译的，您不应该有任何问题使用 Protobuf 编码和解码浮点型和双精度型值。
整数值在 PHP 中也是平台相关的。库是在针对使用 64 位整数的 PHP 二进制文件编译和测试的。理论上，无论 PHP 内部使用 32 位还是 64 位整数，编码和解码算法都应正常工作，只需注意，在使用 32 位整数的情况下，数值不能超过 PHP_INT_MAX 值（2147483647）。

尽管Protobuf支持无符号整数，但PHP不支持。实际上，超出编译后的PHP最大整数值（PHP_INT_MAX，64位为0x7FFFFFFFFFFFFFFF）的数字将被自动转换为双精度浮点数，这通常提供53位的小数精度，允许安全地处理高达0x20000000000000（2^53）的数字，即使它们在PHP中以浮点数而不是整数的形式表示。更大的数字将丢失精度，甚至可能返回一个无穷大值，请注意，该库不包含对这些数字的任何检查，使用它们可能会引发意外行为。

当以int32、int64或fixed64类型编码负值时，需要在您的PHP环境中提供大整数扩展GMP或BC Math（后者仅适用于64位架构）。原因是当不使用zigzag来编码这些负数时，二进制表示使用最高有效位作为符号位，因此数字超出了PHP支持的最大值。该库将检查这些条件，并自动尝试使用GMP或BC来处理值。

字符串

二进制编解码器期望字符串使用UTF-8进行编码。PHP原生不支持字符串编码，PHP的字符串数据类型基本上是一个长度限定的字节流，因此将自动编码转换包含到库的编码和解码例程中并不是一件简单的事情。而不是尝试猜测或提供一个配置界面来选择编码，二进制编解码器将像处理byte类型一样处理string类型，将编码或解码任务委托给您的应用程序以所需的字符集执行。

内存使用

大型消息可能会很麻烦，因为库的设计方式不允许以流的形式解析或序列化消息，而是整个操作都在内存中完成，这允许更快的处理，但如果消息太大，可能会消耗过多的RAM。

未知字段

由于不同编解码器的格式中wire类型不同，因此无法将一个编解码器中消耗的未知字段转换为另一个编解码器。这意味着，例如，当使用二进制编解码器处理消息时，如果其中包含未知字段，它们在用Json编解码器序列化消息时将不会包括在内。

生成PHP类

生成工具被设计为作为protoc插件运行，因此它应该与官方编译器支持的任何proto文件一起工作。

protoc --plugin=protoc-gen-php --php_out=./build tutorial.proto

要使用proto文件中的非标准选项（如php.namespace），您必须导入库中包含的php.proto文件。其位置取决于您安装此库的位置。

protoc -I=./Protobuf-PHP/library/DrSlump/Protobuf/Compiler/protos \
       --plugin=protoc-gen-php --php_out=./build tutorial.proto

为了使您的生活更加轻松，提供的protoc插件提供了一种额外的执行模式，其中它作为protoc调用的包装器。它将自动包含php.proto路径，因此您无需担心。

protoc-gen-php -o ./build tutorial.proto

授权协议

The MIT License

Copyright (c) 2011 Iván -DrSlump- Montes

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
'Software'), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

haoyanfei / protobuf-php

维护者

详细信息