Using ProtoBuf data format in PHP environment

Preface

 RPC is a Google company A leading RPC framework that uses protobuf as the data transmission format. With the maturity of the gRPC framework and the increase in the number of users, protobuf, the underlying data format used, has also received more and more attention. For the PHP ecosystem, the related ProtoBuf There are relatively few introductory documents and usage information, so I write a brief article hoping to help some students in need.

ProtoBuf (Google Protocol Buffer) is a sequence structured data format used by Google for data exchange. It has cross-platform, cross-language, and scalable characteristics. It is of the same type as commonly used XML and JSON, but It has smaller transmission volume and higher encoding and decoding capabilities. It is especially suitable for fields such as data storage and network data transmission that require high storage volume and real-time performance.

The latest version of official ProtoBuf, ProtoBuf3, already supports multiple languages: C \C#\Go\Java\Python\Ruby\Object C \Javascript\PHP, and provides tools to easily adapt to different languages Generate the class libraries required by ProtoBuf.

The following will use the Person data format as an example to describe how to use ProtoBuf3 in a PHP environment.

1. Define a message type

Create a definition file about Person (with .proto as suffix), as in the example is person.proto, the file content is as follows:

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

1, syntax="proto3": indicates that the proto3 format is used, if not specified, it is proto2

2. Package test: Define the package name as test. When generating a class, a directory will be generated as test

3. Message Person: Message body content, which contains the definition of each field.

2. Generate the corresponding PHP class

#After defining the format of Person, if the format does not generate what we need Class libraries are actually meaningless. Google also provides a tool protoc to generate the class libraries we want.

1. Install protoc

Installation address: protobuf-php-3.5.1.tar.gz, the latest is 3.5.1

official Release address: https://github.com/google/protobuf/releases/tag/v3.5.1

Unzip and install:

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

2. Generate class library

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

After generation, the following files will be generated in the current directory:

GPBMetadata/Person.php

Test/Person.php

##3. Using ProtoBuf in PHP

Using ProtoBuf in PHP relies on a protobuf extension. There are currently two ways to use it, 1: php's c extension, 2: php's lib extension package, both of which It can be found in the download package just now.

In addition, you can also use composer to install the dependent extension: composer require google/protobuf

Here I mainly use composer to install it, which should help me generate autoload

After installing the dependencies, we can start using protobuf in the PHP environment

1. Serialization

<?php
include &#39;vendor/autoload.php&#39;;
include &#39;GPBMetadata/Person.php&#39;;
include &#39;Test/Person.php&#39;;

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

2. Deserialization

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

can output lailaiji normally

Commonly used methods of using PHP:

Serialization:

1. serializeToString: serialize into a binary string

2. serializeToJsonString: serialize into a JSON string

Deserialization:

1, mergeFromString: Binary string deserialization

2, mergeFromJsonString: Json string deserialization

.

Proto’s message analysis

1. Definition:

Type variable name = position;

For example: int32 age=1;

It needs to be distinguished here. The number after the variable name means the position of the variable content in the binary sequence rather than the value of the variable. The number must be Only not reusable.

2. Currently supported types:

double, float, int32, int64, uint32, uint64, sint32, sint64

fixed32 ,fixed64,sfixed32,sfixed64,bool,bytes

Recommended tutorial: "

PHP"

The above is the detailed content of Using ProtoBuf data format in PHP environment. For more information, please follow other related articles on the PHP Chinese website!