ProtoBuf详解(二)编码风格

最新推荐文章于 2023-11-17 01:01:15 发布
原创 最新推荐文章于 2023-11-17 01:01:15 发布 · 910 阅读 · 1 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#后端开发

本文详细介绍了Google推荐的Protocol Buffers（protobuf）编码风格，包括文件格式、结构、包名、消息和字段命名、枚举以及服务定义等。遵循这些规范可以提升代码的可读性和维护性。建议参考官方ProtobufStyleGuide以获取最新的编码标准。

本片文章主要介绍 protobuf 的编码风格，这些都是 google 官方推荐的 proto 文件编码风格，遵循这些风格编写 proto 风格，可以使团队的 ProtoBuf 消息定义和风格保持一致，有利于阅读和维护。

protobuf 的风格可能会随着不同版本变化，有可能会看到 .proto 文件以不同的风格编写，但是最好采用当前的最佳风格，请参考官方 Protobuf Style Guide。

文件的标准格式

  1. 每行的长度保持在 80 个字符以内。
  2. 使用 2 个空格缩进。（注：这里实际使用 4 个空格比较多）
  3. 对字符串使用双引号。

文件的结构

文件的命名格式为：lower_snake_case.proto。也就是每个单词都小写，并用下划线连接单词。

所有的 proto 文件应该以以下方式排序：

  1. License header（如果允许）
  2. File overview
  3. Syntax
  4. Package
  5. Imports (有序)
  6. File options
  7. Everything else

包名

包名应使用小写字母，并应与目录层次对应。例如，一个文件在 my/package/ 中，那么包名就应该为 my.package。

消息和字段名

消息名称采用 CamelCase 命名规范，也就是大驼峰命名法，首字母有大写，例如 SongServerRequest。

对于字段名，需要采用小写单词和下划线连接的命名方式，例如 s

