gRPC学习记录(三)--proto3知识

标签（空格分隔）： javaWEB

---

在上一篇中,得知proto文件是定义服务端和客户端通讯接口的标准,说白了就是客户端该传什么样的参数,服务端该返回什么样子的参数,客户端该怎么调用,是阻塞还是非阻塞,是同步还是异步,那么就需要对这个东西有所了解,该篇了解基于官方文档.

建议有能力的还是直接看官方文档,该文章内容是个人看文档时的摘录.

https://developers.google.com/protocol-buffers/docs/javatutorial

https://developers.google.com/protocol-buffers/docs/proto3

---

1.定义一个message

syntax = "proto3";//指定版本为proto3,默认为proto2

message SearchRequest {
    string query = 1;
    int32 page_number = 2;
    int32 result_per_page = 3;
}

分别对应了生成代码的String和Integer,另外消息定义中的每个字段都有唯一的编号标签,也就是tag,比如query是1,page_number是2。这些标记用于以消息二进制格式标识字段，并且在使用消息类型后不应更改。注意，值在1到15范围内的标签需要一个字节进行编码，包括标识号和字段类型（您可以在协议缓冲区编码中找到更多信息）。在16到2047范围内的标签采用两个字节。因此，您应该为非常频繁出现的消息元素保留标签1到15。记住要为可能在将来添加的频繁出现的元素留出一些空间。

生成后的结构如下:

Paste_Image.png

2.保留tag和字段

如果您通过完全删除字段或对其进行注释来更新消息类型，以后的用户可以在对类型进行自己的更新时重新使用标记编号。如果以后加载相同.proto的旧版本，包括数据损坏，隐私错误等，这可能会导致严重的问题。确保不会发生这种情况的一种方法是指定保留已删除字段的字段标签.

message Foo {
  reserved 2, 15, 9 to 11;
  reserved "foo", "bar";
}

3.数据类型对照

3.1基本数据类型

proto	Java
double	double
float	float
int32/uint32/sint32/fixed32/sfixed32	int
int64/uint64/sint64/fixed64/sfixed64	long
bool	boolean
string	String
bytes	ByteString

针对数值型,默认值为0,字符型默认值为空,布尔型默认值为false,这个生成验证下就能得知.

3.2枚举类型

定义如下:

message SearchRequest {
  string query = 1;
  int32 page_number = 2;
  int32 result_per_page = 3;
  enum Corpus {
    UNIVERSAL = 0;
    WEB = 1;
    IMAGES = 2;
    LOCAL = 3;
    NEWS = 4;
    PRODUCTS = 5;
    VIDEO = 6;
  }
  Corpus corpus = 4;
}

另外要注意,枚举中第一个元素的tag必须为0.

3.3其他message类型

为searchRequest定义一个返回信息

message SearchResponse {
  repeated Result results = 1;
}

message Result {
  string url = 1;
  string title = 2;
  repeated string snippets = 3;
}

这里用到了repeated,代表这是一个集合,所以翻译后为

    /**
     * <code>repeated .Result results = 1;</code>
     */
    java.util.List<Demo1.Result> getResultsList();
    /**
     * <code>repeated string snippets = 3;</code>
     */
    java.util.List<java.lang.String> getSnippetsList();

3.4导入其他proto文件

导入后就可以使用其下定义的一些信息,这里的路径测试时包名路径,并不是相对文件夹路径.

import "myproject/other_protos.proto";

3.5嵌套定义

本质翻译为一个内部静态类,所以其他message可以按照静态类模式调用

message SearchResponse {
  message Result {
    string url = 1;
    string title = 2;
    repeated string snippets = 3;
  }
  repeated Result results = 1;
}

其他类调用

message SomeOtherMessage {
  SearchResponse.Result result = 1;
}

3.6 Any类型

可以代指任意类型,使用pack和unpack方法包裹对应的信息.

import "google/protobuf/any.proto";

message ErrorStatus {
  string message = 1;
  repeated google.protobuf.Any details = 2;
}

3.7Maps类型

map<key_type, value_type> map_field = N;

4.定义Service

service SearchService {
    rpc Search (SearchRequest) returns (SearchResponse);
}

5.Options选项

• option java_package = "com.example.foo"; 生成的类所在的包,和package作用一致,不过package一般不使用反向域名作为名称.
• option java_multiple_files = true;为true的话,生成代码不会在一个类中,也就是把之前的内部类提到外面单独成为一个java文件.
• option java_outer_classname = "name";最外层Java类名称,默认是文件名首字母大写的驼峰标识后的字串.
• option optimize_for = CODE_SIZE;没看明白
• int32 old_field = 6 [deprecated=true]; 标识该字段不推荐使用