【Protobuf速成指南】Protobuf快速上手

news2024/12/23 14:26:25

文章目录

  • 1.0版本
    • 一、编写.proto文件
      • 1.文件规范:
      • 2.注释方式:
      • 3.指定proto3语法:
      • 4.package申明符
      • 5.定义message
      • 6.编写消息字段
        • ①类型对照表
        • ②唯一编号
    • 二、编译.proto文件
      • 1. 编译指令
      • 2.源码分析
    • 三、序列化和反序列化的使用
    • 四、小结

1.0版本

 本系列文章将通过对通讯录项目的不断完善,带大家由浅入深的学习Protobuf的使用。这是Contacts的第一个版本,在这篇文章中将带大家快速上手Protobuf

一、编写.proto文件

1.文件规范:

  • 创建.proto文件时,文件命名应该使用全小写字母命名,多个字母之间用 _ 连接。例如:lower_snake_case.proto
  • 书写.proto文件代码时,应使用2个空格的缩进

2.注释方式:

使用 // 或者 /**/ 进行注释

3.指定proto3语法:

在文件首行中指定该proto文件所采用的语法

syntax = "proto3";

🎯[说明]:

​ ProtocolBuffers语言版本3,简称proto3,是.proto文件最新的语法版本。相较于proto2,语法更加简化,使用更加简单

4.package申明符

package xxx;  // 可选

🎯[说明]:

 声明的package在项目中应该具有唯一性,它的作用是避免我们定义的消息发生冲突。它就类似于C++的命名空间,实际上进过编译器编译后就会变成相同名字的 命名空间

5.定义message

 消息(message)就是要定义的结构化对象,我们可以给这个结构化对象中定义其对应的消息字段。message经编译器编译后转变成对应的类(C++)

// message 格式
message MessageName{   

}
// 消息类型命名规范:使用驼峰命名法,首字母大写

6.编写消息字段

消息字段的格式定义为:类型 字段名 = 唯一编号

• 字段名称命名规范:全小写字母,多个字母之间用 _ 连接。
• 字段类型分为:标量数据类型和特殊类型(包括枚举、其他消息类型等)。
• 字段唯一编号:用来标识字段,一旦开始使用就不能够再改变

①类型对照表

.proto typenoteC++ type
doubledouble
floatfloat
int32使用变长编码[1]。负数的编码效率较低⸺若字段可能为负值,应使用sint32代替。int32
int64使用变长编码[1]。负数的编码效率较低⸺若字段可能为负值,应使用sint64代替。int64
uint32使用变长编码[1]uint32
uint64使用变长编码[1]uint64
sint32使用变长编码[1]。符号整型。负值的编码效率高于常规的int32类型。int32
sint64使用变长编码[1]。符号整型。负值的编码效率高于常规的int64类型。int64
fixed32定长4字节。若值常大于2^28则会比uint32更高效uint32
fixed64定长8字节。若值常大于2^56则会比uint64更高效uint64
sfixed32定长4字节。int32
sfixed64定长8字节。int64
boolbool
string包含UTF-8和ASCII编码的字符串,长度不能超过 2^32string
bytes可包含任意的字节序列但长度不能超过2^32string

[1]变长编码是指:经过protobuf编码后,原本4字节或8字节的数可能会被变为其他字节数,可能会变得更长也可能会变得更短。

②唯一编号

 唯一编号用于唯一的标识每一个字段,在解析和序列化的时候可以准确快速的定位到每个字段的位置和大小。

有两点需要特别说明:

  • 编号的范围为1 ~ 536,870,911(2^29-1),其中19000~19999不可用。因为Protobuf协议的实现过程中对预留了这些编号
  • 范围为1 ~ 15的字段编号需要一个字节进行编码,16~2047内的数字需要两个字节进行编码。
  • 编码后的字节不仅只包含了编号,还包含了字段类型。所以1~15要用来标记出现非常频繁的字段,要为将来有可能添加的、频繁出现的字段预留一些出来

