Android:Google出品的序列化神器Protocol Buffer使用攻略

标签: Android 序列化 ProtocolBuffer 数据存储 缩小数据体积
1433人阅读 评论(2) 收藏 举报
分类:

前言

  • 习惯用 Json、XML 数据存储格式的你们,相信大多都没听过Protocol Buffer
  • Protocol Buffer 其实 是 Google出品的一种轻量 & 高效的结构化数据存储格式,性能比 Json、XML 真的强!太!多!

    由于 Google出品,我相信Protocol Buffer已经具备足够的吸引力

  • 今天,我将详细介绍Protocol BufferAndroid平台 的具体使用

阅读本文前请先阅读:快来看看Google出品的Protocol Buffer,别只会用Json和XML了

目录

示意图


1. 定义

一种 结构化数据 的数据存储格式(类似于 `XML、Json` )
  1. Google 出品 (开源)
  2. Protocol Buffer 目前有两个版本:proto2proto3
  3. 因为proto3 还是beta 版,所以本次讲解是 proto2

2. 作用

通过将 结构化的数据 进行 串行化(**序列化**),从而实现 **数据存储 / RPC 数据交换**的功能
  1. 序列化: 将 数据结构或对象 转换成 二进制串 的过程
  2. 反序列化:将在序列化过程中所生成的二进制串 转换成 数据结构或者对象 的过程

3. 特点

  • 对比于 常见的 XML、Json 数据存储格式,Protocol Buffer有如下特点:

Protocol Buffer 特点


4. 应用场景

传输数据量大 & 网络环境不稳定 的数据存储、RPC 数据交换 的需求场景

如 即时IM (QQ、微信)的需求场景


总结

传输数据量较大的需求场景下,Protocol BufferXML、Json 更小、更快、使用 & 维护更简单!


5. 使用流程

  • 使用 Protocol Buffer 的流程如下:

Protocol Buffer使用流程

  • 今天主要讲解Protocol BufferAndroid平台 的具体使用

示意图


6. 应用实例(Android平台)

  • 具体步骤如下:

具体步骤

步骤1:将生成的 代码文件 放入到项目中

  • 对于Android(Java)平台,即将编译.proto文件生成的Java包文件 整个复制到 Android 项目中
  • 放置路径: app/src/main/java的 文件夹里

项目结构示意图

步骤2:在 Gradle 添加 Protocol Buffer 版本依赖

compile 'com.google.protobuf:protobuf-java:2.6.1'
// 注:protobuf-java的版本 一定要和 安装protocobuffer的版本 一致

步骤3:具体在Android项目中使用

3.1 消息对象类介绍

通过.proto文件 转换的 Java源代码 = Protocol Buffer 类 + 消息对象类(含Builder内部类)

消息对象类 是 Protocol Buffer 类的内部类

由于最常用的都是 消息对象类 和其内部类Builder类 的方法&成员变量,所以此处主要讲解这两者。

3.1.1 消息对象类(Message类)
  • 消息对象类 类通过 二进制数组 写 和 读 消息类型
  • 使用方法包括:
<-- 方式1:直接序列化和反序列化 消息 -->
protocolBuffer.toByteArray();
// 序列化消息 并 返回一个包含它的原始字节的字节数组
protocolBuffer.parseFrom(byte[] data);
// 从一个字节数组 反序列化(解析) 消息

<-- 方式2:通过输入/ 输出流(如网络输出流) 序列化和反序列化消息 -->
protocolBuffer.writeTo(OutputStream output);
output.toByteArray();
// 将消息写入 输出流 ,然后再 序列化消息 

protocolBuffer.parseFrom(InputStream input);
// 从一个 输入流 读取并 反序列化(解析)消息


// 只含包含字段的getters方法
// required string name = 1;
public boolean hasName();// 如果字段被设置,则返回true
public java.lang.String getName();

// required int32 id = 2;
public boolean hasId();
public int getId();

// optional string email = 3;
public boolean hasEmail();
public String getEmail();

// repeated .tutorial.Person.PhoneNumber phone = 4;
// 重复(repeated)字段有一些额外方法
public List<PhoneNumber> getPhoneList();
public int getPhoneCount();
// 列表大小的速记
// 作用:通过索引获取和设置列表的特定元素的getters和setters

常用的如上,更多请看官方文档

3.1.2 Builder

作用:创建 消息构造器 & 设置/ 获取消息对象的字段值 & 创建 消息类 实例

属于 消息对象类 的内部类

a. 创建 消息构造器

Demo.Person.Builder person = Person.newBuilder();

b. 设置/ 获取 消息对象的字段值 具体方法如下:

