IM通讯协议专题学习(六)：手把手教你如何在Android上从零 ...

• 《IM通讯协议专题学习(一)：Protobuf从入门到精通，一篇就够！》
  
• 《IM通讯协议专题学习(二)：快速理解Protobuf的背景、原理、使用、优缺点》
  
• 《IM通讯协议专题学习(三)：由浅入深，从根上理解Protobuf的编解码原理》
  
• 《IM通讯协议专题学习(四)：从Base64到Protobuf，详解Protobuf的数据编码原理》
  
• 《IM通讯协议专题学习(五)：Protobuf到底比JSON快几倍？全方位实测！》
  
• 《IM通讯协议专题学习(六)：手把手教你如何在Android上从零使用Protobuf》（* 本文）
  
• 《IM通讯协议专题学习(七)：手把手教你如何在NodeJS中从零使用Protobuf》
  
• 《IM通讯协议专题学习(八)：金蝶随手记团队的Protobuf应用实践(原理篇)》
  
• 《IM通讯协议专题学习(九)：手把手教你如何在iOS上从零使用Protobuf》
  

• 1）Github 下载 Protobuf 并安装；
  
• 2）brew 安装。
  

# protobuf 环境变量
exportPROTOBUF_HOME=/Users/zhouying/Downloads/protoc-3.19.2-osx-x86_64
exportPATH=${PATH}:${PROTOBUF_HOME}/bin

//一键安装 protobuf
brew installprotobuf

//一键卸载 protobuf
brew uninstall protobuf

//例如说我在 Java 里面进行如下定义：
inta = 1;
//因为 int 类型占 4 个字节，1个字节占 8 位，我们把 1 的字节占位给列出来：
00000000000000000000000000000001
//可以看到 1 的前面 3 个字节占位都是 0，在 Protobuf 里面是可以去掉的，于是就变成了：
00000001
//因此 1 在 Protobuf 里面就只占用了一个字节，节省了空间

//指定 Protobuf 版本
syntax = "proto3";

//指定包名
package erdai;

//定义一个学生的消息类
message Student{
  //姓名
  string name = 1;
  //年龄
  int32 age = 2;
  //邮箱
  string email = 3;
  //课程
  repeated string course = 4; //相当于 Java 的 List<String>
}

• 1）一个 Protobuf 文件里面可以添加多个消息类，也可以进行嵌套；
  
• 2）上面的 1，2，3，4 并不是给字段赋值，而是给每个字段定义一个唯一的编号（这些编号用于二进制格式中标识你的字段，并且在使用你的消息类型后不应更改）；
  
• 3）1-15 的字段编号只占一个字节进行编码，16-2047 的字段编号占两个字节，包括字段编号和字段类型，因此建议更多的使用 1-15 的字段编号；
  
• 4）可以指定最小字段编号为 1，最大字段编号为 2^29 - 1 或 536870911（另外不能使用 19000-19999 的标识号，因为 protobuf 协议实现对这些进行了预留，同样也不能使用任何以前保留（reserved） 的字段编号）。
  

message Weather{
  int32 query = 1;

  //季节
  enum Season{
    //允许对枚举常量设置别名
    option allow_alias = true;
    //枚举里面的 = 操作是对常量进行赋值操作
    //春
    SPRING = 0;
    //夏
    SUMMER = 1;
    //秋 如果不设置别名，不允许存在两个相同的值
    FALL = 2;
    AUTUMN = 2;
    //冬
    WINTER = 3;
  }

  //对 season 进行编号
  Season season = 2;
}

• 1）定义枚举类型使用 enum 关键字；
  
• 2）枚举类型第一个字段的值为必须 0，否则编译会报错；
  
• 3）枚举常量值必须在 32 位整型值的范围内（因为 enum 值是使用可变编码方式的，对负数不够高效，因此不推荐在 enum 中使用负数）；
  
• 4）枚举里面的 = 操作是对常量进行赋值操作，而枚举外面的 = 则是对当前字段进行编号。
  

repeated string list = 1; //类似 Java 的 List<String>
map<string,string> = 2; //类似 Java 的 Map<String,String>

• 1）Protobuf 中定义集合，就是在你定义好的属性前面加 repeated 关键字；
  
• 2）Protobuf 中定义 map 和 Java 类似，只不过 map 是小写的。
  

• 1）集成 Protobuf 插件转换；
  
• 2）使用 protoc 命令行转换。
  

implementation 'com.google.protobuf:protobuf-java:3.19.2'

buildscript {
    repositories {
        gradlePluginPortal()
    }
    dependencies {
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.19'
    }
}

//1、如果使用的是 apply 方式，Android 插件必须在 Protobuf 插件之前，如下：
apply plugin: 'com.android.application'
apply plugin: 'com.google.protobuf'

//2、如果使用的是 Gradle DSL 方式，则与顺序无关
plugins {
    id'com.google.protobuf'
    id'com.android.application'
}

android {
    //...
}

protobuf {
    //配置 protoc 编译器
    protoc {
        artifact = 'com.google.protobuf:protoc:3.19.2'
    }
    //配置生成目录，编译后会在 build 的目录下生成对应的java文件
    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.builtins {
                java {}
            }
        }
    }
}

