proto 3 语法

时间:2023-03-10 05:18:26
proto 3 语法

一、简介

proto3是新版本的protobuf语法。它简化了部分语法,并扩大了支持的语言,Ruby、C#。目前谷歌推荐只在是用新支持的语言或使用新的gRPC框架的时候使用。
proto2和proto3不是完全兼容的。这里列出一些proto2与proto3的区别。

二、proto3

希望编译器使用proto3进行编译需要在文件对行加上:

syntax = "proto3";

下面是一个简单的例子:

syntax = "proto3";

message Person {
string name = 1;
int32 age = 2;
repeated string loction = 3;
}

可以看到相比于proto2语法这里没有前面的required/optional,在proto3中所有字段都是可选的,同时取消了自定义默认值,默认值为0或空。

枚举

与proto2不同proto3的枚举值第一个值得tag必须为0,同时枚举值的默认值将默认使用第一个值,这样就和其他类型都保持了统一,即默认值为0。

 enum Location {
SHANGHAI = 0;
BEIJING = 1;
GUANGZHOU = 2;
}

同时proto2的枚举类型不能被proto3直接import,但是间接引用不受影响。

Any

proto3不支持proto2中的extension,但是引入了Any。
在使用Any时需要引入any.proto:

import "google/protobuf/any.proto";

message ErrorStatus {
string message = 1;
repeated google.protobuf.Any details = 2;
}
-----------------------
public static void main(String[] args) throws IOException, ClassNotFoundException {
//定义any
Any any= Any.pack(StringValue.newBuilder().setValue("aaa").build());
//赋值并构建
Demo.Person person=Demo.Person.newBuilder().setDetail(any).build();
//取值
System.out.println(person.getDetail().unpack(StringValue.class));
}

三、其他

proto3去除了proto2中group,新增了一些timestamp、empty的格式(需要手动import)。