package tutorial;在Protocol Buffers命名空間和非Java語言中避免命名沖突
option java_package = "com.example.tutorial";包名,
option java_outer_classname = "AddressBookProtos";類名
一個message只是一系列具有類型的域的集合。許多標準的簡單類型可以做為可用的域類型,包括bool, int32, float, double, 和string。enum
required:域的值必須被提供,否則message會被認為是“未初始化的”。試圖創(chuàng)建一個未初始化的message將會拋出一個RuntimeException。轉化一個未初始化的message將會拋出一個IOException。除了這些,required域的行為和optional域表現(xiàn)相同。
optional:該域可能被設置,也可能未被設置。如果一個optional域未被設置,默認的值將會被使用。對于簡單類型來說,你可以指定你自己的默認值,就像我們在例子中對phone number類型所做的那樣。否則,一個系統(tǒng)默認的值將被使用:數(shù)值類型是0,字符串類型是"",布爾類型是false。對于嵌入式的message來說,默認值總是這個message的沒有任何域被設置過的“默認實例”或“原型”。調用訪問器去獲取一個optional或者required域的值,這些域如果沒有被具體設置,那么總是返回域的默認值。
repeated:域將會被重復任意次數(shù)(包括0次)。重復的值的順序將會被保存在protocol buffer中。可以把重復的域想成變長的數(shù)組。
每一個域都有簡單的JavaBeans風格的getters和setters方法。如果一個域被設置了值,同樣會有getters為每一個單獨的域。最后,每一個域都有一個clear方法,用來將域設置回原來的空狀態(tài)。
Repeated域有一些額外的方法--一個Count方法(用來速記列表的大?。琯etters和setters用來通過下標,get或者set一個具體的元素。一個add方法用來向列表中追加一個新元素。一個addAll方法用來追加整個容器中的元素到列表中。
isInitialized():檢查是否所有的required域都已經(jīng)被設置過。
toString():返回一個便于人眼閱讀的message的展示,在debug的時候特別有用。
mergeFrom(Message other):(builder特有)合并other的內容到這個message中,如果是單數(shù)域則覆蓋,如果是重復域則追加連接。
clear():(builder特有)清空所有的域,回到空值狀態(tài)。
byte[] toByteArray();:序列化message并返回一個包含它原始字節(jié)的byte數(shù)組。
static Person parseFrom(byte[] data);:從給出的byte數(shù)組轉化一個message。
void writeTo(OutputStream output);:序列化message,并將其寫入一個OutputStream。
static Person parseFrom(InputStream input);:從一個InputStream中讀取并轉化一個message。
Protocol message類提供的一個關鍵特性是反射。你可以迭代一個message中的域,并且不用寫任何與message中類型抵觸的代碼,來操作它們的值它們的值。一個非常有用的方法是使用反射來將protocol message轉為或轉自其它的編碼方式,比如:XML或JSON。
你一定不能改變任何已存在的域的tag number。
你一定不能添加或刪除任何required域。
你可以刪除optional域或repeated域。
你可以添加新的optional域或repeated域,但是你必須使用新的tag number(比如:你在這個protocol buffer中從沒使用過的tag number,甚至不能是已刪除的域的tag number)。
(關于這些約定有一些例外的情況,但它們極少被用到。)
如果你遵守這些規(guī)則,舊的代碼將會很好地讀取新的message,并且輕易地忽略任何新的域。對于舊的代碼來說,被刪除的optional域將有它們的默認值,并且被刪除的repeated域將會為空。新的代碼將會透明地讀取舊的message。然而,需要牢記的是新的optional域將不會在舊的message中出現(xiàn),所以你將需要具體檢查它們是否被has_設置,或者提供一個可靠的默認值在你的.proto文件中,即在tag number后面寫[default = value]。如果一個optional元素未被具體指定,那么取而代之地,一個具體類型的默認值將被使用:對于string,默認值是空串。對于boolean,默認值是false。對于numeric類型,默認值是0。同樣記得,如果你添加了一個新的repeated域,你的新代碼將不能識別它是被置空(通過新的代碼)還是從來沒有被設置過(通過舊的代碼)。因為,沒有為它提供has_標記。
protoc.exe --java_out=E:\java PersonMsg.proto