共用消息类型
可以使用其他消息类型作为字段类型. 例如, 假设你想在每个SearchResponse消息中包含Result消息，
你可以在相同的.proto文件中定义Result消息类型然后具体指定SearchResponse中的一个字段为Result类型:
message SearchResponse {
repeated Result result = 1;
}
message Result {
string url = 1;
string title = 2;
repeated string snippets = 3;
}
导入定义
示例方式在java上不适用
在上面的例子中, Result消息类型是定义在和SearchResponse同一个文件中，如果你想要作为字段类型使用的消息类型已经在其他的.proto文件中定义了呢?
为了导入其他.proto的定义, 需要在文件的顶端增加导入声明:
import "myproject/other_protos.proto";
默认只能从直接导入的.proto文件中使用其中的定义. 但是, 某些情况下可能需要移动.proto文件到新的位置. 相比直接移动.proto文件并更新所有的调用点, 现在可以有其他的方法: 在原有位置放置一个伪装的.proto文件, 通过使用import public方式转发所有的import到新的位置. 其他任何导入这个包含import public语句的proto文件都可以透明的得到通过import public方法导入的依赖. 例如:
// new.proto
// 所有的依赖被移动到这里
// old.proto
// 这里是所有client需要导入的proto
import public "new.proto";
import "other.proto";
// client.proto
import "old.proto";
// 这里可以使用old.proto 和 new.proto 中的定义, 但是other.proto中的不能使用.
protocol编译器在通过命令行-I/--proto_path参数指定的目录集合中搜索导入的文件. 如果没有指定, 则在编译器被调用的目录下查找. 通常应该设置--proto_path参数到项目所在的根目录然后为所有的导入使用完整限定名.
使用proto2的消息类型
导入proto2的消息类型并在proto3消息中使用是可以的, 反之也如此. 但是, proto2的枚举不能在proto3语法中使用
嵌套类型
message SearchResponse {
message Result {
string url = 1;
string title = 2;
repeated string snippets = 3;
}
repeated Result results = 1;
}
按需求定义不同深度的嵌套
message Outer { // Level 0
message MiddleAA { // Level 1
message Inner { // Level 2
int64 ival = 1;
bool booly = 2;
}
}
message MiddleBB { // Level 1
message Inner { // Level 2
int32 ival = 1;
bool booly = 2;
}
}
}
更新消息类型
如果一个已有的消息类型不再满足需要- 例如, 想增加额外的字段 - 但是依然希望原有格式创建的代码可以继续使用, 记住下面的规则:
- 不要改动任何现有字段的数字标签
- 如果添加新的字段时, 使用"老"消息格式系列化后的任何消息都可以被新生成的代码解析. 注意这些元素的默认值以便新的代码可以正确和老代码生成的消息交互. 类似的, 新代码创建的消息可以被老代码解析: 解析时新的字段被简单的忽略. 注意当消息反序列化时未知字段会失效, 因此如果消息被传递给新代码, 新的字段将不再存在(这个行为和proto2不同, 在proto2中未知字段会和消息一起序列化).
- 字段可以被删除, 但是要求在更新后的消息类型中原来的标签数字不再使用.可以考虑重命名这个字段, 或者添加前缀OBSOLETE_, 或者保留标签, 以防.proto文件以后重用这个数字导致兼容性问题。
- int32, uint32, int64, uint64, 和 bool 是完全兼容的，可以将一个字段的类型从这些类型中的一个修改为另外一个而不会打破向前或者向后兼容。如果一个数字解析时不匹配相应的类型, 效果和在c++里面做类型转换一样(例如64位数字被作为32位整型读取, 将被转换为32位).
- sint32 和 sint64 是彼此兼容的,但是和其他整型类型不兼容.
- string 和 UTF-8编码的bytes 是兼容的。
- 嵌入式的消息和包含编码内容的bytes兼容。
- fixed32 兼容 sfixed32, 而 fixed64 兼容 sfixed64。
更多兼容性的问题可以参考https://developers.google.com/protocol-buffers/docs/proto3#updating
网友评论