Android中Protobuf的基本使用介绍

 更新时间:2022年01月29日 11:35:14   作者:静水红阳  
大家好,本篇文章主要讲的是Android中Protobuf的基本使用介绍,感兴趣的同学赶快来看一看吧,对你有帮助的话记得收藏一下

前言

Protobuf,类似于json和xml,是一种序列化结构数据机制,可以用于数据通讯等场景,相对于xml而言更小,相对于json而言解析更快,支持多语言。

一、Proto文件示例

Protobuf使用.proto文件来定义数据格式,所以我们首先新建立一个person.proto文件,并在文件中填下如下内容:

//指定proto的版本为proto3,不写的话默认为proto2.
syntax = "proto3";
//包名
package proto;
//引入包
//import "";
//指定生成类所在的Java包名
option java_package = "com.example.demowork1";
//重命名,如果不写,默认为文件名的首字母大写转化生成,如本文件如果不写则是Person
option java_outer_classname = "PersonProto";

message Person{
  string name = 1;
  int32 id = 2;
  bool boo = 3;
  string email = 4;
  string phone = 5;
}

这样我们就定义好了一个基本的Person对象,下面我们对文件中的关键字进行一一说明:

**syntax:**指定proto的版本,protobuf目前有proto2和proto3两个常用版本,如果没有声明,则默认是proto2.

**package:**指定包名。

**import:**导入包,类似于java的import.

**java_package:**指定生成类所在的包名

**java_outer_classname:**定义当前文件的类名,如果没有定义,则默认为文件的首字母大写名称

**message:**定义类,类似于java class;可以嵌套

**repeated:**字段可以有多个内容(包括0),类似于array

需要注意的是在声明了属性之后,需要对属性声明一个tag(示例代码中的:1,2,3)。

这个tag是ProtoBuf编码是使用来标识属性的,因此在定义了一个message的属性之后,最好不要再去修改属性的tag值以免造成旧数据解析错误。

二、在Android中的使用

protobuf可以在Android中进行使用,并且集成对应的Gradle Plugin能够快速的编译proto文件。

其基本的编译流程如下:

protobuf基本解析.png

下面我们直接使用上面的person.proto文件来举例说明。

1、 plugin配置

首先我们需要在工程目录下的build.gradle文件中引入protobuf,示例代码如下:

buildscript {
    ext.kotlin_version = "1.3.72"
    repositories {
        google()
        jcenter()
        maven { url "https://jitpack.io" }
        mavenCentral()
    }
    dependencies {
        classpath "com.android.tools.build:gradle:4.1.0"
        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
        classpath 'com.google.protobuf:protobuf-gradle-plugin:0.8.8'

        // NOTE: Do not place your application dependencies here; they belong
        // in the individual module build.gradle files
    }
}

然后我们还需要在Module目录下的build.gradle文件下添加配置,示例如下:

plugins {
  	...
    id 'com.google.protobuf'
}
android{
	...
        sourceSets {
        main {
            java.srcDirs = ['src/main/java']
            jniLibs.srcDirs = ['libs']
            assets.srcDirs = ['assets']

            proto {
                //指定proto文件位置,你的proto文件放置在此文件夹中
                srcDir 'src/main/proto'
            }
        }
    }
}
dependencies{
	...
	    implementation 'com.google.protobuf:protobuf-java:3.5.1'
    	implementation 'com.google.protobuf:protoc:3.5.1'
}
protobuf {
    protoc {
        artifact = 'com.google.protobuf:protoc:3.5.1' // 也可以配置本地编译器路径
    }

    generateProtoTasks {
        all().each { task ->
            task.builtins {
                remove java
            }
            task.builtins {
                java {}// 生产java源码
            }
        }
    }
}

在完成了上述配置之后,执行一下rebuild方法,这样我们就能够自动生成proto java class文件了。

2.、基本调用

下面我们在Module工程中调用一下我们生成的文件,我们先首先生成一个Person对象,然后把转换的byte[]再解析一下查看结果是否正确,代码如下:

        var person1 = PersonProto.Person.newBuilder().setName("Tom")
            .setId(111).setBoo(false).setEmail("123@123.com").setPhone("123456789")
            .build()
        tvData.setOnClickListener {
            var dataTemp = PersonProto.Person.parseFrom(person1.toByteArray())
            LogUtil.instance.d(dataTemp.toString())
//            mHandler.sendEmptyMessage(1)
        }

执行运行之后,我们能看到正确的输出结果:

com.example.demowork1 D/message: name: "Tom"
    id: 111
    email: "123@123.com"
    phone: "123456789"

总结

到此这篇关于Android中Protobuf的基本使用介绍的文章就介绍到这了,更多相关Android Protobuf内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

您可能感兴趣的文章:

相关文章

  • Android BottomSheet效果的两种实现方式

    Android BottomSheet效果的两种实现方式

    这篇文章主要介绍了Android BottomSheet效果的两种实现方式,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2018-08-08
  • Android自定义控件之圆形进度条动画

    Android自定义控件之圆形进度条动画

    这篇文章主要为大家详细介绍了Android自定义控件之圆形进度条动画,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-07-07
  • Flutter上的数据监控深入理解

    Flutter上的数据监控深入理解

    这篇文章主要给大家介绍了关于Flutter上的数据监控的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用Flutter具有一定的参考学习价值,需要的朋友们下面来一起学习学习吧
    2019-06-06
  • Android中实现Webview顶部带进度条的方法

    Android中实现Webview顶部带进度条的方法

    这篇文章主要介绍了Android中实现Webview顶部带进度条的方法,当前很流行的一个效果,就是打开网页时会在顶部显示一个打开进度条,需要的朋友可以参考下
    2015-01-01
  • Android开发退出程序的方法汇总

    Android开发退出程序的方法汇总

    Android程序有很多Activity,比如说主窗口A,调用了子窗口B,子窗口B又调用子窗口C,back返回子窗口B后,在B中如何关闭整个Android应用程序呢? 下面脚本之家小编就给大家介绍android开发退出程序的几种方法,感兴趣的朋友参考下吧
    2016-03-03
  • Android 再按一次退出程序的实现方法

    Android 再按一次退出程序的实现方法

    抽空研究了一下"再按一次退出程序"的实现方式,直接上代码(请自动忽略无关代码)
    2014-01-01
  • Android自定义Dialog实现通用圆角对话框

    Android自定义Dialog实现通用圆角对话框

    这篇文章主要为大家详细介绍了Android自定义Dialog实现通用圆角对话框,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-11-11
  • Android自定义控件实现温度旋转按钮效果

    Android自定义控件实现温度旋转按钮效果

    这篇文章主要给大家介绍了关于Android如何通过自定义控件实现温度旋转按钮的效果,文中通过思路与方法一步步介绍的很详细,相信对大家的理解和学习具有一定的参考借鉴价值,有需要的朋友们下面来一起看看吧。
    2016-12-12
  • Android RecyclerView使用GridLayoutManager间距设置的方法

    Android RecyclerView使用GridLayoutManager间距设置的方法

    本篇文章主要介绍了Android RecyclerView使用GridLayoutManager间距设置的方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-12-12
  • Android自定义照相机倒计时拍照

    Android自定义照相机倒计时拍照

    本文给大家介绍Android自定义照相机,并且实现倒计时拍照功能,对android自定义照相机相关知识感兴趣的朋友一起学习吧
    2015-12-12

最新评论