Golang ProtoBuf 初学者完整教程:语法

news2024/11/25 13:54:34

一、编码规范推荐

1、文件名使用小写下划线的命名风格,例如 lower_snake_case.proto
2、使用 2 个空格缩进
3、包名应该和目录结构对应
4、消息名使用首字母大写驼峰风格(CamelCase),例如message StudentRequest { ... }
5、字段名使用小写下划线的风格,例如 string status_code = 1
6、枚举类型,枚举名使用首字母大写驼峰风格,例如 enum FooBar
7、RPC 服务名和方法名,均使用首字母大写驼峰风格,例如service FooService{ rpc GetSomething() }

二、protoC 执行命令

protoc --go_out=. *.proto 

三、标量类型表

四、使用语法案例

// 使用proto3版本
syntax = "proto3";

// 可选,防止不同的消息类型有命名冲突
package main;                     

// 指定go的包名,会在当前目录生成一个main目录,然后里面存放*.pb.go文件
option go_package = "main";         

// 导入其他的proto文件
import "mypro/other.proto";   

// message是关键词,Student是类型名,后续生成一个Student的结构体  
message Student {         
    // 格式:类型 字段名 = 数字标识符,每个标识符是唯一的                                      
    string name = 1;                  

    // repeated代表字段可重复,对应Student结构体里的字段:Scores []int32
    repeated int32 scores = 3;                
  
    // 定义一个map,键是string,值是int32
    map<string, int32> points = 1;    
    
    // 指定了一些字段编号不应该被再次使用。这意味着在 Foo 消息的定义中,你不能再使用字段编号 2、15 以及 9 到 11(包括 9 和 11)来添加新的字段
    reserved 2, 15, 9 to 11;  
    
    // 指定了一些字段名称不应该被再次使用。这意味着在 Foo 消息的定义中,你不能再使用字段名称 foo 或 bar 来添加新的字段。
    reserved "foo", "bar";                      
  
    // 枚举类型
    enum Gender {           
        // 开启别名alias 选项:允许为不同的枚举值赋予相同的标识符                       
        option allow_alias = true;              
        
        // 枚举类型的第一个选项标识符必须是0,也是枚举类型默认值
        FEMALE = 0;                                     
	    MALE = 1;

        // 开启别名选项后
	    OTHER = 1;                                      
    }
    Gender gender = 2;
  
    // 嵌套另一个message作为消息类型,这里会生成 Results []*Student_Result 类似这样的切片
    repeated Result results = 1;               
  
    // 也支持直接嵌套写message
    message Result {                                 
        string url = 1;
        string title = 2;
        repeated string snippets = 3;
    }
  
	message ErrorStatus {
	    string message = 1;
        // 标识details字段可以属于任何类型(可以是string int等),生成类似 []*anypb.Any 这样的切片,记得要在前面import "google/protobuf/any.proto"
	    repeated google.protobuf.Any details = 2;      
	}
	
	//todo 确保在消息的实例中,只有 oneof 定义的字段中的一个字段被赋值。这是一种类型安全的方式来表示一个字段是多个可能类型的其中之一,而不是多个字段可以同时被赋值。
	//在你提供的 protobuf 程序中,SampleMessage 消息定义了一个名为 test_oneof 的 oneof。这意味着在任何给定的 SampleMessage 实例中,只有 name 字段或 sub_message 字段可以被设置,而不能同时设置两者。
	oneof test_oneof {
		string name = 4;
		SubMessage sub_message = 9;
	}

    //如果消息类型是用来远程通信的(Remote Procedure Call, RPC),可以在 .proto 文件中定义 RPC 服务接口。
    //例如我们定义了一个名为 SearchService 的 RPC 服务,提供了 Search 接口,入参是 SearchRequest 类型,返回类型是 SearchResponse
    service SearchService {
        rpc Search (SearchRequest) returns (SearchResponse);
    }
}

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

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/1591317.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

【优选算法专栏】专题十:哈希表(一)

