Android中Protobuf的基本使用介紹
前言
Protobuf,類似于json和xml,是一種序列化結(jié)構(gòu)數(shù)據(jù)機(jī)制,可以用于數(shù)據(jù)通訊等場(chǎng)景,相對(duì)于xml而言更小,相對(duì)于json而言解析更快,支持多語言。
一、Proto文件示例
Protobuf使用.proto
文件來定義數(shù)據(jù)格式,所以我們首先新建立一個(gè)person.proto
文件,并在文件中填下如下內(nèi)容:
//指定proto的版本為proto3,不寫的話默認(rèn)為proto2. syntax = "proto3"; //包名 package proto; //引入包 //import ""; //指定生成類所在的Java包名 option java_package = "com.example.demowork1"; //重命名,如果不寫,默認(rèn)為文件名的首字母大寫轉(zhuǎn)化生成,如本文件如果不寫則是Person option java_outer_classname = "PersonProto"; message Person{ string name = 1; int32 id = 2; bool boo = 3; string email = 4; string phone = 5; }
這樣我們就定義好了一個(gè)基本的Person對(duì)象,下面我們對(duì)文件中的關(guān)鍵字進(jìn)行一一說明:
**syntax:**指定proto的版本,protobuf目前有proto2和proto3兩個(gè)常用版本,如果沒有聲明,則默認(rèn)是proto2.
**package:**指定包名。
**import:**導(dǎo)入包,類似于java的import.
**java_package:**指定生成類所在的包名
**java_outer_classname:**定義當(dāng)前文件的類名,如果沒有定義,則默認(rèn)為文件的首字母大寫名稱
**message:**定義類,類似于java class;可以嵌套
**repeated:**字段可以有多個(gè)內(nèi)容(包括0),類似于array
需要注意的是在聲明了屬性之后,需要對(duì)屬性聲明一個(gè)tag(示例代碼中的:1,2,3)。
這個(gè)tag是ProtoBuf編碼是使用來標(biāo)識(shí)屬性的,因此在定義了一個(gè)message的屬性之后,最好不要再去修改屬性的tag值以免造成舊數(shù)據(jù)解析錯(cuò)誤。
二、在Android中的使用
protobuf可以在Android中進(jìn)行使用,并且集成對(duì)應(yīng)的Gradle Plugin能夠快速的編譯proto文件。
其基本的編譯流程如下:
下面我們直接使用上面的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 {}// 生產(chǎn)java源碼 } } } }
在完成了上述配置之后,執(zhí)行一下rebuild方法,這樣我們就能夠自動(dòng)生成proto java class文件了。
2.、基本調(diào)用
下面我們?cè)贛odule工程中調(diào)用一下我們生成的文件,我們先首先生成一個(gè)Person對(duì)象,然后把轉(zhuǎn)換的byte[]再解析一下查看結(jié)果是否正確,代碼如下:
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) }
執(zhí)行運(yùn)行之后,我們能看到正確的輸出結(jié)果:
com.example.demowork1 D/message: name: "Tom" id: 111 email: "123@123.com" phone: "123456789"
總結(jié)
到此這篇關(guān)于Android中Protobuf的基本使用介紹的文章就介紹到這了,更多相關(guān)Android Protobuf內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
Android BottomSheet效果的兩種實(shí)現(xiàn)方式
這篇文章主要介紹了Android BottomSheet效果的兩種實(shí)現(xiàn)方式,小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2018-08-08Android自定義控件之圓形進(jìn)度條動(dòng)畫
這篇文章主要為大家詳細(xì)介紹了Android自定義控件之圓形進(jìn)度條動(dòng)畫,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2020-07-07Flutter上的數(shù)據(jù)監(jiān)控深入理解
這篇文章主要給大家介紹了關(guān)于Flutter上的數(shù)據(jù)監(jiān)控的相關(guān)資料,文中通過示例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用Flutter具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來一起學(xué)習(xí)學(xué)習(xí)吧2019-06-06Android中實(shí)現(xiàn)Webview頂部帶進(jìn)度條的方法
這篇文章主要介紹了Android中實(shí)現(xiàn)Webview頂部帶進(jìn)度條的方法,當(dāng)前很流行的一個(gè)效果,就是打開網(wǎng)頁時(shí)會(huì)在頂部顯示一個(gè)打開進(jìn)度條,需要的朋友可以參考下2015-01-01Android 再按一次退出程序的實(shí)現(xiàn)方法
抽空研究了一下"再按一次退出程序"的實(shí)現(xiàn)方式,直接上代碼(請(qǐng)自動(dòng)忽略無關(guān)代碼)2014-01-01Android自定義Dialog實(shí)現(xiàn)通用圓角對(duì)話框
這篇文章主要為大家詳細(xì)介紹了Android自定義Dialog實(shí)現(xiàn)通用圓角對(duì)話框,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2018-11-11Android自定義控件實(shí)現(xiàn)溫度旋轉(zhuǎn)按鈕效果
這篇文章主要給大家介紹了關(guān)于Android如何通過自定義控件實(shí)現(xiàn)溫度旋轉(zhuǎn)按鈕的效果,文中通過思路與方法一步步介紹的很詳細(xì),相信對(duì)大家的理解和學(xué)習(xí)具有一定的參考借鑒價(jià)值,有需要的朋友們下面來一起看看吧。2016-12-12Android RecyclerView使用GridLayoutManager間距設(shè)置的方法
本篇文章主要介紹了Android RecyclerView使用GridLayoutManager間距設(shè)置的方法,具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2017-12-12Android自定義照相機(jī)倒計(jì)時(shí)拍照
本文給大家介紹Android自定義照相機(jī),并且實(shí)現(xiàn)倒計(jì)時(shí)拍照功能,對(duì)android自定義照相機(jī)相關(guān)知識(shí)感興趣的朋友一起學(xué)習(xí)吧2015-12-12