android {
    //...

    sourceSets {
        main {
            //实际测试指不指定无所谓，不影响 Java 文件生成
            proto {
                srcDir 'src/main/proto'
            }
        }
    }
}

//指定 Protobuf 版本
syntax = "proto3";

//指定包名
package erdai;

//定义一个学生的消息类
message Student{
  //姓名
  string name = 1;
  //年龄
  int32 age = 2;
  //邮箱
  string email = 3;
  //课程
  repeated string course = 4;

}

//定义一个天气的消息类
message Weather{
  int32 query = 1;

  //季节
  enum Season{
    option allow_alias = true;
    //春
    SPRING = 0;
    //夏
    SUMMER = 1;
    //秋
    FALL = 2;
    AUTUMN = 2;
    //冬
    WINTER = 3;
  }

  Season season = 2;
}

protoc --java_out=${"你要生成的 Java 文件目录"} ${"Protobuf 文件位置"}

//以我的为例：
protoc --java_out=./app/src/main/java ./app/src/main/proto/student.proto

Student （实现了 StudentOrBuilder 接口）
Weather （实现了 WeatherOrBuilder 接口）
StudentOrBuilder （接口）
WeatherOrBuilder （接口）

fun main(){
    //构建 Protobuf 对象
    val student = StudentOuterClass.Student.newBuilder()
        .setName("erdai")
        .setAge(18)
        .setEmail("erdai666@qq.com")
        .addAllCourse(mutableListOf("Math", "English", "Computer"))
        .build()
    println(student)
    println()
    println(StudentOuterClass.Weather.Season.SPRING.number)
    println(StudentOuterClass.Weather.Season.SUMMER.number)
    println(StudentOuterClass.Weather.Season.AUTUMN.number)
    println(StudentOuterClass.Weather.Season.WINTER.number)
}

//打印结果
name: "erdai"
age: 18
email: "erdai666@qq.com"
course: "Math"
course: "English"
course: "Computer"

0
1
2
3

fun main(){
    //1、构建 Protobuf 对象
    val student = StudentOuterClass.Student.newBuilder()
        .setName("erdai")
        .setAge(18)
        .setEmail("erdai666@qq.com")
        .addAllCourse(mutableListOf("Math", "English", "Computer"))
        .build()
    //2、序列化并返回一个包含其原始字节的字节数组
    val byteArray: ByteArray = student.toByteArray()
    //3、反序列化从字节数组中解析消息
    val parseStudent: StudentOuterClass.Student = StudentOuterClass.Student.parseFrom(byteArray)
}

implementation 'com.google.protobuf:protobuf-java-util:3.19.2'

fun main(){
    //1、构建 Protobuf 对象
    val student = StudentOuterClass.Student.newBuilder()
        .setName("erdai")
        .setAge(18)
        .setEmail("erdai666@qq.com")
        .addAllCourse(mutableListOf("Math", "English", "Computer"))
        .build()
    //2、Protobuf 转 Json
    val json = JsonFormat.printer().print(student)
    //3、打印 json
    println(json)
}

//打印结果
{
  "name": "erdai",
  "age": 18,
  "email": "erdai666@qq.com",
  "course": ["Math", "English", "Computer"]
}

fun main(){
    //1、构建 Protobuf 对象
    val student = StudentOuterClass.Student.newBuilder()
        .setName("erdai")
        .setAge(18)
        .setEmail("erdai666@qq.com")
        .addAllCourse(mutableListOf("Math", "English", "Computer"))
        .build()
    //2、Protobuf 对象转 Json
    val json = JsonFormat.printer().print(student)
    //3、Json 转 Protobuf 对象
    val builder = StudentOuterClass.Student.newBuilder()
    JsonFormat.parser().ignoringUnknownFields().merge(json,builder)
    //4、打印 Protobuf 对象
    println(builder.build())
}

//打印结果
name: "erdai"
age: 18
email: "erdai666@qq.com"
course: "Math"
course: "English"
course: "Computer"

这里我们先引入 Gson库：
implementation 'com.google.code.gson:gson:2.8.9'

data class MyStudent(
    varname: String? = "",
    varage: Int = 0,
    varemail: String? = "",
    varcourse: MutableList<String>? = null
)

fun main(){
    //1、构建 Protobuf 对象
    val student = StudentOuterClass.Student.newBuilder()
        .setName("erdai")
        .setAge(18)
        .setEmail("erdai666@qq.com")
        .addAllCourse(mutableListOf("Math", "English", "Computer"))
        .build()
    //2、将 Protobuf 转换为 Json
    val json = JsonFormat.printer().print(student)

    //3、将 Json 转换为 Java Bean 对象
    val myStudent = Gson().fromJson(json,MyStudent::class.java)
    println(myStudent)
}

//打印结果
MyStudent(name=erdai, age=18, email=erdai666@qq.com, course=[Math, English, Computer])

• 1）一般都是后台定义好 Protobuf；
  
• 2）然后给到我们客户端；
  
• 3）客户端在根据 Protobuf 生成对应平台的代码进行使用即可。
  

- 移动端IM开发入门文章：《新手入门一篇就够：从零开发移动端IM》
- 开源IM框架源码：https://github.com/JackJiang2011/MobileIMSDK（备用地址点此）