README

Protobuf for PHP 是 PHP 语言对 Google 协议缓冲区的实现，支持二进制数据序列化，并包含一个 protoc 插件，可以从 .proto 文件生成 PHP 类。

在生成包含各种类型提示的 PHP 文件方面投入了大量精力，以帮助 IDE 进行自动完成。因此，它不仅可以用于与协议缓冲区服务通信，还可以作为无论最终序列化是什么的 数据对象 生成工具。

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

需求

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 在处理数字时非常弱。已经应用了几个变通方法来减少协议缓冲区类型与 PHP 类型之间的不兼容性。

协议缓冲区使用 IEEE 754 标准，使用 64 位字存储 double 类型，使用 32 位字存储 float 类型。PHP 原生支持 IEEE 754，尽管精度取决于平台，但通常支持 64 位双精度浮点数。这意味着如果您的 PHP 使用 64 位大小的双精度浮点数（或更大），则应该没有问题使用协议缓冲区编码和解码浮点数和双精度浮点数类型的值。
整数值在 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.

datto / protobuf-php

维护者

详细信息