【c++】14.编译proto和proto相关用法

2024-06-16 21:38
文章标签 c++ 编译 proto 用法 相关 14

本文主要是介绍【c++】14.编译proto和proto相关用法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

编译proto和proto相关用法

关于proto相关的知识可以参考系列博客 https://blog.csdn.net/daaikuaichuan/category_9869251.html

【xx.proto文件中如果要注释的话,注释符号也是双斜杠"//"】

1.编译proto的问题

重装protoc可参考 https://blog.csdn.net/u013498583/article/details/74231058

查看当前protoc版本: protoc --version

查看protoc安装位置:which protoc

查找protoc相关文件:sudo find / -name protoc

编译proto文件
protoc caffe.proto --cpp_out=./ 生成caffe.pb.h、caffe.pb.cc文件
protoc caffe.proto --python_out=./ 生成caffe_pb2.py文件
假如环境中装了一个以上的protoc版本,可使用protoc双击tab键,会弹出所有版本(protoc protoc_2.6.1,其中protoc是默认版本,protoc --version是查看当前默认protoc版本)。
如果我们要使用非默认版本protoc编译proto,可以protoc_2.6.1 caffe.proto --cpp_out=./这种方式编译。
在编译MobileNet-YOLO工程时,使用protoc protoc_2.6.1编译后的 caffe.pb.hcaffe.pb.cc 文件粘贴到 caffe\include\caffe\proto即可。

----------------------------------------------------------------------------------------

2.proto相关函数用法

如果有一个proto_name结构的 proto消息:

2.1 set_xx(value)、 add_xx()、 mutable_xxx()

proto_name.set_xx(value) 该函数给对应的变量赋值

proto_name.add_xx() 该函数给对应的repeated变量增加一个xx类型的元素,返回值为指针类型。一般用法为:在for循环中调用一次,proto消息就添加一个该类型数据。

proto_name.mutable_xxx() 该函数返回指向该字段的一个指针,同时将该字段置为被设置状态。若该对象存在,则直接返回该对象,若不存在则新new 一个。

----------------------------------------------------------------------------------------
2.2 SerializeToString、ParseFromString、SerializeToArray、ParseFromArray、CopyFrom、IsInitialized、

例如,有 proto_name.proto文件,把这个 proto_name.proto文件编译后,会产生 proto_name.pb.hproto_name.pb.cc, 生成的.h文件中的class都继承自::google::protobuf::Message类,Message类提供了一些方法可以检查或者操作整个message,包括:

bool IsInitialized() const; 检查是否所有required变量都已经初始化;

string DebugString() const; 返回message的可阅读的表示,主要用于调试程序;

void CopyFrom(const Person& from); 使用一个message的值覆盖本message;

void Clear(); 清空message的所有成员变量值。

----------------------------------------------------------------------------------------

每个message类都提供了写入和读取message数据的方法,包括

bool SerializeToString(string* output) const; // 把message编码进output。

bool ParseFromString(const string& data); // 从string解码到message

bool SerializeToArray(char* buf,int size) const; // 把message编码进数组buf.

bool ParseFromArray(const char* buf,int size); // 把 buf解码到message。此解码方法效率较ParseFromString高很多,所以一般用这种方法解码。

bool SerializeToOstream(ostream* output) const; // 把message编码进ostream

bool ParseFromIstream(istream* input); // 从istream解码到message

备注:发送接收端所使用的加码解码方法不一定非得配对,即发送端用SerializeToString 接收端不一定非得用ParseFromString ,可以使用其他解码方法。

----------------------------------------------------------------------------------------
一般使用 bool SerializeToString(string* output) const;bool SerializeToArray(char* buf,int size) const;

例如当需要使用tcp/udp发送包含数组的时候,建议使用 bool SerializeToArray(char* buf,int size) const;,因为涉及到 数据包头、校验位之类的需要使用数组索引的方式,这样最好使用SerializeToArray

#define _fill_pack(name)                                                    \{                                                                         \char tbuf[256 * 1024];                                                  \uint32_t len = name.ByteSize();                                         \auto header = name.header();                                            \_fill_pack_head(static_cast<uint32_t>(netproxy_##name##_pack), len,     \reinterpret_cast<netproxy_pack_t *>(tbuf));             \if (!name.SerializeToArray(&tbuf[sizeof(netproxy_pack_t)], len)) {      \SERROR << "serialize error, name:" << #name << " len:" << len;        \len = -sizeof(netproxy_pack_t);                                       \}                                                                       \Send_data(tbuf, len + sizeof(netproxy_pack_t), netproxy_##name##_pack); \}

