【Unix】FlatBuffers 在 C++ 项目中的使用教程

2024-05-09 04:04

本文主要是介绍【Unix】FlatBuffers 在 C++ 项目中的使用教程,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在 C++ 项目中使用 FlatBuffers 主要涉及以下几个步骤:

1. 安装 FlatBuffers

首先,你需要在你的系统上安装 FlatBuffers 编译器和库。你可以从 FlatBuffers 的 GitHub 仓库 下载源码并编译:

git clone https://github.com/google/flatbuffers.git
cd flatbuffers
cmake -G "Unix Makefiles"
make

完成后,你将获得一个 flatc 编译器,这是用于将 FlatBuffers schema 文件(.fbs 文件)转换为各种支持的语言的源代码的工具。

2. 定义 Schema

创建一个 FlatBuffers schema 文件(扩展名为 .fbs)。这个文件定义了你想要序列化的数据结构。例如:

// example.fbs
namespace MyGame.Sample;table Monster {id:int;name:string;inventory:[ubyte];  // Vector of unsigned bytes
}root_type Monster;

3. 生成 C++ 源代码

使用 flatc 编译器从你的 schema 文件生成 C++ 绑定代码:

flatc -c example.fbs

这会生成一些 C++ 文件,这些文件提供了操作定义的 FlatBuffers 数据结构的 API。

4. 在项目中使用 FlatBuffers

将生成的代码和 FlatBuffers 的包含文件添加到你的 C++ 项目中。你需要包括 FlatBuffers 的库路径和头文件路径在你的编译设置中。

5. 读写 FlatBuffers 数据

写入数据

在 C++ 中构建和序列化 FlatBuffers 数据:

#include "example_generated.h"  // 自动生成的头文件flatbuffers::FlatBufferBuilder builder;auto name = builder.CreateString("Orc");
auto inventory = builder.CreateVector(std::vector<uint8_t>({1, 2, 3, 4}));auto orc = MyGame::Sample::CreateMonster(builder, 123, name, inventory);
builder.Finish(orc);// 获取生成的数据和大小
uint8_t *buf = builder.GetBufferPointer();
int size = builder.GetSize();  // 使用这些数据

代码解读:

  1. 包含生成的头文件
#include "example_generated.h"  // 自动生成的头文件

这行代码包含了由 FlatBuffers 编译器 (flatc) 根据你的 .fbs schema 文件自动生成的 C++ 头文件。这个头文件中定义了与 schema 中定义的数据结构对应的 C++ 类和方法。

  1. 初始化 FlatBufferBuilder
flatbuffers::FlatBufferBuilder builder;

这行代码创建了一个 FlatBufferBuilder 对象,名为 builder。FlatBufferBuilder 是用于构建 FlatBuffer 二进制缓冲区的主要工具。这个对象会管理内存分配,并最终产生一个二进制缓冲区,其中包含序列化的数据。

  1. 创建字符串
auto name = builder.CreateString("Orc");

这行代码使用 builder 对象创建了一个 FlatBuffers 字符串。这里,字符串 “Orc” 被添加到构建中的 FlatBuffers 中,并返回一个指向这个 FlatBuffers 字符串的引用。

  1. 创建向量
auto inventory = builder.CreateVector(std::vector<uint8_t>({1, 2, 3, 4}));

这行代码创建了一个类型为 uint8_t 的向量,并将其内容初始化为 {1, 2, 3, 4}。然后,它使用 builder 将这个向量添加到 FlatBuffer 中,并返回一个指向 FlatBuffers 中向量的引用。

  1. 构建 Monster 对象
auto orc = MyGame::Sample::CreateMonster(builder, 123, name, inventory);

这行代码调用一个由 FlatBuffers 自动生成的函数 CreateMonster,这个函数根据给定的参数构造 Monster 对象。这里传递的参数包括 builder、一个整数 ID (123)、前面创建的 name 字符串引用和 inventory 向量引用。

  1. 完成构建过程
builder.Finish(orc);

这行代码标记 FlatBuffers 构建的完成,这里的 orc 是 Monster 对象在 FlatBuffer 中的引用。调用 Finish 方法后,FlatBuffer 中的数据布局被最终确定,并准备好序列化输出。

  1. 获取缓冲区指针和大小
uint8_t *buf = builder.GetBufferPointer();
int size = builder.GetSize();  // 使用这些数据

这两行代码获取生成的 FlatBuffers 二进制数据的指针和大小。buf 是指向 FlatBuffers 缓冲区起始位置的指针,size 是缓冲区的字节大小。这些信息通常用于将序列化的数据发送到文件、网络或其他存储和通信媒介。

这段代码代码整体的作用就是使用 FlatBuffers 在 C++ 中定义、填充并序列化一个复杂的数据结构。这种序列化的数据可以高效地进行存储或网络传输,并且可以在不需要解析整个结构的情况下直接访问特定字段,这是 FlatBuffers 设计的一大优势。

