如何在PHP环境中使用ProtoBuf数据格式

砸漏

发布于 2020-11-02 11:09:41

3.2K0

发布于 2020-11-02 11:09:41

文章被收录于专栏：恩蓝脚本

前言

RPC是google公司主导的一款RPC框架，并使用protobuf作为数据传输格式，伴随gRPC框架的成熟及使用人群的增加，对于底层使用的数据格式protobuf也被越来越受到重视，而对于PHP生态而言，相关ProtoBuf介绍文档及使用资料比较少，故此写简文希望能帮助到一些有需要的同学。

ProtoBuf （Google Protocol Buffer）是由google公司用于数据交换的序列结构化数据格式，具有跨平台、跨语言、可扩展特性，类型于常用的XML及JSON，但具有更小的传输体积、更高的编码、解码能力，特别适合于数据存储、网络数据传输等对存储体积、实时性要求高的领域。

目前官方ProtoBuf 最新版本ProtoBuf3，已经支持多种语言：C++\C#\Go\Java\Python\Ruby\Object C \Javascript\PHP，并且提供工具很方便地根据不同语言产生ProtoBuf需要的类库。

下面将通过Person数据格式作为示例进行描述如果在PHP环境中如何使用ProtoBuf3。

一、定义一个消息类型

创建一个关于Person的定义文件（以.proto为后缀），如示例为person.proto，文件内容如下：

syntax="proto3";
package test;
message Person{
 string name=1;//姓名
 int32 age=2;//年龄
 bool sex=3;//性别
}

1、syntax=”proto3″:表明使用的是proto3格式，如果不指定则为proto2

2、package test:定义包名为test，生成类时，会产生一个目录为test

3、message Person:消息主体内容，里面为各个字段的定义

二、生成对应的PHP类

定义好Person的格式后，该格式如果不生成我们所需要的类库，其实是无任何意义的，还google提供一个工具protoc生成我们要的类库。

1、安装protoc

安装地址：protobuf-php-3.5.1.tar.gz,目前最新为3.5.1

官方发布地址：https://github.com/google/protobuf/releases/tag/v3.5.1

解压并安装：

tar -zxvf protobuf-php-3.5.1.tar.gz
cd protobuf-3.5.1
./configure --prefix=/opt/soft/protobuf
make
make install

2、生成类库

/opt/soft/protobuf/bin/protoc –php_out=./ person.proto

生成后将在当前目录产生如下文件：

GPBMetadata/Person.php

Test/Person.php

三、在PHP中使用ProtoBuf

在PHP中使用ProtoBuf依赖一个protobuf的扩展，目前提供两种方式进行使用,1:php的c扩展，2:php的lib扩展包，这两者均可在刚才下载包里可以找到。

另外，也可以使用composer进行安装该依赖扩展：composer require google/protobuf

这里我主要是使用composer安装，应该它可以帮我产生autoload

安装好依赖后，我们就可以开始在php环境下使用protobuf了

1、序列化

<?php
include 'vendor/autoload.php';
include 'GPBMetadata/Person.php';
include 'Test/Person.php';

$person = new Test\Person();
$person- setName("lailaiji");
$person- setAge("28");
$person- setSex(true);
$data = $person- serializeToString();
file_put_contents('data.bin',$data);

2、反序列化

<?php
include 'vendor/autoload.php';
include 'GPBMetadata/Person.php';
include 'Test/Person.php';
$bindata = file_get_contents('./data.bin');
$person = new Test\Person();
$person- mergeFromString($bindata);
echo $person- getName();

可以正常地输出lailaiji

PHP常用的使用方法：

序列化：

1、serializeToString：序列化成二进制字符串

2、serializeToJsonString：序列化成JSON字符串

反序列化：

1、mergeFromString：二进制字符串反序列化

2、mergeFromJsonString：Json字符串反序列化

.proto的message解析

1、定义：

类型变量名=位置;

如：int32 age=1;