其他时候可以直接使用SerializeToString

----------------------------------------------------------------------------------------
用法1:对外接口的消息结构的兼容性

当某个对外接口的消息结构 msgA 中的某个变量的结构总是要根据需求而频繁增删修改的时候,一般会在这个消息结构 msgA 中定义一个std::string proto_data的变量,
这样只需要修改proto_name.proto文件中的内容,而不需要总是修改 msgA(尤其是当修改msgA可能需要修改框架协议的时候,总之就是代价比较大),使用proto方法来解决这个问题就特别方便。

原始结构:

struct msgA{MsgHeader header;bool is_ok;structBBB msgbbb;  //当这个结构体 structBBB 增删修改结构比较麻烦时,会造成频繁修改对外接口 msgA 的麻烦。
}
方法:

先定义一个 proto_name.proto文件,把这个 proto_name.proto文件编译后,会产生 proto_name.pb.hproto_name.pb.cc,
对其中定义的变量赋值是使用 set_xxx(111) 函数进行赋值,赋值完成后再序列化之后进行打包发送;
发送之前使用 proto_name.SerializeToString(&data) 把该 结构序列化为string类型,然后再发送。
原始结构 修改为:

struct msgA{MsgHeader header;bool is_ok;//定义一个string类型的结构来代替 structBBB msgbbb; 然后把proto定义的数据结构 proto_name.proto赋值后,//调用 proto_name.SerializeToString(proto_data) 进行序列化转换为string赋值给proto_data变量,这就是使用proto方式来解决。std::string proto_data;   
}

下面的函数,我们封装了proto自带的SerializeToString和ParseFromString方法

// msg转换成string
template <class T>
void MsgToString(const T msg, std::string &data) {msg.SerializeToString(&data);
}
// 将string转换成msg
template <class T>
void StringToMsg(const std::string data, T &msg) {msg.ParseFromString(data);
}
----------------------------------------------------------------------------------------
用法2:

当我们需要使用配置文件来给许多变量进行赋值的时候,就可以把这些变量全都定义在 config.proto中,然后建立一个config.pb.txt文件,在config.pb.txt文件中对config.proto中的变量进行设置。
后续进行一些读取config.pb.txt文件中的内容,然后需要的地方获取这些内容。
代码涉及到文件读取解析proto等等的内容,详解见下:

