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