google protocol buffer全解析------田纪原，2024年安卓开发进阶课程

最新推荐文章于 2024-09-10 14:41:14 发布

m0_60721823

最新推荐文章于 2024-09-10 14:41:14 发布

阅读量627

点赞数 20

分类专栏：程序员学习文章标签： android java 开发语言

本文链接：https://blog.csdn.net/m0_60721823/article/details/136882577

版权

本文详细探讨了Google Protocol Buffer（protobuf）的使用特性与编码原理。首先介绍了protobuf如何通过定义.proto文件生成定制的Java模型，强调了字段序号在编码解码过程中的关键作用。接着通过示例展示了protobuf的兼容性，如不同模型间转换、序号对编码大小的影响、对象类型向String的兼容性以及protobuf与json的互换。文章还详细解析了protobuf的varint编码方式，说明了protobuf编码结果不包含字段名，仅保留序号、类型和数据值。最后，文章列举了protobuf编码的5个特性，并预告了后续将要讨论的protobuf编码原理的其他部分。

摘要由CSDN通过智能技术生成

1.protocol buffer需要定义.proto描述文件，然后通过google提供的编译器生成特定的模型文件，之后就可以作为正常的java对象使用了

2.不可以直接创建对象，需要通过Builder进行

3.只有Builder才可以进行set

4.可以通过对象的toByteArray()和parseFrom()方法进行编码和解码

5.模型文件很大（至少在java这里是如此），其中所有的代码都是定制的，这其实是它很大的缺点之一

接着我们将继续深入探究protobuf的编码原理。

主要分为两个部分

第一部分是之前留下的几个伏笔展示protobuf的使用特性

第二部分是分析protobuf的编码原理，解释特性背后的原因

第一部分，Protobuf使用特性

1.不同类型对象的转换

我们先定义如下一个.proto文件

syntax = “proto3”;

option java_package = “cn.tera.protobuf.model”;
option java_outer_classname = “DifferentModels”;

message Person {
string name = 1;
int32 id = 2;
string email = 3;
}

message Article {
string title = 1;
int32 wordsCount = 2;
string author = 3;
}

其中我们定义了2个模型，一个Person，一个Article，虽然他们的字段名字不相同，但是类型和编号都是一致的

接着我们生成.java文件，最终文件结构如下图

此时我们尝试做如下的一个转换

/**

测试不同模型间的转换
@throws Exception
*/
@Test
public void parseDifferentModelsTest() throws Exception {
//创建一个Person对象
DifferentModels.Person person = DifferentModels.Person.newBuilder()
.setName(“person name”)
.setId(1)
.setEmail(“tera@google.com”)
.build();
//对person编码
byte[] personBytes = person.toByteArray();
//将编码后的数据直接merge成Article对象
DifferentModels.Article article = DifferentModels.Article.parseFrom(personBytes);
System.out.println(“article’s title:” + article.getTitle());
System.out.println(“article’s wordsCount:” + article.getWordsCount());
System.out.println(“article’s author:” + article.getAuthor());
}

输出结果如下

article’s title:person name
article’s wordsCount:1
article’s author:tera@google.com

可以看到，虽然jsonBytes是由person对象编码得到的，但是可以用于article对象的解码，不但不会报错，所有的数据内容都是完整保留的

这种兼容性的前提是模型中所定义的字段类型和序号都是一一对应相同的

在平时的编码中，我们经常会遇到从数据库中读取数据模型，然后将其转换成业务模型，而很多时候，这2种模型的内容其实是完全一致的，此时我们也许就可以使用protobuf的这种特性，就可以省去很多低效的赋值代码

2.protobuf序号的重要性

我们看到在定义.proto文件时，字段后面会跟着一个"= X"，这里并不是指这个字段的值，而是表示这个字段的“序号”，和正确地编码与解码息息相关，在我看来是protocol buffer的灵魂

我们定义如下的.proto文件，这里注意，Model1和Model2的name和id的序号有不同

syntax = “proto3”;

option java_package = “cn.tera.protobuf.model”;
option java_outer_classname = “TagImportance”;

message Model1 {
string name = 1;
int32 id = 2;
string email = 3;
}

message Model2 {
string name = 2;
int32 id = 1;
string email = 3;
}

定义如下的测试方法

/**

序号的重要性测试
@throws Exception
*/
@Test
public void tagImportanceTest() throws Exception {
TagImportance.Model1 model1 = TagImportance.Model1.newBuilder()
.setEmail(“model1@google.com”)
.setId(1)
.setName(“model1”)
.build();
TagImportance.Model2 model2 = TagImportance.Model2.parseFrom(model1.toByteArray());
System.out.println(“model2 email:” + model2.getEmail());
System.out.println(“model2 id:” + model2.getId());
System.out.println(“model2 name:” + model2.getName());
System.out.println(“-------model2 数据---------”);
System.out.println(model2);
}