MessagePack Ruby 技术文档
2024-12-26 00:25:19作者:侯霆垣
1. 安装指南
使用 Bundler 安装
在 Gemfile 中添加以下内容:
gem 'msgpack'
然后运行以下命令安装:
bundle install
使用 RubyGems 安装
直接通过 RubyGems 安装:
gem install msgpack
从源码构建并安装
如果你已经克隆了 msgpack-ruby 仓库,可以通过以下步骤构建并安装:
bundle
rake
gem install --local pkg/msgpack
2. 项目的使用说明
MessagePack 是一种高效的二进制序列化格式,适用于多种语言之间的数据交换。它比 JSON 更快且更小。以下是一些常见的使用场景:
- 在 Rails 中使用 RABL 创建返回 MessagePack 格式的 REST API。
- 在 memcached 或 Redis 中存储通过 MessagePack 序列化的对象。
- 从移动设备(如智能手机)上传高效格式的数据。
- 设计与嵌入式设备通信的可移植协议。
- 在不同语言编写的软件组件之间交换对象。
3. 项目 API 使用文档
序列化对象
使用 MessagePack.pack 或 to_msgpack 方法:
require 'msgpack'
msg = MessagePack.pack(obj)  # 或者
msg = obj.to_msgpack
File.binwrite('mydata.msgpack', msg)
流式序列化
使用 Packer 进行流式序列化:
pk = MessagePack::Packer.new(io)
pk.write_array_header(2).write(e1).write(e2).flush
反序列化对象
使用 MessagePack.unpack 方法:
require 'msgpack'
msg = File.binread('mydata.msgpack')
obj = MessagePack.unpack(msg)
流式反序列化
使用 Unpacker 进行流式反序列化:
u = MessagePack::Unpacker.new(io)
u.each do |obj|
  # 处理对象
end
序列化和反序列化符号
默认情况下,符号会被序列化为字符串:
packed = :symbol.to_msgpack     # => "\xA6symbol"
MessagePack.unpack(packed)      # => "symbol"
可以通过注册扩展类型来定制符号的序列化:
MessagePack::DefaultFactory.register_type(0x00, Symbol)
packed = :symbol.to_msgpack     # => "\xc7\x06\x00symbol"
MessagePack.unpack(packed)      # => :symbol
序列化和反序列化时间实例
默认情况下,MessagePack 的时间戳扩展类型未启用。可以通过以下方式启用:
MessagePack::DefaultFactory.register_type(
  MessagePack::Timestamp::TYPE, # 或者直接使用 -1
  Time,
  packer: MessagePack::Time::Packer,
  unpacker: MessagePack::Time::Unpacker
)
扩展类型
Packer 和 Unpacker 支持 MessagePack 的扩展类型:
pk = MessagePack::Packer.new(io)
pk.register_type(0x01, MyClass1, :to_msgpack_ext)
pk.register_type(0x02, MyClass2) { |obj| obj.how_to_serialize() }
uk = MessagePack::Unpacker.new()
uk.register_type(0x01, MyClass1, :from_msgpack_ext)
uk.register_type(0x02) { |data| MyClass2.create_from_serialized_data(data) }
对象池
创建 Packer 和 Unpacker 对象是昂贵的操作。为了获得最佳性能,建议重用这些对象:
factory = MessagePack::Factory.new
factory.register_type(0x01, Point, packer: ->(point, packer) {
  packer.write(point.x)
  packer.write(point.y)
}, unpacker: ->(unpacker) {
  x = unpacker.read
  y = unpacker.read
  Point.new(x, y)
}, recursive: true)
pool = factory.pool(5)
pool.load(pool.dump(Point.new(12, 34))) # => #<struct Point x=12, y=34>
4. 项目安装方式
使用 Bundler 安装
在 Gemfile 中添加以下内容:
gem 'msgpack'
然后运行以下命令安装:
bundle install
使用 RubyGems 安装
直接通过 RubyGems 安装:
gem install msgpack
从源码构建并安装
如果你已经克隆了 msgpack-ruby 仓库,可以通过以下步骤构建并安装:
bundle
rake
gem install --local pkg/msgpack
总结
MessagePack 是一个高效的二进制序列化格式,适用于多种语言之间的数据交换。通过本文档,你可以了解如何安装、使用以及通过 API 进行序列化和反序列化操作。希望本文档能帮助你更好地理解和使用 MessagePack。
登录后查看全文 
热门项目推荐
 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00 PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00
- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
 openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00 openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00 HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03 AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
 Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00 Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00 GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00
- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile014
 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00 Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
最新内容推荐
 ZLIB 1.3 静态库 Windows x64 版本:高效数据压缩解决方案完全指南 TextAnimator for Unity:打造专业级文字动画效果的终极解决方案 Python开发者的macOS终极指南:VSCode安装配置全攻略 CrystalIndex资源文件管理系统:高效索引与文件管理的最佳实践指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 基于Matlab的等几何分析IGA软件包:工程计算与几何建模的完美融合 PCDViewer-4.9.0-Ubuntu20.04:专业点云可视化与编辑工具全面解析 Windows版Redis 5.0.14下载资源:高效内存数据库的完美Windows解决方案 中兴e读zedx.zed文档阅读器V4.11轻量版:专业通信设备文档阅读解决方案
项目优选
收起
 docs
docsOpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
263
2.52 K
 kernel
kerneldeepin linux kernel
C
24
6
 flutter_flutter
flutter_flutter暂无简介
Dart
553
124
 ops-math
ops-math本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
595
137
 pytorch
pytorchAscend Extension for PyTorch
Python
94
122
 cangjie_tools
cangjie_tools仓颉编程语言命令行工具,包括仓颉包管理工具、仓颉格式化工具、仓颉多语言桥接工具及仓颉语言服务。
C++
52
67
 ohos_react_native
ohos_react_nativeReact Native鸿蒙化仓库
JavaScript
219
301
 RuoYi-Vue3
RuoYi-Vue3🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
601
 cangjie_compiler
cangjie_compiler仓颉编译器源码及 cjdb 调试工具。
C++
116
91
 Cangjie-Examples
Cangjie-Examples本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
357
1.77 K