读取数据

解析 FlatBuffers 数据:

#include "example_generated.h"  // 自动生成的头文件void ReadMonster(const uint8_t *buf) {auto monster = MyGame::Sample::GetMonster(buf);std::cout << "Monster ID: " << monster->id() << std::endl;std::cout << "Monster Name: " << monster->name()->str() << std::endl;auto inv = monster->inventory();if (inv) {std::cout << "Inventory: ";for (auto it = inv->begin(); it != inv->end(); ++it) {std::cout << int(*it) << ' ';}std::cout << std::endl;}
}// 调用
ReadMonster(buf);

6. 链接 FlatBuffers 库

在编译你的项目时,确保链接了 FlatBuffers 库。如果你是在一个典型的 Makefile 或 CMake 项目中工作,你需要添加相应的库路径和链接器标志。

完成这些步骤后,你的 C++ 项目就能够使用 FlatBuffers 进行高效的数据序列化和解析了。

这篇关于【Unix】FlatBuffers 在 C++ 项目中的使用教程的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



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

相关文章

Java Lambda表达式的使用详解

《JavaLambda表达式的使用详解》:本文主要介绍JavaLambda表达式的使用方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、前言二、Lambda表达式概述1. 什么是Lambda表达式?三、Lambda表达式的语法规则1. 无参数的Lambda表

Spring组件实例化扩展点之InstantiationAwareBeanPostProcessor使用场景解析

《Spring组件实例化扩展点之InstantiationAwareBeanPostProcessor使用场景解析》InstantiationAwareBeanPostProcessor是Spring... 目录一、什么是InstantiationAwareBeanPostProcessor?二、核心方法解

详解如何使用Python构建从数据到文档的自动化工作流

《详解如何使用Python构建从数据到文档的自动化工作流》这篇文章将通过真实工作场景拆解,为大家展示如何用Python构建自动化工作流,让工具代替人力完成这些数字苦力活,感兴趣的小伙伴可以跟随小编一起... 目录一、Excel处理:从数据搬运工到智能分析师二、PDF处理:文档工厂的智能生产线三、邮件自动化:

Spring @RequestMapping 注解及使用技巧详解

《Spring@RequestMapping注解及使用技巧详解》@RequestMapping是SpringMVC中定义请求映射规则的核心注解,用于将HTTP请求映射到Controller处理方法... 目录一、核心作用二、关键参数说明三、快捷组合注解四、动态路径参数(@PathVariable)五、匹配请

Java中的登录技术保姆级详细教程

《Java中的登录技术保姆级详细教程》:本文主要介绍Java中登录技术保姆级详细教程的相关资料,在Java中我们可以使用各种技术和框架来实现这些功能,文中通过代码介绍的非常详细,需要的朋友可以参考... 目录1.登录思路2.登录标记1.会话技术2.会话跟踪1.Cookie技术2.Session技术3.令牌技

Java 枚举的基本使用方法及实际使用场景

《Java枚举的基本使用方法及实际使用场景》枚举是Java中一种特殊的类,用于定义一组固定的常量,枚举类型提供了更好的类型安全性和可读性,适用于需要定义一组有限且固定的值的场景,本文给大家介绍Jav... 目录一、什么是枚举?二、枚举的基本使用方法定义枚举三、实际使用场景代替常量状态机四、更多用法1.实现接

springboot项目中使用JOSN解析库的方法

《springboot项目中使用JOSN解析库的方法》JSON,全程是JavaScriptObjectNotation,是一种轻量级的数据交换格式,本文给大家介绍springboot项目中使用JOSN... 目录一、jsON解析简介二、Spring Boot项目中使用JSON解析1、pom.XML文件引入依

Java中的record使用详解

《Java中的record使用详解》record是Java14引入的一种新语法(在Java16中成为正式功能),用于定义不可变的数据类,这篇文章给大家介绍Java中的record相关知识,感兴趣的朋友... 目录1. 什么是 record?2. 基本语法3. record 的核心特性4. 使用场景5. 自定

Python使用Tkinter打造一个完整的桌面应用

《Python使用Tkinter打造一个完整的桌面应用》在Python生态中,Tkinter就像一把瑞士军刀,它没有花哨的特效,却能快速搭建出实用的图形界面,作为Python自带的标准库,无需安装即可... 目录一、界面搭建:像搭积木一样组合控件二、菜单系统:给应用装上“控制中枢”三、事件驱动:让界面“活”

C/C++ chrono简单使用场景示例详解

《C/C++chrono简单使用场景示例详解》:本文主要介绍C/C++chrono简单使用场景示例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友... 目录chrono使用场景举例1 输出格式化字符串chrono使用场景China编程举例1 输出格式化字符串示