本专栏内容为&#xff1a;算法学习专栏&#xff0c;分为优选算法专栏&#xff0c;贪心算法专栏&#xff0c;动态规划专栏以及递归&#xff0c;搜索与回溯算法专栏四部分。 通过本专栏的深入学习&#xff0c;你可以了解并掌握算法。 &#x1f493;博主csdn个人主页&#xff1a;小…

【springboot开发】MVC和SSM

前言&#xff1a;关于MVC和SSM基本内容的梳理&#xff0c;以及两者之间的关系。 文章目录 1. 三层架构2. MVC3. SSM 1. 三层架构 三层架构是指&#xff1a; 视图层view&#xff08;表现层&#xff09;: 用于显示数据和接收用户输入的数据&#xff0c;为用户提供一种交互式操作…

cpufreq --- 漏洞

我在12日早上发现并上传该漏洞到mainlist&#xff0c; 被毫无道德底线和丑恶人性的印度人截胡了. 这个贪婪、自私的印度人看了我的patch后首先说了一封冠冕堂皇的邮件给我让我不要再次修复&#xff0c;下午2点&#xff0c;人性的丑恶在这厮身上全部散发出来了&#xff0c;它用另…

Unity中图片和Base64字符串之间的转换

大家好&#xff0c;我是阿赵。   这次来讲一下在unity引擎里面&#xff0c;图片和base64字符串的互相转换问题。 一、图片传输的多种方式 有时候我们需要把图片通过网络传输发送。   在Unity里面&#xff0c;有不止一种方式可以实现&#xff0c;比如说&#xff0c;把图片的…

HarmonyOS4 页面路由