到目前为止,我们通讯录可以写下这样的 contact.proto 文件

// 指定采用 proto3 语法
syntax = "proto3";

// 相当于命名空间
package contacts;

message PeopleInfo{
    string name = 1;    //不是赋值,而是指定唯一编号
    int32 age = 2;
}

二、编译.proto文件

1. 编译指令

protoc [--proto_path=IMPORT_PATH] --cpp_out=DST_DIR  file.proto
  • protoc:编译工具
  • –proto_path:指定 .proto 文件的检索路径,可以多次指定指定。不指定默认在当前文件夹下检索。可以简写为 -I.
  • –cpp_out:指定编译后的文件类型为C++
  • DST_DIR:指定文件的生活生成路径
  • file.proto:指定要编译的 .proto 文件(–proto_path 路径下的)

如果我们在 contact.proto 文件所在路径下,则可以使用下面的指令直接生成

protoc --cpp_out=. contact.proto 

image-20230605163238125

 编译后自动为我们生成了 .cc 和 .h 文件。这也印证了我们前面所说的Protobuf使用特点:ProtoBuf是通过Protoc编辑器编译生成的头文件源文件来使用的

image-20230605163435379

2.源码分析

  • package contacts被转换成了相应的命名空间 namespace contacts

    image-20230606102122352

  • message PeopleInfo 被转换成 class PeopleInfo

    image-20230606102737690

  • protobuf为message中每一个字段都提供了对应的处理方法。例如:image-20230606103048218

    字段获取方法与字段名相同,设置方法则以set_开头

  • 序列化和反序列化方法定义在 class PeopleInfo 继承的基类 MessageLite

    // 部分方法如下
    bool ParseFromString(ConstStringParam data);
    
    bool ParseFromArray(const void* data,int size);
    
    bool ParseFromIstream(std::istream* input);
    
    
    bool SerializeToString(std::string* output) const;
    
    bool SerializeToArray(void* data, int size) const;
    
    bool SerializeToOstream(std::ostream* output) const;
    

    🎯[说明]:

    • Protobuf中所有序列化的结果都是二进制的字节序列形式,不像json会以文本的形式呈现。所以相对于xml和JSON来说,因为被编码成二进制,破解成本增大,ProtoBuf编码是相对安全的
    • 上面的序列化非序列化方法没有本质的区别,只是输入输出的形式不同罢了
    • 关于message完整的API介绍参见官方文档 API

三、序列化和反序列化的使用

#include <iostream>
#include <string>
#include "contact.pb.h"

using namespace std;

int main(){
    string people_str;
    {
        contacts::PeopleInfo people;
        people.set_age(20);
        people.set_name("张三");
        if(!people.SerializeToString(&people_str)){
            cerr << "serialize failied" << endl;
        }
        cout << people_str << endl;
    }

    {
        contacts::PeopleInfo people;
        if(!people.ParseFromString(people_str)){
            cerr << "parse failed" << endl;
        }
        cout << "反序列化的结果为:" << endl;
        cout << "name: " << people.name() << endl;
        cout << "age: " << people.age() << endl;
    }
}   

在编译链接的时候记得带上 -l 选项指定要链接的库

g++ -o main main.cc contact.pb.cc -std=c++11 -lprotobuf

四、小结

  1. 编写 .proto 文件的目的是为了定义结构体对象及其属性内容
  2. 编译 .proto 文件是为了生成一系列代码接口存放在 .cc 和 .h 文件中
  3. 我么的业务代码依赖生成的接口就可以轻松完成成员变量的获取、设置、序列化反序列化等工作,极大的减轻了程序员的负担

image-20230606112413754

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

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

相关文章

TCP连接管理与UDP协议

一、TCP的连接管理 1.TCP包头 2.连接的建立——“三次握手” TCP 建立连接的过程叫做握手。 采用三报文握手&#xff1a;在客户和服务器之间交换三个 TCP 报文段&#xff0c;以防止已失效的连接请求报文段突然又传送到了&#xff0c;因而产生 TCP 连接建立错误。 3.连接的释放…

