關(guān)于protobuf的筆記

package tutorial;在Protocol Buffers命名空間和非Java語言中避免命名沖突

option java_package = "com.example.tutorial";包名,

option java_outer_classname = "AddressBookProtos";類名

一個(gè)message只是一系列具有類型的域的集合。許多標(biāo)準(zhǔn)的簡單類型可以做為可用的域類型,包括bool, int32, float, double, 和string。enum

required:域的值必須被提供,否則message會(huì)被認(rèn)為是“未初始化的”。試圖創(chuàng)建一個(gè)未初始化的message將會(huì)拋出一個(gè)RuntimeException。轉(zhuǎn)化一個(gè)未初始化的message將會(huì)拋出一個(gè)IOException。除了這些,required域的行為和optional域表現(xiàn)相同。

optional:該域可能被設(shè)置,也可能未被設(shè)置。如果一個(gè)optional域未被設(shè)置,默認(rèn)的值將會(huì)被使用。對于簡單類型來說,你可以指定你自己的默認(rèn)值,就像我們在例子中對phone number類型所做的那樣。否則,一個(gè)系統(tǒng)默認(rèn)的值將被使用:數(shù)值類型是0,字符串類型是"",布爾類型是false。對于嵌入式的message來說,默認(rèn)值總是這個(gè)message的沒有任何域被設(shè)置過的“默認(rèn)實(shí)例”或“原型”。調(diào)用訪問器去獲取一個(gè)optional或者required域的值,這些域如果沒有被具體設(shè)置,那么總是返回域的默認(rèn)值。

repeated:域?qū)?huì)被重復(fù)任意次數(shù)(包括0次)。重復(fù)的值的順序?qū)?huì)被保存在protocol buffer中。可以把重復(fù)的域想成變長的數(shù)組。

每一個(gè)域都有簡單的JavaBeans風(fēng)格的getters和setters方法。如果一個(gè)域被設(shè)置了值,同樣會(huì)有g(shù)etters為每一個(gè)單獨(dú)的域。最后,每一個(gè)域都有一個(gè)clear方法,用來將域設(shè)置回原來的空狀態(tài)。

Repeated域有一些額外的方法--一個(gè)Count方法(用來速記列表的大小),getters和setters用來通過下標(biāo),get或者set一個(gè)具體的元素。一個(gè)add方法用來向列表中追加一個(gè)新元素。一個(gè)addAll方法用來追加整個(gè)容器中的元素到列表中。

isInitialized():檢查是否所有的required域都已經(jīng)被設(shè)置過。

toString():返回一個(gè)便于人眼閱讀的message的展示,在debug的時(shí)候特別有用。

mergeFrom(Message other):(builder特有)合并other的內(nèi)容到這個(gè)message中,如果是單數(shù)域則覆蓋,如果是重復(fù)域則追加連接。

clear():(builder特有)清空所有的域,回到空值狀態(tài)。

byte[] toByteArray();:序列化message并返回一個(gè)包含它原始字節(jié)的byte數(shù)組。

static Person parseFrom(byte[] data);:從給出的byte數(shù)組轉(zhuǎn)化一個(gè)message。

void writeTo(OutputStream output);:序列化message,并將其寫入一個(gè)OutputStream。

static Person parseFrom(InputStream input);:從一個(gè)InputStream中讀取并轉(zhuǎn)化一個(gè)message。

Protocol message類提供的一個(gè)關(guān)鍵特性是反射。你可以迭代一個(gè)message中的域,并且不用寫任何與message中類型抵觸的代碼,來操作它們的值它們的值。一個(gè)非常有用的方法是使用反射來將protocol message轉(zhuǎn)為或轉(zhuǎn)自其它的編碼方式,比如:XML或JSON。

你一定不能改變?nèi)魏我汛嬖诘挠虻膖ag number。

你一定不能添加或刪除任何required域。

你可以刪除optional域或repeated域。

你可以添加新的optional域或repeated域,但是你必須使用新的tag number(比如:你在這個(gè)protocol buffer中從沒使用過的tag number,甚至不能是已刪除的域的tag number)。

(關(guān)于這些約定有一些例外的情況,但它們極少被用到。)

如果你遵守這些規(guī)則,舊的代碼將會(huì)很好地讀取新的message,并且輕易地忽略任何新的域。對于舊的代碼來說,被刪除的optional域?qū)⒂兴鼈兊哪J(rèn)值,并且被刪除的repeated域?qū)?huì)為空。新的代碼將會(huì)透明地讀取舊的message。然而,需要牢記的是新的optional域?qū)⒉粫?huì)在舊的message中出現(xiàn),所以你將需要具體檢查它們是否被has_設(shè)置,或者提供一個(gè)可靠的默認(rèn)值在你的.proto文件中,即在tag number后面寫[default = value]。如果一個(gè)optional元素未被具體指定,那么取而代之地,一個(gè)具體類型的默認(rèn)值將被使用:對于string,默認(rèn)值是空串。對于boolean,默認(rèn)值是false。對于numeric類型,默認(rèn)值是0。同樣記得,如果你添加了一個(gè)新的repeated域,你的新代碼將不能識(shí)別它是被置空(通過新的代碼)還是從來沒有被設(shè)置過(通過舊的代碼)。因?yàn)椋瑳]有為它提供has_標(biāo)記。

protoc.exe --java_out=E:\java PersonMsg.proto

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,321評論 6 543
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 99,559評論 3 429
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,442評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,835評論 1 317
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 72,581評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,922評論 1 328
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,931評論 3 447
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 43,096評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,639評論 1 336
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 41,374評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,591評論 1 374
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,104評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,789評論 3 349
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,196評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,524評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 52,322評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,554評論 2 379

推薦閱讀更多精彩內(nèi)容