/**下面这函数是读取配置文件,然后将值赋给message,然后就可以对message以message.mutable_xxx()的形式进行获取数据了**/
/**env_fusion_data_是proto消息,继承于 google::protobuf::Message类**/
pinecone::common::GetProtoFromFile(data_file_name, &message); /**定义见下**/
bool GetProtoFromFile(const std::string &file_name,google::protobuf::Message *message) {// Try the binary parser first if it's much likely a binary proto.static const std::string kBinExt = ".bin";if (std::equal(kBinExt.rbegin(), kBinExt.rend(), file_name.rbegin())) {return GetProtoFromBinaryFile(file_name, message) ||GetProtoFromASCIIFile(file_name, message);}return GetProtoFromASCIIFile(file_name, message) ||GetProtoFromBinaryFile(file_name, message);
}
上面这个函数调用下面这两个函数:
函数1: 读取二进制文件,调用了proto定义的内置函数 bool ParseFromIstream(istream* input)
bool GetProtoFromBinaryFile(const std::string &file_name,google::protobuf::Message *message) {std::fstream input(file_name, std::ios::in | std::ios::binary);if (!input.good()) {SERROR << "Failed to open file " << file_name << " in binary mode.";return false;}if (!message->ParseFromIstream(&input)) {SERROR << "Failed to parse file " << file_name << " as binary proto.";return false;}return true;
}
函数2: 读取ASCII文件,调用了open(),close()和proto内置函数static bool Parse(io::ZeroCopyInputStream* input, Message* output);
bool GetProtoFromASCIIFile(const std::string &file_name,google::protobuf::Message *message) {using google::protobuf::TextFormat;using google::protobuf::io::FileInputStream;using google::protobuf::io::ZeroCopyInputStream;int file_descriptor = open(file_name.c_str(), O_RDONLY);if (file_descriptor < 0) {SERROR << "Failed to open file " << file_name << " in text mode.";// Failed to open;return false;}ZeroCopyInputStream *input = new FileInputStream(file_descriptor);bool success = TextFormat::Parse(input, message);if (!success) {SERROR << "Failed to parse file " << file_name << " as text proto.";}delete input;close(file_descriptor);return success;
}

这篇关于【c++】14.编译proto和proto相关用法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1067621

相关文章

C++中unordered_set哈希集合的实现

《C++中unordered_set哈希集合的实现》std::unordered_set是C++标准库中的无序关联容器,基于哈希表实现,具有元素唯一性和无序性特点,本文就来详细的介绍一下unorder... 目录一、概述二、头文件与命名空间三、常用方法与示例1. 构造与析构2. 迭代器与遍历3. 容量相关4

C++中悬垂引用(Dangling Reference) 的实现

《C++中悬垂引用(DanglingReference)的实现》C++中的悬垂引用指引用绑定的对象被销毁后引用仍存在的情况,会导致访问无效内存,下面就来详细的介绍一下产生的原因以及如何避免,感兴趣... 目录悬垂引用的产生原因1. 引用绑定到局部变量,变量超出作用域后销毁2. 引用绑定到动态分配的对象,对象

JDK21对虚拟线程的几种用法实践指南

《JDK21对虚拟线程的几种用法实践指南》虚拟线程是Java中的一种轻量级线程,由JVM管理,特别适合于I/O密集型任务,:本文主要介绍JDK21对虚拟线程的几种用法,文中通过代码介绍的非常详细,... 目录一、参考官方文档二、什么是虚拟线程三、几种用法1、Thread.ofVirtual().start(

Java8 Collectors.toMap() 的两种用法

《Java8Collectors.toMap()的两种用法》Collectors.toMap():JDK8中提供,用于将Stream流转换为Map,本文给大家介绍Java8Collector... 目录一、简单介绍用法1:根据某一属性,对对象的实例或属性做映射用法2:根据某一属性,对对象集合进行去重二、Du

Python中isinstance()函数原理解释及详细用法示例

《Python中isinstance()函数原理解释及详细用法示例》isinstance()是Python内置的一个非常有用的函数,用于检查一个对象是否属于指定的类型或类型元组中的某一个类型,它是Py... 目录python中isinstance()函数原理解释及详细用法指南一、isinstance()函数

Python中的sort方法、sorted函数与lambda表达式及用法详解

《Python中的sort方法、sorted函数与lambda表达式及用法详解》文章对比了Python中list.sort()与sorted()函数的区别,指出sort()原地排序返回None,sor... 目录1. sort()方法1.1 sort()方法1.2 基本语法和参数A. reverse参数B.

vue监听属性watch的用法及使用场景详解

《vue监听属性watch的用法及使用场景详解》watch是vue中常用的监听器,它主要用于侦听数据的变化,在数据发生变化的时候执行一些操作,:本文主要介绍vue监听属性watch的用法及使用场景... 目录1. 监听属性 watch2. 常规用法3. 监听对象和route变化4. 使用场景附Watch 的

Java Instrumentation从概念到基本用法详解

《JavaInstrumentation从概念到基本用法详解》JavaInstrumentation是java.lang.instrument包提供的API,允许开发者在类被JVM加载时对其进行修改... 目录一、什么是 Java Instrumentation主要用途二、核心概念1. Java Agent

C++读写word文档(.docx)DuckX库的使用详解

《C++读写word文档(.docx)DuckX库的使用详解》DuckX是C++库,用于创建/编辑.docx文件,支持读取文档、添加段落/片段、编辑表格,解决中文乱码需更改编码方案,进阶功能含文本替换... 目录一、基本用法1. 读取文档3. 添加段落4. 添加片段3. 编辑表格二、进阶用法1. 文本替换2

C++中处理文本数据char与string的终极对比指南

《C++中处理文本数据char与string的终极对比指南》在C++编程中char和string是两种用于处理字符数据的类型,但它们在使用方式和功能上有显著的不同,:本文主要介绍C++中处理文本数... 目录1. 基本定义与本质2. 内存管理3. 操作与功能4. 性能特点5. 使用场景6. 相互转换核心区别