【智能座舱】— 看上海车展,高端品牌变局,时代变天早开始,40项智能化创新技术解密~

大家好,欢迎阅读本期文章,我们将带您解读一份极具实用价值的汽车研究报告。本期将聚焦于2023年上海车展,解密未来座舱发展技术脉络 在本期文章中,我们将深度探讨这些前沿技术的应用,为您呈现未来汽车的全景图。我们相信,这将有助于您更加准确地选择适合自己的新能源汽车…

Kafka测试实战:从基础入门到高阶技巧(建议收藏)

Kafka是一种高吞吐量的分布式发布-订阅消息系统&#xff0c;它可以处理所有活动流数据。在进行Kafka的测试时&#xff0c;我们需要验证生产者能否成功发送消息&#xff0c;消费者能否成功消费消息。在本文中&#xff0c;我们将使用Python来进行Kafka的测试&#xff0c;并提供从…

pytorch实战 -- 数据加载和处理

Pytorch提供了许多工具来简化和希望数据加载&#xff0c;使代码更具可读性。这里将专门讲述transforms数据预处理方法&#xff0c;即数据增强。 数据增强又称为数据增广、数据扩增&#xff0c;它是对训练集进行变换&#xff0c;使训练集更丰富&#xff0c;从而让模型更具泛化能…

POWERBUILDER中高级学习提纲

Chengg0769 2012年 版权来自于&#xff1a; www.mis2erp.com http://blog.csdn.net/chengg0769 http://www.haojiaocheng.cc 转载请保留以上信息 这个提纲的来由&#xff1a; 当时&#xff0c;有个朋友说因伤疗养&#xff0c;想从过去做维护变为做开发&#xff0c;想学习…

从裸机启动开始运行一个C++程序(四)

先序文章请看 从裸机启动开始运行一个C程序&#xff08;三&#xff09; 从裸机启动开始运行一个C程序&#xff08;二&#xff09; 从裸机启动开始运行一个C程序&#xff08;一&#xff09; 跳转 前面我们介绍过&#xff0c;8086CPU总是在执行CS:IP所对应的内存位置的指令&…

签章那些事 -- 让你全面了解签章的流程

前言 随着通信、互联网技术的发展&#xff0c;人们接触到的信息纷繁复杂&#xff0c;信息的真真假假让人难以辨认。在严肃性场合&#xff0c;比如电子合同、电子证照等&#xff0c;必须有一种手段确保信息的完整性和真实性&#xff0c;这时签章就派上了用场。 签章的技术原理并…

高频面试八股文用法篇(四) 乐观锁和悲观锁的例子

目录 什么是乐观锁和悲观锁 乐观锁的实现方式主要有两种&#xff1a;CAS机制和版本号机制 1&#xff09;CAS&#xff08;Compare And Swap&#xff09; (2)版本号 乐观锁适用场景 乐观锁和悲观锁优缺点 功能限制 竞争激烈程度 什么是乐观锁和悲观锁 乐观锁&#xff1…

录音软件哪个好用?录音软件免费下载安装

案例&#xff1a;有没有好用的录音软件推荐&#xff1f; 【我想录制电脑上的音乐和音频会议&#xff0c;也想用电脑录制自己的歌声&#xff0c;有没有好用的电脑录音软件推荐&#xff1f;】 在日常生活和工作中&#xff0c;我们经常会遇到需要录音的场景&#xff0c;比如会议…

几行代码,轻松教你用Java 将 Word 文档转换为 HTML

Aspose.Words 是一种高级Word文档处理API&#xff0c;用于执行各种文档管理和操作任务。API支持生成&#xff0c;修改&#xff0c;转换&#xff0c;呈现和打印文档&#xff0c;而无需在跨平台应用程序中直接使用Microsoft Word。此外&#xff0c; Aspose API支持流行文件格式处…