Index.ets: import router from ohos.routerclass RouterInfo {// 页面路径url: string// 页面标题title: stringconstructor(url: string, title: string) {this.url urlthis.title title} }Entry // 入口組件 Component struct Index {State message: string 页面列表// …

java快速幂算法

快速幂算法 参考视频(参考五角七边up大佬&#xff09; 幂运算的介绍 幂运算是指将一个数自身乘以自身多次的运算&#xff0c;其表达式为 a n a^n an&#xff0c;其中 a a a 是底数&#xff0c; n n n 是指数。 快速幂解释 快速幂算法是一种用于快速计算幂运算的算法&…

MySQL的基础操作(二)

目录 一.数据库约束 1.主键约束 (Primary Key) 2.唯一约束 (Unique) 3.外键约束 (Foreign Key): 4.检查约束(Check) 5.默认约束 (Default) 二.聚合查询 1.简单聚合函数 2.GROUP BY子句 3.HAVING子句 三.联合查询 1.内连接 2.左连接 3.右连接 4.子查询 5.合并查询…

OpenHarmony开发——CMake方式组织编译的库移植

概述 本文为OpenHarmony开发者提供一些组织编译形式比较常见&#xff08;CMakeLists、Makefile&#xff09;的三方库的移植指南&#xff0c;该指南当前仅适用于Hi3516DV300和Hi3518EV300两个平台&#xff0c;文中着重介绍各编译组织方式下工具链的设置方法以及如何将该库的编译…

NJU PA0

NJU PA0 使用教程提供的源再进行sudo apt install … 可能会出现 Unmet dependencies 此类报错 可以安装 aptitude sudo apt install aptitude sudo aptitude install <package>然后它会提示你&#xff0c;选 n 进行降级。再选 Y 确认 或者 将 /etc/apt/sources.list 下…

SpringSecurity登录时在哪里调用我们自定义的UserDetailsServiceImpl

SpringSecurity登录时在哪里调用我们自定义的UserDetailsServiceImpl 1、请求login方法 2、将用户的用户名和密码封装成一个对象&#xff0c;以便进行后续的认证操作 3、执行认证操作 4、调用providermanager类的authenticate 5.进入这一步就开始跟我们自定义实现的UserDet…

带头结点的双向循环链表操作集

分数 50 作者 伍建全 单位 重庆科技大学 本题要求实现一个带头结点的双向循环链表操作集。 函数接口定义&#xff1a; typedef int dataType;typedef struct _node {dataType data;struct _node *prev;//指向前驱的指针struct _node *next;//指向后继的指针 }node;typedef…

Windows安装MongoDB结合内网穿透轻松实现公网访问本地数据库

&#x1f49d;&#x1f49d;&#x1f49d;欢迎来到我的博客&#xff0c;很高兴能够在这里和您见面&#xff01;希望您在这里可以感受到一份轻松愉快的氛围&#xff0c;不仅可以获得有趣的内容和知识&#xff0c;也可以畅所欲言、分享您的想法和见解。 推荐:kwan 的首页,持续学…

PandasAI的应用与实战解析(二):PandasAI使用流程与功能介绍

文章目录 1.使用PandasAI进行开发的流程2.配置文件解析3.支持的数据库类型4.支持的LLMs5.其他 PandasAI这个工具最突出的优点就是通过结合了Pandas和生成式LLMs&#xff0c;极大地为开发人员降低了工作量。 传统的开发调用流程&#xff08;数据分析相关&#xff09;&#xff1a…

秒杀购物商城核心服务 — 商品管理中心(前提设计概要)

秒杀购物商城核心服务 前提介绍商品中心中台支持系统-总体架构设计&#xff1a;商品与产品商品 类目属性类目定义前后台类目后台类目&#xff0c;关注标准化管理类目属性及分类 SKUSPU 属性库建设 前提介绍 在电商系统中&#xff0c;商品模型占据着举足轻重的地位&#xff0c…

AI赋能档案开放审核:实战

关注我们 - 数字罗塞塔计划 - 为进一步推进档案开放审核工作提质增效&#xff0c;结合近几年的业务探索、研究及项目实践&#xff0c;形成了一套较为成熟、高效的AI辅助档案开放审核解决方案&#xff0c;即以“AI人工”的人机协同模式引领档案开放审机制创新&#xff0c;在档…

TyG新文章!与胸痛的高发生率正相关 | NHANES数据库周报(4.10)

NHANES挖掘培训班来啦&#xff0c;就在4.20-21&#xff01; 郑老师团队2024年NHANES公共数据库挖掘培训班&#xff0c;由浅入深&#xff0c;零基础可学&#xff0c;欢迎报名&#xff01; 美国国家健康和营养检查调查&#xff08;NHANES&#xff09;是一项旨在评估美国成人和儿童…

Python通过socket搭建一个web服务器

目录 01、源码 02、运行结果 03、小结 Socket是一种计算机网络通信的一种机制&#xff0c;它允许不同计算机或进程之间通过网络进行数据传输和通信。Socket可以被看作是不同计算机之间的数据传输通道&#xff0c;通过这个通道&#xff0c;计算机之间可以进行双向的数据传输。…

区块链游戏:探索未来的可能性与挑战

区块链游戏是一种将区块链技术应用于游戏领域的创新产品&#xff0c;它为游戏行业带来了全新的模式和可能性。本文将深入探讨区块链游戏的优点、挑战和未来趋势&#xff0c;帮助读者了解这一新兴领域。 一、区块链游戏的优点 1. 公平性&#xff1a;区块链技术保证了游戏中的物…

LeetCode-Java:303、304区域检索(前缀和)

文章目录 题目303、区域和检索&#xff08;数组不可变&#xff09;304、二维区域和检索&#xff08;矩阵不可变&#xff09; 解①303&#xff0c;一维前缀和②304&#xff0c;二维前缀和 算法前缀和一维前缀和二维前缀和 题目 303、区域和检索&#xff08;数组不可变&#xff…

二叉树遍历算法和应用

二叉树是指度为 2 的树。它是一种最简单却又最重要的树&#xff0c;在计算机领域中有这广泛的应用。 二叉树的递归定义如下&#xff1a;二叉树是一棵空树&#xff0c;或者一棵由一个根节点和两棵互不相交的分别称为根节点的左子树和右子树所组成的非空树&#xff0c;左子树和右…