[移动开发]Android Protobuf序列化

protobuf序列化

proto文件生成java文件

Android studio集成Gradle Plugin for Protobuf插件

1. project build.gradle

buildscript { 
    dependencies {
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.18'
    }
}

protobuf-gradle-plugin github

注：protobuf-gradle-plugin 0.8.18版本最低支持的 Gradle 5.6 and Java 8版本；若使用的版本高于Gradle 5.6 and Java 8，使用0.8.18版本，否则可能会出现兼容问题的报错

对应使用的model添加protobuf-gradle-plugin插件

2. model build.gradle

protobuf plugin依赖java plugin 或者Android plugin，必须先添加Android plugin或者java plugin

apply plugin 'com.android.application'
apply plugin 'com.google.protobuf'

指定编译的proto文件路径：

sourceSets {
        main {
            proto {
                // In addition to the default 'src/main/proto'
                srcDir 'src/main/protobuf'
        }
    }
}

修改默认gradle-protobuf-plugin预定义的编译文件的文件扩展名，

默认扩展名为：*.proto

官方不建议设置该配置项，不利于区分源文件

sourceSets {
  main {
    proto {
      include '**/*.protodevel'
    }
}

官方推荐使用优化的预编译的protobuf编译器，可以通过Maven Central引用该编译器

protobuf {
  ...
  // Configure the protoc executable
  protoc {
    // Download from repositories
    artifact = 'com.google.protobuf:protoc:3.0.0'
  }
  ...
}

官方推荐Android项目使用Protobuf Lite Runtime，Lite对性能和代码大小都做了优化，但是不保证其稳定性

dependencies {
  // You need to depend on the lite runtime library, not protobuf-java
  implementation 'com.google.protobuf:protobuf-lite:3.0.0'
}

protobuf {
  protoc {
    // You still need protoc like in the non-Android case
    artifact = 'com.google.protobuf:protoc:3.7.0'
  }
  plugins {
    javalite {
      // The codegen for lite comes as a separate artifact
      artifact = 'com.google.protobuf:protoc-gen-javalite:3.0.0'
    }
  }
  generateProtoTasks {
    all().each { task ->
      task.builtins {
        // In most cases you don't need the full Java output
        // if you use the lite output.
        remove java
      }
      task.plugins {
        javalite { }
      }
    }
  }
}

Protobuf Java Lite

dependencies {
  // You need to depend on the lite runtime library, not protobuf-java
  implementation 'com.google.protobuf:protobuf-javalite:3.8.0'
}

protobuf {
  protoc {
    artifact = 'com.google.protobuf:protoc:3.8.0'
  }
  generateProtoTasks {
    all().each { task ->
      task.builtins {
        java {
          option "lite"
        }
      }
    }
  }
}

proto文件语法

protoc3

//文件的第一个非空、非注释行，指定协议语法版本
//指定协议版本为proto3,不声明指定默认为proto2版本
syntax = "proto3";

//辅助包名，防止与非java语言的文件的冲突
package tutorial;

//java_package 指定生成java代码的包名，默认不指定为java根目录
option java_package = "com.exmple.proto";

//指定类名，默认为文件名
option java_outer_classname = "xxx";

//该配置为指定是否为每个类都生成单独的java文件，而不是内部类的形式
option java_multiple_files = true;

//message指定类数据结构，相当于java的class关键字
message Person {
  optional string name = 1;
  optional int32 id = 2;
  optional string email = 3;

  enum PhoneType {
    MOBILE = 0;
    HOME = 1;
    WORK = 2;
  }

  message PhoneNumber {
    optional string number = 1;
    optional PhoneType type = 2 [default = HOME];
  }

  repeated PhoneNumber phones = 4;
}

message AddressBook {
  repeated Person people = 1;
}


属性定义：

类型 属性名 = 类型唯一标识(number)

常见基本数据类型
bool(boolean), int32, float, double, and string


属性修饰符
optional：可选属性，可设置或者不设置，未设置则为默认值
repeated：相当于list
required：必选属性，未提供则报错