基于windows环境利用VS下通过Linux环境下服务器进行UDP通信交流

目录 前言 Linux udpServer.cc udpServer.hpp makefile windows 细节1 -- 头文件引入 细节2 -- 固定写法 细节3 -- 结束后清理 细节4 -- socket返回值接受 细节5 -- 套接字创建(一样的写法) 细节6 -- 填写sockaddr_in结构体 细节7 -- 接发收数据 细节8 -- 报错信…

自学黑客(网络安全),一般人我还是劝你算了

一、自学网络安全学习的误区和陷阱 1.不要试图先成为一名程序员【以编程为基础的学习】再开始学习 我在之前的回答中&#xff0c;我都一再强调不要以编程为基础再开始学习网络安全&#xff0c;一般来说&#xff0c;学习编程不但学习周期长&#xff0c;而且实际向安全过渡后可…

操作系统复习2.2.4-作业/进程调度算法

算法 FCFS先来先服务、SJF短作业优先、HRRN高响应比优先、时间片轮转、优先级调度、多级反馈队列调度 FCFS先来先服务 公平&#xff0c;按照到达先后顺序进行服务 用于作业时&#xff0c;考虑哪个作业先到达后备队列 用于进程时&#xff0c;考虑哪个进程先到达就绪队列 非抢…

引领科技潮流:国产化操作系统和CPU的市场竞争力

随着国家科技实力的不断提升&#xff0c;国产化已经成为了中国科技发展的一大趋势。在多个领域&#xff0c;中国企业正在加快国产替代进程&#xff0c;取得了一定的成果。 2、国产化现状 2.1、操作系统 中国国产操作系统包括以下几种&#xff1a; 麒麟操作系统(Kylin OS):由…

2023 某行业-CTF

文章目录 miscmisc1misc2misc3misc4 WebWeb1Web2Web3Web5 misc misc1 %26%2365%3B%26%2376%3B%26%2390%3B%26%23107%3B%26%23121%3B%26%2389%3B%26%2377%3B%26%2366%3B%26%2390%3B%26%2351%3B%26%2355%3B%26%23120%3B%26%23102%3B%26%23119%3B%26%2369%3B%26%2371%3B%26%2310…

Python从入门到精通_Day_1_Python的学习路线整理

写在最前&#xff1a; 为什么开这个专栏&#xff1a; 之前我做过一个专栏&#xff0c;专门介绍Python爬虫技术&#xff0c;这一专栏收获了很多朋友们的点赞收藏和关注。但是在爬虫技术专栏中&#xff0c;对于Python语言本身的讲解并不是很细致&#xff0c;由于Python在爬虫、数…

【Unity XCharts - 01】XCharts图表库简介

XCharts 图表库简介 1.概述2.官方资源简介2.1 官网介绍2.2 本体源码资源2.3 Unity .unitypackage 资源包2.4 Demo代码资源 ❤️ 打不开地址、下载慢的话童鞋可以在我的资源中下载 3.6.0 版本相关的资源。❤️ → 开源Unity图表库&#xff1a;XCharts 3.6.0 ← 1.概述 XCharts …

windows物理机如何迁移到VMware集群里简单教程

前言 快速将本地和远程物理机转换为虚拟机&#xff0c;而无需停机。同时转换可实现大规模虚拟化实施。提供对源物理机。 VMware和Microsoft 虚拟机格式以及某些第三方磁盘映像格式的广泛支持。 它可以自动从物理机&#xff08;运行Windows和Linux&#xff09;和从其他虚拟机格…

语音转文字怎么转?教你三个转换的方法

录音转文字电脑软件哪个好&#xff1f;分享三款好用的录音转文字工具 一分钟告诉你录音转文字电脑软件哪个好 录音转文字电脑软件哪个好&#xff1f;这几款把语音转成文字的软件推荐给你 如何语音转文字&#xff1f;三款好用语音转文字的软件推荐 语音转文字怎么转&#xf…