README

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

在生成包含各种类型提示的PHP文件方面付出了巨大的努力，以帮助IDE进行自动完成。因此，它不仅可以用于与Protocol Buffers服务通信，还可以作为数据对象的生成工具，无论最终序列化为何种格式。

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

要求

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

¹仅当int32、int64或fixed64类型包含负值时需要。请参阅“已知问题”部分。

功能

工作

标准类型（数字、字符串、枚举、消息等）
可插拔序列化后端（编解码器）
- 标准二进制格式
- 标准文本格式¹
- 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.

byphp / protobuf-php

维护者

详细信息