尧图网页设计 
FlatBuffers 在 Go 中的使用指南从 flatc 代码生成到读写与原地修改【免费下载链接】flatbuffersFlatBuffers: Memory Efficient Serialization Library项目地址: https://gitcode.com/GitHub_Trending/fl/flatbuffers本文以 FlatBuffers 官方文档中 Go 语言使用章节 为核心骨架面向希望在 Go 项目中接入 FlatBuffers 内存高效序列化的开发者。读完本文你将掌握如何用flatc --go从 schema 生成 Go 代码、如何在 Go 中读取与访问 FlatBuffer 二进制、如何对已有缓冲区的标量字段进行原地in-place修改mutate以及如何运行仓库自带的 Go 测试来验证整个链路。开始之前前置知识与准备工作在深入 FlatBuffers 在 Go 中的用法之前需要注意以下几点通用性的完整教程在 Tutorial 中它覆盖了所有受支持语言包括 Go的 FlatBuffers 通用用法本文专门讨论针对 Go 语言的具体细节与坑点。你应当先阅读 Building 文档完成flatcschema 编译器的构建你应当熟悉 使用 schema 编译器 的命令行选项你应当掌握 编写 schema 的基本语法table、struct、enum、field 默认值等。最小环境要求Go 语言环境本文对应仓库的 Go 测试脚本 tests/GoTest.sh 明确要求本机安装 Go一个可用的flatc可执行文件通过仓库根目录的 CMake 构建产物通常位于flatc或Debug/flatc等路径一份.fbsschema 文件例如仓库测试用的 tests/monster_test.fbs 或示例中的 samples/monster.fbs。FlatBuffers Go 库代码位置Go 语言的运行时库源码位于仓库的go目录go/builder.goBuilder状态机负责从叶子节点开始、以从后往前last-first的方式构建 FlatBuffer 字节缓冲go/table.goTable类型封装字节切片并提供只读访问与原地修改能力go/struct.goStruct类型用于无 vtable 的内联结构体go/lib.goGetRootAs、GetSizePrefixedRootAs、缓冲区标识符file identifier读取与校验等顶层辅助函数go/encode.go小端序编解码原语以及SOffsetTint32、UOffsetTuint32、VOffsetTuint16三类偏移量类型定义其余文件还包括 go/sizes.go各类型字节宽度常量与 go/grpc.gogRPC 辅助。从源码结构看运行时库是自包含的、不依赖任何第三方包仅使用标准库sort、math、strconv、unicode/utf8等因此可以方便地以github.com/google/flatbuffers/go模块路径集成进自己的 Go module或直接 vendor。测试 FlatBuffers Go 库Go 库的测试代码位于tests目录测试主体tests/go_test.go运行脚本tests/GoTest.sh。测试脚本做了什么从 tests/GoTest.sh 的源码看脚本的核心流程为生成测试用 Go 代码调用flatc -g --gen-object-api对monster_test.fbs、optional_scalars.fbs、required_strings.fbs以及include_test目录下的 schema 生成 Go 代码。这里使用了两个关键选项-g/--go生成 Go 语言绑定--gen-object-api额外生成带T后缀的对象 API如MonsterT支持与 JSON 的互转。搭建 GOPATH 布局Go 要求特定的文件布局才能链接多个包脚本把go/目录复制到go_gen/src/github.com/google/flatbuffers/go把go_test.go复制到flatbuffers_test包并以GO111MODULEoff的 GOPATH 模式运行测试脚本结束时会重新go env -w GO111MODULEon恢复模块模式。运行go test执行go test flatbuffers_test并传入若干关键参数--cpp_datatests/monsterdata_test.monC 侧生成的二进制数据用于交叉验证 Go 的读取结果--out_datatests/monsterdata_go_wire.monGo 侧写出数据的落盘路径--bench. --benchtime3s运行基准测试--fuzztrue --fuzz_fields4 --fuzz_objects10000开启模糊测试每个模糊对象含 4 个字段共 10000 个对象。gofmt 检查脚本最后会对目录内文件执行gofmt -l检查格式是否符合 Go 社区规范。如何运行# 先构建 flatc参见 docs/source/building.md确保仓库根目录存在 flatc 可执行文件 # 然后执行需要已安装 Go cd tests ./GoTest.sh脚本输出OK: Go tests passed.表示全部通过KO: Go tests failed.表示存在失败。如需查看更多细节可按脚本注释追加-test.v详细输出标志或用-test.bench.通配运行全部基准测试。测试中的部分关键用例tests/go_test.go还包括TestTextParsing验证对象 APIMonsterT与encoding/json的互转见下节文本解析CheckNoNamespaceImport验证无命名空间 schema如Pizza、order生成代码的打包与往返一致性。使用 FlatBuffers Go 库读取与访问FlatBuffers 在 Go 中同时支持读取read与写入write二进制 FlatBuffer。整体流程为用flatc --go从 schema 生成 Go 类生成的代码放在你指定的输出目录通常需要按包名组织目录结构在你的代码中同时 import 运行时库与生成的代码读取或构造 FlatBuffer 字节并通过生成的GetRootAsXxx函数访问数据。生成 Go 代码flatc --go -o gen monster.fbs--go简写-g启用 Go 代码生成-o dir指定输出目录如需对象 API生成XxxT结构体及Pack/UnPack方法追加--gen-object-api这正是 tests/GoTest.sh 中的用法。读取一个 FlatBuffer 二进制文件以下示例来自原文档演示如何读取一个 FlatBuffer 二进制文件import ( example MyGame/Example flatbuffers github.com/google/flatbuffers/go os ) buf, err : os.ReadFile(monster.dat) // handle err monster : example.GetRootAsMonster(buf, 0)要点说明example.GetRootAsMonster是生成的代码它内部调用运行时库 go/lib.go 中的GetRootAs先从buf[offset:]读出 4 字节的根偏移量n再以noffset初始化对象。因此第二个参数0表示从缓冲区头部开始解析。GetRootAs的泛型实现要求目标类型实现FlatBuffer接口Table() Table与Init(buf []byte, i UOffsetT)见 go/lib.go。如果缓冲区带有 size-prefix例如流式传输场景应改用GetSizePrefixedRootAs读取前缀大小用GetSizePrefix读取/校验 4 字节文件标识符file identifier用GetBufferIdentifier/BufferHasIdentifier及各自的 size-prefixed 版本这些均在 go/lib.go 中提供。访问字段值生成代码为每个字段提供Get风格实际命名为Hp()、Pos()等的访问器hp : monster.Hp() pos : monster.Pos(nil)标量字段访问器内部通过 go/table.go 的Table.Offset(slot)查询 vtable先定位 vtable 位置再与 vtable 长度比对若字段在缓冲区中不存在vtable 偏移为 0GetXxxSlot系列方法会返回 schema 中声明的默认值这正是 FlatBuffers缺失字段零拷贝、零填充特性的体现。嵌套 table / struct 字段如Pos的访问器需要传入一个用于复用的接收对象传nil时内部会新建读取逻辑通过Table.Union之类的偏移跳转完成。底层Table 与偏移量从 go/table.go 可以看到Table结构非常精简type Table struct { Bytes []byte Pos UOffsetT // Always 131. }Pos记录该对象在缓冲区中的根位置Offset(vtableOffset VOffsetT)根据 vtable 返回字段的偏移若字段被废弃或缺失则返回 0VectorLen/Vector/ByteVector/String读取向量与字符串且 ByteVector 对越界、溢出做了防御性检查非法偏移返回nil而非 panicGetXxxSlot(slot, default)系列读取字段并在缺失时返回默认值。偏移量类型定义在 go/encode.gotype ( SOffsetT int32 // signed offset指向任意数据 UOffsetT uint32 // unsigned offset指向向量数据 VOffsetT uint16 // unsigned offset位于 vtable 中 )原地修改Mutation在缓冲区上直接改值在某些场景下需要在不创建副本的情况下就地修改已存在的 FlatBuffer。为此FlatBuffer 的 table 或 struct 的标量字段支持原地修改mutate。原文档给出了完整示例monster : example.GetRootAsMonster(buf, 0) // Set table field. if ok : monster.MutateHp(10); !ok { panic(failed to mutate Hp) } // Set struct field. monster.Pos().MutateZ(4) // This mutation will fail because the mana field is not available in // the buffer. It should be set when creating the buffer. if ok : monster.MutateMana(20); !ok { panic(failed to mutate Hp) }为什么用 mutate 而不是 set这里刻意使用mutate而非set一词以强调这是一个特殊用例FlatBuffer 的设计目标是序列化与传输字段在写入时可以省略利用默认值机制节省空间。如果某个字段在缓冲区中根本不存在写入端未设置就无法在原地修改它。因此所有 mutate 函数都返回布尔值返回false表示目标字段在缓冲区中不可用未写入修改失败。典型场景是上面示例的MutateMana(20)—— 若构建缓冲区时未显式设置mana字段它带有默认值vtable 中不存在该字段的偏移MutateMana会返回false。从生成的 tests/MyGame/Example/Monster.go 可以看到MutateMana与MutateHp正是对运行时库Table.MutateXxxSlot的封装后者先调用Offset(slot)检查字段是否存在于 vtable 中off 0时返回false否则写入新值并返回true实现见 go/table.go。哪些字段可以 mutatetable 的标量字段可以如MutateHp、MutateMana、MutateBool、MutateFloat64等struct 的内联标量字段可以因为 struct 是固定布局、内联存储的如monster.Pos().MutateZ(4)字符串、向量等非标量字段不能原地修改长度可变无法在固定大小的缓冲区中就地调整。运行时库在 go/table.go 中提供了从MutateBool到MutateUOffsetT的全套标量 mutate 原语以及带Slot后缀的 vtable 感知版本如MutateInt32Slot由生成的字段访问器按需调用。底层原理写入走小端编解码MutateXxxSlot最终调用 go/encode.go 中的WriteXxx系列函数它们以小端序将值写回Bytes[off:]。这些写入函数与读取端的GetXxx一一对应例如WriteUint32对 4 字节逐位移位写入WriteFloat32/WriteFloat64通过math.Float32bits/math.Float64bits完成位模式转换。文本解析Text Parsing现状截至当前仓库版本Go 运行时库本身不支持直接解析文本schema 或 JSON。原文档明确指出目前没有从 Go 直接解析文本schema 和 JSON的支持不过你可以通过 cgo 使用 C 的解析器。关于文本解析请参阅 C 文档。这意味着如果需要在 Go 中把 JSON 转成 FlatBuffer 二进制典型做法是在构建阶段用flatc的文本/JSON 工具如flatc -t转 JSON、flatc --json解析 JSON完成转换Go 侧只负责收发二进制或者使用对象 API--gen-object-api生成XxxT结构体配合 Go 标准库encoding/json在Go 结构体层面与 JSON 互通。测试 tests/go_test.go 中的TestTextParsing正是验证了MonsterT与 JSON 的编解码往返json.NewEncoder编码 →json.NewDecoder解码 → 字段比对若要严格做 schema 级别的文本解析可如文档所述借助 cgo 调用 C 解析器但需要自行承担 CGO 的构建与维护成本。小结与延伸阅读本文围绕 Go 语言使用文档 的核心脉络覆盖了Go 库的位置go/ 目录与模块结构测试体系tests/go_test.go 与 tests/GoTest.sh及运行方式从flatc --go生成代码到GetRootAsMonster读取缓冲区的完整流程标量字段的原地修改mutate语义与返回值约定文本解析的现状与替代方案。进一步深入可参考完整教程跨语言通用使用流程编写 schematable / struct / enum / union 语法flatc 命令参考全部代码生成选项可运行的示例samples/go_sample.sh对应 samples/sample_binary.go展示了从 schema 生成到 Go 读写二进制的最小闭环gRPC 集成grpc/examples/go 提供了 Go 侧 gRPC 示例。【免费下载链接】flatbuffersFlatBuffers: Memory Efficient Serialization Library项目地址: https://gitcode.com/GitHub_Trending/fl/flatbuffers创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考 FlatBuffers 在 Go 中的使用指南：从 flatc 代码生成到读写与原地修改
FlatBuffers 在 Go 中的使用指南从 flatc 代码生成到读写与原地修改【免费下载链接】flatbuffersFlatBuffers: Memory Efficient Serialization Library项目地址: https://gitcode.com/GitHub_Trending/fl/flatbuffers本文以 FlatBuffers 官方文档中 Go 语言使用章节 为核心骨架面向希望在 Go 项目中接入 FlatBuffers 内存高效序列化的开发者。读完本文你将掌握如何用flatc --go从 schema 生成 Go 代码、如何在 Go 中读取与访问 FlatBuffer 二进制、如何对已有缓冲区的标量字段进行原地in-place修改mutate以及如何运行仓库自带的 Go 测试来验证整个链路。开始之前前置知识与准备工作在深入 FlatBuffers 在 Go 中的用法之前需要注意以下几点通用性的完整教程在 Tutorial 中它覆盖了所有受支持语言包括 Go的 FlatBuffers 通用用法本文专门讨论针对 Go 语言的具体细节与坑点。你应当先阅读 Building 文档完成flatcschema 编译器的构建你应当熟悉 使用 schema 编译器 的命令行选项你应当掌握 编写 schema 的基本语法table、struct、enum、field 默认值等。最小环境要求Go 语言环境本文对应仓库的 Go 测试脚本 tests/GoTest.sh 明确要求本机安装 Go一个可用的flatc可执行文件通过仓库根目录的 CMake 构建产物通常位于flatc或Debug/flatc等路径一份.fbsschema 文件例如仓库测试用的 tests/monster_test.fbs 或示例中的 samples/monster.fbs。FlatBuffers Go 库代码位置Go 语言的运行时库源码位于仓库的go目录go/builder.goBuilder状态机负责从叶子节点开始、以从后往前last-first的方式构建 FlatBuffer 字节缓冲go/table.goTable类型封装字节切片并提供只读访问与原地修改能力go/struct.goStruct类型用于无 vtable 的内联结构体go/lib.goGetRootAs、GetSizePrefixedRootAs、缓冲区标识符file identifier读取与校验等顶层辅助函数go/encode.go小端序编解码原语以及SOffsetTint32、UOffsetTuint32、VOffsetTuint16三类偏移量类型定义其余文件还包括 go/sizes.go各类型字节宽度常量与 go/grpc.gogRPC 辅助。从源码结构看运行时库是自包含的、不依赖任何第三方包仅使用标准库sort、math、strconv、unicode/utf8等因此可以方便地以github.com/google/flatbuffers/go模块路径集成进自己的 Go module或直接 vendor。测试 FlatBuffers Go 库Go 库的测试代码位于tests目录测试主体tests/go_test.go运行脚本tests/GoTest.sh。测试脚本做了什么从 tests/GoTest.sh 的源码看脚本的核心流程为生成测试用 Go 代码调用flatc -g --gen-object-api对monster_test.fbs、optional_scalars.fbs、required_strings.fbs以及include_test目录下的 schema 生成 Go 代码。这里使用了两个关键选项-g/--go生成 Go 语言绑定--gen-object-api额外生成带T后缀的对象 API如MonsterT支持与 JSON 的互转。搭建 GOPATH 布局Go 要求特定的文件布局才能链接多个包脚本把go/目录复制到go_gen/src/github.com/google/flatbuffers/go把go_test.go复制到flatbuffers_test包并以GO111MODULEoff的 GOPATH 模式运行测试脚本结束时会重新go env -w GO111MODULEon恢复模块模式。运行go test执行go test flatbuffers_test并传入若干关键参数--cpp_datatests/monsterdata_test.monC 侧生成的二进制数据用于交叉验证 Go 的读取结果--out_datatests/monsterdata_go_wire.monGo 侧写出数据的落盘路径--bench. --benchtime3s运行基准测试--fuzztrue --fuzz_fields4 --fuzz_objects10000开启模糊测试每个模糊对象含 4 个字段共 10000 个对象。gofmt 检查脚本最后会对目录内文件执行gofmt -l检查格式是否符合 Go 社区规范。如何运行# 先构建 flatc参见 docs/source/building.md确保仓库根目录存在 flatc 可执行文件 # 然后执行需要已安装 Go cd tests ./GoTest.sh脚本输出OK: Go tests passed.表示全部通过KO: Go tests failed.表示存在失败。如需查看更多细节可按脚本注释追加-test.v详细输出标志或用-test.bench.通配运行全部基准测试。测试中的部分关键用例tests/go_test.go还包括TestTextParsing验证对象 APIMonsterT与encoding/json的互转见下节文本解析CheckNoNamespaceImport验证无命名空间 schema如Pizza、order生成代码的打包与往返一致性。使用 FlatBuffers Go 库读取与访问FlatBuffers 在 Go 中同时支持读取read与写入write二进制 FlatBuffer。整体流程为用flatc --go从 schema 生成 Go 类生成的代码放在你指定的输出目录通常需要按包名组织目录结构在你的代码中同时 import 运行时库与生成的代码读取或构造 FlatBuffer 字节并通过生成的GetRootAsXxx函数访问数据。生成 Go 代码flatc --go -o gen monster.fbs--go简写-g启用 Go 代码生成-o dir指定输出目录如需对象 API生成XxxT结构体及Pack/UnPack方法追加--gen-object-api这正是 tests/GoTest.sh 中的用法。读取一个 FlatBuffer 二进制文件以下示例来自原文档演示如何读取一个 FlatBuffer 二进制文件import ( example MyGame/Example flatbuffers github.com/google/flatbuffers/go os ) buf, err : os.ReadFile(monster.dat) // handle err monster : example.GetRootAsMonster(buf, 0)要点说明example.GetRootAsMonster是生成的代码它内部调用运行时库 go/lib.go 中的GetRootAs先从buf[offset:]读出 4 字节的根偏移量n再以noffset初始化对象。因此第二个参数0表示从缓冲区头部开始解析。GetRootAs的泛型实现要求目标类型实现FlatBuffer接口Table() Table与Init(buf []byte, i UOffsetT)见 go/lib.go。如果缓冲区带有 size-prefix例如流式传输场景应改用GetSizePrefixedRootAs读取前缀大小用GetSizePrefix读取/校验 4 字节文件标识符file identifier用GetBufferIdentifier/BufferHasIdentifier及各自的 size-prefixed 版本这些均在 go/lib.go 中提供。访问字段值生成代码为每个字段提供Get风格实际命名为Hp()、Pos()等的访问器hp : monster.Hp() pos : monster.Pos(nil)标量字段访问器内部通过 go/table.go 的Table.Offset(slot)查询 vtable先定位 vtable 位置再与 vtable 长度比对若字段在缓冲区中不存在vtable 偏移为 0GetXxxSlot系列方法会返回 schema 中声明的默认值这正是 FlatBuffers缺失字段零拷贝、零填充特性的体现。嵌套 table / struct 字段如Pos的访问器需要传入一个用于复用的接收对象传nil时内部会新建读取逻辑通过Table.Union之类的偏移跳转完成。底层Table 与偏移量从 go/table.go 可以看到Table结构非常精简type Table struct { Bytes []byte Pos UOffsetT // Always 131. }Pos记录该对象在缓冲区中的根位置Offset(vtableOffset VOffsetT)根据 vtable 返回字段的偏移若字段被废弃或缺失则返回 0VectorLen/Vector/ByteVector/String读取向量与字符串且 ByteVector 对越界、溢出做了防御性检查非法偏移返回nil而非 panicGetXxxSlot(slot, default)系列读取字段并在缺失时返回默认值。偏移量类型定义在 go/encode.gotype ( SOffsetT int32 // signed offset指向任意数据 UOffsetT uint32 // unsigned offset指向向量数据 VOffsetT uint16 // unsigned offset位于 vtable 中 )原地修改Mutation在缓冲区上直接改值在某些场景下需要在不创建副本的情况下就地修改已存在的 FlatBuffer。为此FlatBuffer 的 table 或 struct 的标量字段支持原地修改mutate。原文档给出了完整示例monster : example.GetRootAsMonster(buf, 0) // Set table field. if ok : monster.MutateHp(10); !ok { panic(failed to mutate Hp) } // Set struct field. monster.Pos().MutateZ(4) // This mutation will fail because the mana field is not available in // the buffer. It should be set when creating the buffer. if ok : monster.MutateMana(20); !ok { panic(failed to mutate Hp) }为什么用 mutate 而不是 set这里刻意使用mutate而非set一词以强调这是一个特殊用例FlatBuffer 的设计目标是序列化与传输字段在写入时可以省略利用默认值机制节省空间。如果某个字段在缓冲区中根本不存在写入端未设置就无法在原地修改它。因此所有 mutate 函数都返回布尔值返回false表示目标字段在缓冲区中不可用未写入修改失败。典型场景是上面示例的MutateMana(20)—— 若构建缓冲区时未显式设置mana字段它带有默认值vtable 中不存在该字段的偏移MutateMana会返回false。从生成的 tests/MyGame/Example/Monster.go 可以看到MutateMana与MutateHp正是对运行时库Table.MutateXxxSlot的封装后者先调用Offset(slot)检查字段是否存在于 vtable 中off 0时返回false否则写入新值并返回true实现见 go/table.go。哪些字段可以 mutatetable 的标量字段可以如MutateHp、MutateMana、MutateBool、MutateFloat64等struct 的内联标量字段可以因为 struct 是固定布局、内联存储的如monster.Pos().MutateZ(4)字符串、向量等非标量字段不能原地修改长度可变无法在固定大小的缓冲区中就地调整。运行时库在 go/table.go 中提供了从MutateBool到MutateUOffsetT的全套标量 mutate 原语以及带Slot后缀的 vtable 感知版本如MutateInt32Slot由生成的字段访问器按需调用。底层原理写入走小端编解码MutateXxxSlot最终调用 go/encode.go 中的WriteXxx系列函数它们以小端序将值写回Bytes[off:]。这些写入函数与读取端的GetXxx一一对应例如WriteUint32对 4 字节逐位移位写入WriteFloat32/WriteFloat64通过math.Float32bits/math.Float64bits完成位模式转换。文本解析Text Parsing现状截至当前仓库版本Go 运行时库本身不支持直接解析文本schema 或 JSON。原文档明确指出目前没有从 Go 直接解析文本schema 和 JSON的支持不过你可以通过 cgo 使用 C 的解析器。关于文本解析请参阅 C 文档。这意味着如果需要在 Go 中把 JSON 转成 FlatBuffer 二进制典型做法是在构建阶段用flatc的文本/JSON 工具如flatc -t转 JSON、flatc --json解析 JSON完成转换Go 侧只负责收发二进制或者使用对象 API--gen-object-api生成XxxT结构体配合 Go 标准库encoding/json在Go 结构体层面与 JSON 互通。测试 tests/go_test.go 中的TestTextParsing正是验证了MonsterT与 JSON 的编解码往返json.NewEncoder编码 →json.NewDecoder解码 → 字段比对若要严格做 schema 级别的文本解析可如文档所述借助 cgo 调用 C 解析器但需要自行承担 CGO 的构建与维护成本。小结与延伸阅读本文围绕 Go 语言使用文档 的核心脉络覆盖了Go 库的位置go/ 目录与模块结构测试体系tests/go_test.go 与 tests/GoTest.sh及运行方式从flatc --go生成代码到GetRootAsMonster读取缓冲区的完整流程标量字段的原地修改mutate语义与返回值约定文本解析的现状与替代方案。进一步深入可参考完整教程跨语言通用使用流程编写 schematable / struct / enum / union 语法flatc 命令参考全部代码生成选项可运行的示例samples/go_sample.sh对应 samples/sample_binary.go展示了从 schema 生成到 Go 读写二进制的最小闭环gRPC 集成grpc/examples/go 提供了 Go 侧 gRPC 示例。【免费下载链接】flatbuffersFlatBuffers: Memory Efficient Serialization Library项目地址: https://gitcode.com/GitHub_Trending/fl/flatbuffers创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考