// 标准的JavaBeans风格:含getters和setters
// required string name = 1;
public boolean hasName();// 如果字段被设置,则返回true
public java.lang.String getName();
public Builder setName(String value);
public Builder clearName(); // 将字段设置回它的空状态

// required int32 id = 2;
public boolean hasId();
public int getId();
public Builder setId(int value);
public Builder clearId();

// optional string email = 3;
public boolean hasEmail();
public String getEmail();
public Builder setEmail(String value);
public Builder clearEmail();

// repeated .tutorial.Person.PhoneNumber phone = 4;
// 重复(repeated)字段有一些额外方法
public List<PhoneNumber> getPhoneList();
public int getPhoneCount();
// 列表大小的速记
// 作用:通过索引获取和设置列表的特定元素的getters和setters

public PhoneNumber getPhone(int index);
public Builder setPhone(int index, PhoneNumber value);

public Builder addPhone(PhoneNumber value);
// 将新元素添加到列表的末尾

public Builder addAllPhone(Iterable<PhoneNumber> value);
// 将一个装满元素的整个容器添加到列表中
public Builder clearPhone();

public Builder isInitialized() 
// 检查所有 required 字段 是否都已经被设置

public Builder toString() :
// 返回一个人类可读的消息表示(用于调试)

public Builder mergeFrom(Message other)
// 将 其他内容 合并到这个消息中,覆写单数的字段,附接重复的。

public Builder clear()
// 清空所有的元素为空状态。

3.2 具体使用

  • 使用步骤如下:
    步骤1:通过 消息类的内部类Builder类 构造 消息构造器
    步骤2:通过 消息构造器 设置 消息字段的值
    步骤3:通过 消息构造器 创建 消息类 对象
    步骤4:序列化 / 反序列化 消息

  • 具体使用如下:(注释非常清晰)

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // 步骤1:通过 消息类的内部类Builder类 构造 消息类的消息构造器
        Demo.Person.Builder personBuilder =  Demo.Person.newBuilder();

        // 步骤2:设置你想要设置的字段为你选择的值
        personBuilder.setName("Carson");// 在定义.proto文件时,该字段的字段修饰符是required,所以必须赋值
        personBuilder.setId(123);// 在定义.proto文件时,该字段的字段修饰符是required,所以必须赋值
        personBuilder.setEmail("carson.ho@foxmail.com"); // 在定义.proto文件时,该字段的字段修饰符是optional,所以可赋值 / 不赋值(不赋值时将使用默认值)

        Demo.Person.PhoneNumber.Builder phoneNumber =  Demo.Person.PhoneNumber.newBuilder();
        phoneNumber.setType( Demo.Person.PhoneType.HOME);// 直接采用枚举类型里的值进行赋值
        phoneNumber.setNumber("0157-23443276");
        // PhoneNumber消息是嵌套在Person消息里,可以理解为内部类
        // 所以创建对象时要通过外部类来创建

        // 步骤3:通过 消息构造器 创建 消息类 对象
        Demo.Person person = personBuilder.build();

        // 步骤4:序列化和反序列化消息(两种方式)

        /*方式1:直接 序列化 和 反序列化 消息 */
        // a.序列化
        byte[] byteArray1 = person.toByteArray();
        // 把 person消息类对象 序列化为 byte[]字节数组
        System.out.println(Arrays.toString(byteArray1));
        // 查看序列化后的字节流

        // b.反序列化
        try {

            Demo.Person person_Request = Demo.Person.parseFrom(byteArray1);
            // 当接收到字节数组byte[] 反序列化为 person消息类对象

            System.out.println(person_Request.getName());
            System.out.println(person_Request.getId());
            System.out.println(person_Request.getEmail());
            // 输出反序列化后的消息
        } catch (IOException e) {
            e.printStackTrace();
        }


        /*方式2:通过输入/ 输出流(如网络输出流) 序列化和反序列化消息 */
        // a.序列化
        ByteArrayOutputStream output = new ByteArrayOutputStream();
         try {

            person.writeTo(output);
            // 将消息序列化 并写入 输出流(此处用 ByteArrayOutputStream 代替)

        } catch (IOException e) {
            e.printStackTrace();
        }

        byte[] byteArray = output.toByteArray();
        // 通过 输出流 转化成二进制字节流

        // b. 反序列化
        ByteArrayInputStream input = new ByteArrayInputStream(byteArray);
        // 通过 输入流 接收消息流(此处用 ByteArrayInputStream 代替)

        try {

            Demo.Person person_Request = Demo.Person.parseFrom(input);
            // 通过输入流 反序列化 消息

            System.out.println(person_Request.getName());
            System.out.println(person_Request.getId());
            System.out.println(person_Request.getEmail());
            // 输出消息
        } catch (IOException e) {
            e.printStackTrace();
        }

    }
}

