protobuf整合-Android
protobuf整合-Android
Google Protocol Buffers 简称 Protobuf，类似 json 或 XML，是一种序列化结构数据的机制，但是比它们更小、更快、更简单。同时支持多语言，跨平台。
目前主要有两个大版本：proto2 和 proto3。
其中 proto2 支持 Java、Python、 Objective-C、和 C++。
proto3 增加了对Go、JavaNano、Ruby、和 C#的支持。
案例
syntax = "proto3";
package tutorial;
import "google/protobuf/timestamp.proto";
//option java_package = "com.katyusha.aron.demo";
package com.katyusha.aron.demo;
option java_outer_classname = "AddressBookProtos";
message Person {
string name = 1;
int32 id = 2;
string email = 3;
enum PhoneType{
MOBILE = 0;
HOME = 1;
WORK = 2;
}
message PhoneNumber {
string number = 1;
PhoneType type = 2;
}
repeated PhoneNumber phone = 4;
}
message AddressBook {
repeated Person person = 1;
}rotobuf使用.proto文件来定义数据格式，并同时提供编译器将这些文件编译为各种语言的源码。
message 格式非常简单。每种类型的 message 包含一个或者多个唯一编码字段，每个字段由名称和值类型组成，值类型可以是数字（整形或者浮点型）、布尔值、字符串、原始字节，甚至是其他的 message（如上例所示）。Protobuf 允许 message 中包含 message，以达到分层嵌套。
值得注意的一点是，每个属性都有唯一的一个tag，上面的0,1,2...等，这些tag非常重要，是 Prodobuf 编码时使用的对每个属性的唯一标识符————Prodobuf 并不使用属性名（name,id,email...）来编码。因而，在定义过一个 message 之后，原则上都不应该再修改每个属性的tag，因为一旦修改，可能就会出现新老数据版本解析出错的问题。
关键字
- syntax：声明版本。例如上面
syntax="proto3"，如果没有声明，则默认是proto2。 - package：声明包名.
- import：导入包。类似于java，例如上面导入了
timestamp.proto包。 - java_package：指定生成的类应该放在什么Java包名下。如果你没有显式地指定这个值，则它简单地匹配由package 声明给出的Java包名，但这些名字通常都不是合适的Java包名 (由于它们通常不以一个域名打头)。
- java_outer_classname：定义应该包含这个文件中所有类的类名。如果你没有显式地给定java_outer_classname ，则将通过把文件名转换为首字母大写来生成。例如上面例子编译生成的文件名和类名是
AddressBookProtos。 - message：类似于java中的class关键字。
- repeated：用于修饰属性，表示对应的属性是个
array。
Android中使用protobuf
首先创建proto文件，该文件定义了你要使用的数据的数据格式。
通过proto文件，编译生成proto java class，生成的类中包含你需要的getter/setter，这个java class就类似于我们平常所用的java bean，但其还包含很多很多的别的功能函数。在android中， 我们可以通过集成Gradle Plugin for Protobuf来编译proto文件。
配置:方法1
- 在项目根的gradle文件中添加如下内容()：
buildscript {
repositories {
jcenter()
mavenCentral()
}
dependencies {
classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.9'
}
}- 在app module下的gradle文件中：
apply plugin: 'com.google.protobuf' //最顶端的设置
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.5.1-1'
}
plugins {
javalite {
artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'
}
}
generateProtoTasks {
all().each { task ->
task.builtins {
remove java
}
task.plugins {
javalite {}
}
}
}
}添加依赖
在app module下的gradle的dependencies中
方法1:
implementation 'com.google.protobuf:protobuf-lite:3.0.1'生成Java文件
项目编译之后,会在app\build\generated\source\proto\360Debug\javalite 中自动生成Java文件,目录结构是在/proto文件中的package 包结构;
优点
- proto文件修改之后,编译一下自动就更新了,无需多余操作
缺点
- Android项目编译速度慢了点...
配置:方法2
- 在项目根的gradle文件中添加如下内容()：
buildscript {
repositories {
jcenter()
mavenCentral()
}
dependencies {
classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.9'
}
}- 在app module下的gradle文件中：
apply plugin: 'com.google.protobuf' //最顶端的设置
protobuf {
protoc {
artifact = 'com.google.protobuf:protoc:3.5.1'
}
generateProtoTasks {
all().each { task ->
task.builtins {
remove java
}
task.plugins {
javalite {}
}
}
}
}添加依赖
在app module下的gradle的dependencies中
api 'com.google.protobuf:protobuf-java:3.5.1'
api 'com.google.protobuf:protoc:3.5.1'生成Java
- 安装插件 GenProtobuf,
- 设置编译为java
- 选择proto文件即可在对应目录生成Java文件
- 将生成的Java文件复制到相应的文件夹中即可
优势:
- 代码快速生成,
- 生成自由
