介绍文档:proto 文件的关键字介绍

简介: 介绍文档:proto 文件的关键字介绍

引言

使用proto文件的时候,会遇到一个问题,不知道proto文件中都有哪些关键字,我在这里做了集中整理,方柏霓后续人员学习时查阅。以下是详细内容。

关键字介绍

proto文件是Google Protocol Buffers的定义文件,用于定义数据结构和消息格式。以下是proto文件中常用的关键字:

  1. syntax:指定proto文件使用的语法版本。
  2. package:指定生成的代码所在的包名。
  3. import:导入其他proto文件。
  4. option:设置特定的选项。
  5. message:定义消息类型。
  6. enum:定义枚举类型。
  7. service:定义服务接口。
  8. rpc:定义远程过程调用方法。
  9. oneof:定义互斥字段,只能选择其中一个字段。
  10. map:定义映射类型,类似于字典。
  11. repeated:定义重复字段,可以有多个值。
  12. required:定义必需字段,必须有值。
  13. optional:定义可选字段,可以有值也可以为空。
  14. extensions:定义扩展字段。
  15. extend:扩展已有的消息类型或枚举类型。

关键字使用介绍

好的,以下是每个关键字的使用示例:

  1. syntax:
syntax = "proto3";
  1. package:
package mypackage;
  1. import:
import "google/protobuf/timestamp.proto";
  1. option:
option java_package = "com.example.mypackage";


  1. message:
message Person {
 string name = 1;
  int32 age = 2;
   repeated string phone_numbers = 3;
}
  1. enum:
enum PhoneType {
  MOBILE = 0;
   HOME = 1;
  WORK = 2;
}


  1. service:
service MyService {
  rpc GetData (GetDataRequest) returns (GetDataResponse);
}


  1. rpc:
rpc GetData (GetDataRequest) returns (GetDataResponse);


  1. oneof:
message Person {
  string name = 1;
  oneof phone_number {
    string mobile = 2;
    string home = 3;
    string work = 4;
      }
}



  1. map:
message Person {
  string name = 1;
  map<string, string> phone_numbers = 2;
}


  1. repeated:
message Person {
  string name = 1;
  repeated string phone_numbers = 2;
}
  1. required:
message Person {
  required string name = 1;
  required int32 age = 2;
}


  1. optional:
message Person {
  optional string name = 1;
  optional int32 age = 2;
}


  1. extensions:
extend Person {
  extensions 100 to 199;
  optional string email_address = 100;
}


  1. extend:
extend google.protobuf.Timestamp {
  optional string timezone = 1000;
}

嵌套使用示例

下面是一些示例,展示了proto文件中的嵌套、数组和以结构体为值的映射的用法:


  1. 嵌套示例:
syntax = "proto3";

message Address {
  string street = 1;
  string city = 2;
  string state = 3;
}

message Person {
  string name = 1;
  int32 age = 2;
  Address address = 3;
}

在上面的示例中,Address是一个嵌套在Person中的消息类型。

  1. 数组示例:
syntax = "proto3";

message Person {
  string name = 1;
  repeated string phone_numbers = 2;
}

在上面的示例中,phone_numbers字段是一个字符串数组。

  1. 以结构体为值的映射示例:
syntax = "proto3";

message Person {
  string name = 1;
  map<string, Address> addresses = 2;
}

message Address {
  string street = 1;
  string city = 2;
  string state = 3;
}


在上面的示例中,addresses字段是一个以字符串为键、Address结构体为值的映射。

这些示例展示了如何在proto文件中使用嵌套、数组和以结构体为值的映射,你可以根据自己的需求进行相应的定义和使用。


除了嵌套、数组和以结构体为值的映射之外,还有一些其他复杂的用法可以在proto文件中使用。以下是一些示例:

  1. 自定义枚举值:
syntax = "proto3";

enum PhoneType {
  MOBILE = 0;
  HOME = 1;
  WORK = 2;
  CUSTOM = 3;
}

在上面的示例中,我们定义了一个自定义的枚举值CUSTOM。


  1. 扩展字段:
syntax = "proto3";

message Person {
  string name = 1;
  extensions 100 to 199;
}

extend Person {
  optional string email = 100;
}

在上面的示例中,我们使用extend关键字扩展了Person消息类型,添加了一个可选的email字段。

  1. 服务定义和RPC方法:
syntax = "proto3";

service MyService {
  rpc GetData (GetDataRequest) returns (GetDataResponse);
  rpc UpdateData (UpdateDataRequest) returns (UpdateDataResponse);
}

message GetDataRequest {
  string id = 1;
}

message GetDataResponse {
  string data = 1;
}

message UpdateDataRequest {
  string id = 1;
  string newData = 2;
}

message UpdateDataResponse {
  bool success = 1;
}

在上面的示例中,我们定义了一个名为MyService的服务,其中包含了两个RPC方法:GetData和UpdateData。每个RPC方法都有对应的请求消息和响应消息。

这些示例展示了一些复杂的用法,你可以根据自己的需求在proto文件中进行定义和使用。

分享一个有趣的 学习链接:https://xxetb.xet.tech/s/HY8za


目录
相关文章
|
25天前
|
C++
C++的引用定义语法和应用
C++的引用定义语法和应用
|
14天前
|
Rust 编译器
Rust中的模块路径和pub关键字详解
Rust中的模块路径和pub关键字详解
8 0
|
2月前
|
JavaScript 前端开发 开发者
js开发:请解释什么是ES6的let和const关键字,以及它们与var关键字的区别。
ES6引入`let`和`const`替代`var`声明变量。`let`有块级作用域,存在暂时性死区,不进行变量提升,可重新赋值。`const`用于常量,值不可变但引用类型内容可变,同样有块级作用域和暂时性死区。与`var`主要区别在于作用域、变量提升和可变性。这些改进提高了代码的可预测性和安全性。
38 2
|
2月前
|
安全 程序员 编译器
【C/C++ 常用关键字使用指南】C++ 关键字 在头文件和源文件中函数声明与定义使用上的差异
【C/C++ 常用关键字使用指南】C++ 关键字 在头文件和源文件中函数声明与定义使用上的差异
122 0
|
算法 C++ Python
师父给了我一个 .proto 文件,我应该怎么使用?
师父给了我一个 .proto 文件,我应该怎么使用?
146 0
|
容器
解析Obj-C中的assgin,copy,retain关键字的含义。
解析Obj-C中的assgin,copy,retain关键字的含义。
69 0
|
Java
【JPA CriteriaBuilder 如何使用关键字“in“】
修改公司的老项目,突然要用到这个知识点,但是自己查到的这方面的文章太少了,就自己总结了一份,亲测正确!
471 0
Swift5.1—隐式解包可选值属性
Swift5.1—隐式解包可选值属性
225 0
ABAP 7.40新的关键字BASE的用法
ABAP 7.40新的关键字BASE的用法
512 0