最低0.47元/天 解锁文章
Protobuf语言指南——.proto文件语法详解
啊渊的专栏
08-01 6054
Protobuf语言指南 Protobuf语言指南Protobuf语言指南定义一个消息类型标量数值类型Optional的字段和默认值枚举嵌套类型扩展嵌套的扩展包（Package）选项（Options）生成访问类 本指南描述了怎样使用protocolbuffer语言来构造你的protocol buffer数据，包括.proto文件语法以及怎样生成.proto文件的数据访问类。 本文是一个参考指南——如果要查看如何使用本文中描述的多个特性的循序渐进的例子，请在http://code.google.com/int
《游戏系统设计十三》搞清楚游戏通信协议之protobuf的方方面面
我是香菜
09-30 3523
[自己做个游戏服务器]搞清楚游戏通信协议之protobuf的方方面面
protobuf底层编码格式一览
博客
11-27 1216
protobuf底层编码格式 首先要认识protobuf支持的几种编码方式和它们对应的数据类型： wire-type meaning used for 0 varint int32, int64, uint32, uint64, sint32, sint64, bool, enum 1 64-bit fixed64, sfixed64, double 2 length-delimited string, bytes, embedded messages, packed repeate
protobuf语法风格
青萍之末的博客
04-22 1809
文章目录一、代码风格二、文件格式三、包四、消息类型和字段五、repeated字段六、枚举类型七、服务 一、代码风格 每一行的代码长度不要超过80。 使用两个空格进行缩进。 二、文件格式   文件命名应该采用蛇形命名法（即用下划线连接），如：lower_snake_case.proto。所有文件应以下列方式排列： License header (if applicable) File ...
Protobuf3--代码风格指南
weixin_38558469的博客
05-19 751
文章目录标准文件格式文件结构包消息和文件名 标准文件格式        1. 每行长度不超过80个字符。        2. 使用2个空格缩进。 文件结构        文件的命名格式：lower_snake_case.proto 　　文件的内容应该按照如下顺序进行排列： 　　 ...
Protobuf
weixin_60208935的博客
10-06 2638
本专栏RPC项目使用数据压缩编码方式为Protobuf。Protocol buffers 是一种语言中立，平台无关，可扩展的序列化数据的格式，可用于通信协议，数据存储等。Protocol buffers 在序列化数据方面，它是灵活的，高效的。相比于XML 来说，Protocol buffers 更加小巧，更加快速，更加简单。一旦定义了要处理的数据的数据结构之后，就可以利用 Protocol buffers 的代码生成工具生成相关的代码。甚至可以在无需重新部署程序的情况下更新数据结构。
python处理Protoc Buffers协议下的header+protobuf
fly9006的博客
01-09 1811
项目中碰到了tcp透传下用protocol buffer协议的数据传输场景 记录下踩的坑~~ 协议的定义大致举例如下： 数据传输协议组成部分分为header结构体和一个传输数据message体 header如下，其中某个param是需要截取的message包体长度（如这里是param_3） struct header { unsigned short param_1; // 头信息定义
【Netty基础】protobuf详解
白夜行
06-16 2222
前言我在上篇博文中简单介绍了一下protobuf，由于protobuf是Netty默认的序列化协议，再说它的性能也很高，接下来就详细的说一下protobuf协议！引入Netty为什么要提供编解码框架作为一个高性能的异步、NIO通信框架，编解码框架是Netty的重要组成部分。Netty逻辑架构图 从网络读取的inbound消息，需要经过解码，将二进制的数据报转换成应用层协议消息或者业务消息，才能够被上
Swift Protobuf插件与运行时库详解
它不仅提供了一个命令行工具插件，用于扩展 Google 的 protoc 编译器以支持 Swift 代码生成，还包含一个功能完整的运行时库，使得在 Swift 应用程序中能够高效、安全地处理 protobuf 消息的编码与解码操作。...
protobuf 设置
qujianjiutian的专栏
11-25 1320
①文件名:message.proto(required属性没有用,建议少用) option java_package = "org.test"; //包名 option java_outer_classname = "MessagePB";//生成java文件名 message Message {      optional Header header = 1;//头对象
google protobuf 源码
10-28
Protocol Buffers What is it? Protocol Buffers are a way of encoding structured data in an efficient yet extensible format. Google uses Protocol Buffers for almost all of its internal RPC protocols and file formats. Latest Updates http://protobuf.googlecode.com/svn/trunk/CHANGES.txt Documentation Read the documentation. Discussion Visit the discussion group. Quick Example You write a .proto file like this: message Person { required int32 id = 1; required string name = 2; optional string email = 3; } Then you compile it with protoc, the protocol buffer compiler, to produce code in C++, Java, or Python. Then, if you are using C++, you use that code like this: Person person; person.set_id(123); person.set_name("Bob"); person.set_email("bob@example.com"); fstream out("person.pb", ios::out | ios::binary | ios::trunc); person.SerializeToOstream(&out); out.close(); Or like this: Person person; fstream in("person.pb", ios::in | ios::binary); if (!person.ParseFromIstream(&in)) { cerr << "Failed to parse person.pb." << endl; exit(1); } cout << "ID: " << person.id() << endl; cout << "name: " << person.name() << endl; if (person.has_email()) { cout << "e-mail: " << person.email() << endl; } For a more complete example, see the tutorials. v2.3.0 http://code.google.com/p/protobuf/ sample command: protoc.exe -I=.\ --cpp_out=.\ unittest.proto
protobuf RPC实现
u010066807的博客
03-27 3294
Server 结构结构参照hadoop RPC结构，自己造轮子 传输的数据结构1,abstract class Server 接收并且响应客户端请求，把请求数据封装成Call 交给之类实现 2,客户端首次连接必须发送头”HEADER”+version+ServiceClass(Server 实现的之类)+auth *|——–4byte——-|———-3byte—————–| *|————
protobuf简介
m0_65931372的博客
03-14 3613
介绍protobuf之前，先说明一下自定义序列化协议的几个问题。 首先解释一下为什么需要序列化协议而不直接使用类，因为对象中可能有可变字段。 包的分界 为了能让对端知道如何给包分界，意思是，如何区分一帧消息，⽬前⼀般有以下做法： 1. 以固定⼤⼩字节数⽬来分界 例如每个包100个字节，对端每收⻬100个字节，就当成⼀个包来解析。这种方法不灵活，现在基本没有在用了。 2. 以特定符号来分界 例如每个包都以特定的字符来结尾（如\r\n），当在字节流中读取到该字符时，则表明上⼀个包到此为⽌。这种方法总体应用得较少
ProtoBuf使用说明
u010989191的博客
01-05 1232
一、Protobuf简介 protobuf(Google Protocol Buffers)是Google提供一个具有高效的协议数据交换格式工具库(类似Json)，但相比于Json，Protobuf有更高的转化效率，时间效率和空间效率都是JSON的3-5倍。参考GitHub 二、安装Protobuf环境 windows环境下载protoc-2.5.0-win32.zip，下载后解压将protoc.exe拷贝至C:\Windows\System32目录下即可使用。 linux环境下在protobuf-2.5
ProtoBuf Style Guide(中文版)
玻璃汽水的博客
07-10 676
此文档为.proto文件提供了样式指南。通过遵循这些约定，您将使您的协议缓冲区消息定义及其相应的类一致且易于阅读。 请注意，协议缓冲区样式是随着时间的推移而发展的，因此您可能会看到用不同约定或样式编写的.proto文件。修改这些文件时，Please respect the existing style。Consistency is key.。但是，在创建新的.proto文件时，最好采用当前最好的样...
Google Protobuf oneof使用
热门推荐
qq_23413535的博客
10-12 2万+
一、编写proto协议 当我们某一个字段可能出现多种不同类型，但是一次只想出现一次，那么就可以使用oneof。对于网络传输中的一个响应，可能出现不同的结构。例如，response可能是文章列表（包含标题，正文，作者，日期等字段）、也有可能是一首歌（歌曲的byte，标题，作者信息等）。我们可以设计如下proto，使用protoc --cpp_out=. response.proto生成c++源代码，接下来写测试代码。 // response.proto syntax="proto3"; messag
Google Protocol Buffer
rongrong0206的专栏
12-06 1350
什么是 Google Protocol Buffer？ 假如您在网上搜索，应该会得到类似这样的文字介绍：Google Protocol Buffer( 简称 Protobuf) 是 Google 公司内部的混合语言数据标准，目前已经正在使用的有超过 48,162 种报文格式定义和超过 12,183 个 .proto 文件。他们用于 RPC 系统和持续数据存储系统。Protocol Buffers 是一种轻便高效的结构化数据存储格式，可以用于结构化数据串行化，或者说序列化。它很适合做数据存储或 RPC 数据交
03 学习protobuf编码
chen.cce的博客
11-17 297
2///**/标准的proto文件就像这份示例文件一样可以分为三部分， 第一部分是前三行，这部分是proto文件的声明区，其中第一行标明当前proto文件的语法是proto3(没有特别说明，本文所介绍的语法都是proto3)，第二行表示该文件的包名为user，这样会方便别的文件引入这个文件的定义，第三行表示导入文件，接下来在这个文件都可以使用文件定义的东西。第二部分是5-8行， 这部分是消息体区， 这里定义了一个名为的消息体，这个消息体中定义了一个名为uid的字段，且它的类型是string，字段排序是1。
基于python的protobuf通信（添加消息头）
qq_27413937的博客
08-03 3321
最近基于Python做一个客户端，本身自己对Python不太熟悉，而且服务器是使用protobuf协议进行通信，之前主要是使用xml协议做通信，对protobuf也不了解，当然protobuf与xml类似，都有树形结构，而且貌似效率高些。对protobuf的Python使用有很多教程，其实主要来源于对官方文档的翻译，下面放出链接： https://developers.google.com/pr...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

code_peak

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值