Demo 地址

Carson_Ho的Github :https://github.com/Carson-Ho/ProtocolBuffer

高级功能

  • 贴心的Google还提供将Protocol Buff 编码方式 转化为 其他编码方式,如 JsonXML等等

    即将 Protocol Buff 对象 转化为其他编码方式的数据存储对象

  • 下面展示的是 将 Protocol Buff 对象 转化为 Json对象

// 步骤1:在Gradle加入依赖
compile 'com.googlecode.protobuf-java-format:protobuf-java-format:1.4'

// 步骤2:将`Protocol Buff` 对象 序列化 为 `Json`对象
JsonFormat jsonFormat = new JsonFormat();  
String person2json = jsonFormat.printToString(mProtoBuffer); 

至此, 关于Protocol Buffer的使用讲解完毕。


7. 总结


请帮顶 / 评论点赞!因为你的鼓励是我写作的最大动力!

查看评论

Google Protocol Buffer序列化入门实战(附源码)

Google Protocol Buffer入门实战(附源码)Google Protocol Buffer(后面简称PB)是Google开源的一款二进制序列化工具,占用空间小,传输效率高。最近由于项目...
  • u011116672
  • u011116672
  • 2016-08-09 15:38:17
  • 2747

别只会用Json和XML了,快来学习Google出品的序列化神器Protocol Buffer

前言 习惯用 Json、XML 数据存储格式的你们,相信大多都没听过Protocol Buffer Protocol Buffer 其实 是 Google出品的一种轻量 &amp;amp; 高效的...
  • carson_ho
  • carson_ho
  • 2017-04-10 21:40:38
  • 22721

【Protocol Buffer】Protobuf的序列化和反序列化

前言 目前主流的几种数据交互的格式主要有xml、json、protobuf等等。一般的web项目中,最流行的主要还是json。因为浏览器对于json数据支持非常好,有很多内建的函数支持。xml数据...
  • wk1134314305
  • wk1134314305
  • 2017-07-12 21:22:13
  • 2283

Protocol Buffer 序列化原理大揭秘 - 为什么Protocol Buffer性能这么好?

前言 习惯用 Json、XML 数据存储格式的你们,相信大多都没听过Protocol Buffer Protocol Buffer 其实 是 Google出品的一种轻量 & 高效的结构化数据存储格式,...
  • carson_ho
  • carson_ho
  • 2017-04-24 09:19:04
  • 31696

为什么要使用Google Protocol Buffers

前段时间在整理公司一个重要程序的代码时,以前有个同事使用了Google Protocol Buffers来实现后台与前端之间的数据传输,感觉挺不错的。以前只是简单的了解知道它是Google的一个开源技...
  • qq_17486399
  • qq_17486399
  • 2016-09-29 14:21:40
  • 160

通信协议之Protocol buffer(Java篇)

之前一直习惯用json进行数据的传输,觉得很方便。来到新公司后发现同事们用的更多的的协议都不是json,而是Protocol buffer。这个东西之前没有听说过,不明白同事们为什么放弃好好的json...
  • briblue
  • briblue
  • 2016-11-16 16:16:38
  • 12682

google的protocol buffers 对象的序列化 for java

google的protocol buffers 对象的序列化 for java
  • fz2543122681
  • fz2543122681
  • 2015-01-07 13:25:15
  • 1631

google protocl buffer 序列化和反序列化的一个例子

google protocl buffer 序列化和反序列化的一个例子
  • hzhxxx
  • hzhxxx
  • 2013-09-25 10:15:38
  • 3915

Google protocol buffer 使用和原理浅析 And 进阶使用方式之PbCodec

Google Protocol Buffer又简称Protobuf,它是一种很高效的结构化数据存储格式,一般用于结构化数据的串行化,简单说就是我们常说的数据序列化。这种序列化的协议非常轻便高效,而且是...
  • linyousong
  • linyousong
  • 2016-07-03 17:04:12
  • 5678

Google Protocol buffer 系列二: 常用api

What Are Protocol Buffers? Protocol buffers are Google's language-neutral, platform-neutral, exten...
  • scut1135
  • scut1135
  • 2013-11-14 23:16:42
  • 2285
    个人资料
    专栏达人 持之以恒
    等级:
    访问量: 149万+
    积分: 1万+
    排名: 1194
    Github
    https://github.com/Carson-Ho
    博客专栏