Any
- 作為嵌套類型表制,不用include定義
- 包含任意序列化的消息(字節(jié))健爬,以及一個URL,該URL充當該消息的全局唯一標識符并解析為該消息的類型么介。
使用Any類型, 需要導入google/protobuf/any.proto.
官方示例
import "google/protobuf/any.proto";
message ErrorStatus {
string message = 1;
repeated google.protobuf.Any details = 2;
}
指定消息類型的默認類型URL是type.googleapis.com/packagename.messagename
不同的語言實現(xiàn)將支持運行時庫助手以typesafe方式打包和解壓縮ANY類型的值——例如娜遵,在Java中,任何類型都有特殊的pack()和unpack()訪問器夭拌,而在c++中有PackFrom()和UnpackTo()方法:
// Storing an arbitrary message type in Any.
NetworkErrorDetails details = ...;
ErrorStatus status;
status.add_details()->PackFrom(details);
// Reading an arbitrary message from Any.
ErrorStatus status = ...;
for (const Any& detail : status.details()) {
if (detail.Is<NetworkErrorDetails>()) {
NetworkErrorDetails network_error;
detail.UnpackTo(&network_error);
... processing network_error ...
}
}
更多功能還在開發(fā)中魔熏,可以關(guān)注版本的迭代情況
Oneof
如果您有一條包含許多字段的消息衷咽,并且最多同時設(shè)置一個字段鸽扁,您可以使用其中oneof功能來強制執(zhí)行此行為并節(jié)省內(nèi)存。
Oneof 字段類似于常規(guī)字段镶骗,除了Oneof共享內(nèi)存的所有字段之外桶现,最多可以同時設(shè)置一個字段。設(shè)置Oneof 的任何成員都會自動清除所有其他成員鼎姊。您可以使用case()或WhichOneof()方法檢查Oneof 中的哪個值被設(shè)置(如果有的話)骡和,具體取決于您選擇的語言相赁。
使用Oneof
在您的 .proto中定義一個oneof 關(guān)鍵字后跟著oneof 名稱,在本例中為test_oneof:
message SampleMessage {
oneof test_oneof {
string name = 4;
SubMessage sub_message = 9;
}
}
然后將您的oneof字段添加到oneof定義中慰于。您可以添加任何類型的字段钮科,但不能使用重復字段。
在生成的代碼中婆赠,oneof字段具有與常規(guī)字段相同的setter和getter方法。您還可以獲得一種特殊的方法來檢查中的哪個值(如果有的話)被設(shè)置。你可以在相關(guān)的API參考中找到更多關(guān)于你選擇的語言的API剃盾。
Oneof功能
設(shè)置oneof字段將自動清除oneof字段的所有其他成員坏逢。因此,如果您設(shè)置了幾個oneof字段妙黍,則只有最后一個字段仍然有值悴侵。
SampleMessage message;
message.set_name("name");
CHECK(message.has_name());
message.mutable_sub_message(); // Will clear name field.
CHECK(!message.has_name());
- 如果解析器遇到同一oneof的多個成員,則在解析的消息中只使用最后一個成員拭嫁。
- oneof不能重復可免。
- 反射APIs適用于oneof字段。
- 如果您正在使用c++做粤,請確保代碼不會導致內(nèi)存崩潰巴元。下面的示例代碼將導致內(nèi)存崩潰,因為它通過set_name()方法調(diào)用了已經(jīng)刪除掉的sub_message驮宴。
SampleMessage message;
SubMessage* sub_message = message.mutable_sub_message();
message.set_name("name"); // Will delete sub_message
sub_message->set_... // Crashes here
- 同樣在C++中逮刨,如果使用同一個帶有oneof類型數(shù)據(jù)的消息,兩個消息可以通過swap互相改變彼此的oneof
SampleMessage msg1;
msg1.set_name("name");
SampleMessage msg2;
msg2.mutable_sub_message();
msg1.swap(&msg2);
CHECK(msg1.has_sub_message());
CHECK(msg2.has_name());
Maps
創(chuàng)建關(guān)聯(lián)映射
map<key_type, value_type> map_field = N;
其中key_type可以是任何整數(shù)或字符串類型(除浮點類型和字節(jié)以外的任何標量類型)堵泽。枚舉不是有效的key_type,value_type可以是除map之外的任何類型修己。
例如,如果您想為一個項目創(chuàng)建map迎罗,其中每個消息都與一個字符串鍵相關(guān)聯(lián)睬愤,您可以這樣定義它:
map<string, Project> projects = 3;
map不能設(shè)置為repeated
map的遍歷是無序的
為proto生成文本格式時,map按key排序纹安。數(shù)字key按數(shù)字排序尤辱。
從線上解析或合并時,如果有重復的map鍵厢岂,則使用最后的鍵光督。從文本格式解析map時,如果存在重復的鍵塔粒,解析可能會失敗结借。
如果為映射字段提供了鍵但沒有值,則序列化該字段時的行為取決于語言卒茬。在c++船老、Java和Python中咖熟,序列化該類型的默認值,而在其他語言中柳畔,不進行序列化馍管。
更多map的api參考 API reference