当前位置:

首页 > 编程开发 > Java操作Protobuf:序列化与反序列化教程

Java操作Protobuf:序列化与反序列化教程

在Java中操作Protobuf数据主要包括定义.proto文件并生成Java类、序列化对象为字节流、以及反序列化字节流还原对象。1.定义.proto文件并通过protoc工具生成Java类,如PersonOuterClass.Person;2.使用toByteArray()方法将对象序列化为字节数组以便传输或存储;3.使用parseFrom()方法将接收到的字节流转回对象,并注意异常处理和proto文件一致性;此外需关注字段变更兼容性、调试方式、性能及线程安全等问题。

本文目录

    在Java中操作Protobuf数据主要包括定义.proto文件并生成Java类、序列化对象为字节流、以及反序列化字节流还原对象。1. 定义.proto文件并通过protoc工具生成Java类,如PersonOuterClass.Person;2. 使用toByteArray()方法将对象序列化为字节数组以便传输或存储;3. 使用parseFrom()方法将接收到的字节流转回对象,并注意异常处理和proto文件一致性;此外需关注字段变更兼容性、调试方式、性能及线程安全等问题。

    Java中如何操作Protobuf数据?序列化与反序列化指南

    在Java中操作Protobuf数据,主要就是做两件事:序列化和反序列化。这两个过程是使用Protocol Buffers进行数据传输的基础,尤其在网络通信、数据存储等场景中非常常见。

    Java中如何操作Protobuf数据?序列化与反序列化指南

    定义.proto文件并生成Java类

    在操作之前,你需要先定义.proto文件,这是Protobuf的结构定义语言。比如:

    Java中如何操作Protobuf数据?序列化与反序列化指南
    syntax = "proto3";
    
    message Person {
      string name = 1;
      int32 age = 2;
    }

    然后通过 protoc 工具生成对应的Java类:

    protoc --java_out=. Person.proto

    这一步完成后,会生成一个类似 PersonOuterClass.Person 的类,这个类就是你在Java代码中操作数据的核心对象。

    Java中如何操作Protobuf数据?序列化与反序列化指南

    注意:确保你的protoc版本和运行环境兼容,否则可能会出现不兼容的问题。


    序列化:将对象转换为字节流

    序列化的目的是为了便于传输或持久化,比如通过网络发送给其他服务或者写入文件。

    以刚才的 Person 为例,你可以这样序列化:

    Person person = Person.newBuilder()
        .setName("Alice")
        .setAge(25)
        .build();
    
    byte[] data = person.toByteArray();

    这段代码把一个 Person 对象转成了字节数组,可以直接通过Socket、HTTP Body等方式传输。

    关键点:

    • 使用 toByteArray() 是最直接的方式
    • 如果你有多个消息要打包一起传,可以考虑用 CodedOutputStream
    • 字节数组大小会影响性能,尽量控制字段数量和类型

    反序列化:从字节流还原成对象

    接收到对方发来的字节数组后,就需要把它还原成对象:

    byte[] receivedData = ...; // 接收的字节流
    Person receivedPerson = Person.parseFrom(receivedData);
    System.out.println("Name: " + receivedPerson.getName());

    这就是最基本的反序列化方式。如果接收的是多个连续的消息,可以用 CodedInputStream 来逐个读取。

    需要注意的地方:

    • 确保发送方和接收方使用的 .proto 文件一致,否则解析失败
    • 如果字节流损坏或格式不对,会抛出异常,建议做好异常处理
    • 对于大块数据,建议配合流式读取避免内存溢出

    常见问题与注意事项

    • 字段变更导致兼容问题?

      • Protobuf支持向后兼容,新增字段不影响旧客户端,但删除或修改字段类型可能导致问题。
    • 如何调试查看序列化后的内容?

      • 可以用 TextFormat.printToString(message) 把对象打印成可读字符串,方便调试。
    • 效率怎么样?

      • Protobuf的序列化/反序列化速度很快,而且生成的数据体积小,适合高性能场景。
    • 是否线程安全?

      • 构建器(Builder)不是线程安全的,但构建出来的对象是不可变的,可以安全共享。

    基本上就这些。掌握了序列化和反序列化的基本流程,再加上一点对协议的理解,就能在Java里顺利使用Protobuf了。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    opencode安装skills教程及本地配置方法
    opencode安装skills教程及本地配置方法

    遇到OpenCode Skills无法加载或配置无效?本文手把手教你完成Skills的安装、环境变量设置及本地调试,避开常见坑点,让AI助手更懂你的代码习惯。

    如何开启Visual Studio2022实时代码分析警告提示
    如何开启Visual Studio2022实时代码分析警告提示

    解决 Visual Studio 2022 编辑时不显示代码分析警告的问题。指南涵盖 .NET 项目实时分析设置、Roslyn 分析器范围调整及错误列表来源筛选,确保开发者能高效利用实时代码诊断功能。

    如何在Visual Studio2022查看变量监视窗口调试程序
    如何在Visual Studio2022查看变量监视窗口调试程序

    详解 Visual Studio 2022 调试技巧:包括断点设置、监视窗口开启方法、变量添加步骤以及通过 F10 单步执行观察变量值变化的全过程。

    Visual Studio2017设置默认编码为UTF-8不带BOM
    Visual Studio2017设置默认编码为UTF-8不带BOM

    针对 Visual Studio 2017 缺乏全局默认编码选项的情况,详解如何利用 .editorconfig 设定项目级 UTF-8 无 BOM 规则,以及手动转换现有文件并校验字节的方法。

    Visual Studio2022F5调试提示启动项目未配置怎么修复
    Visual Studio2022F5调试提示启动项目未配置怎么修复

    解决 Visual Studio 2022 F5 调试报错问题,通过设置启动项目、检查解决方案属性及正确区分类库与应用项目,快速恢复调试功能。

    Visual Studio2022NuGet包还原失败离线处理方案
    Visual Studio2022NuGet包还原失败离线处理方案

    解决Visual Studio 2022离线环境中NuGet包还原失败的难题,涵盖依赖链分析、本地源配置、包集收集及隔离验证步骤,帮助开发者构建稳定的离线开发环境。

    Visual Studio2017大项目加载缓慢,优化加载性能技巧
    Visual Studio2017大项目加载缓慢,优化加载性能技巧

    解决Visual Studio 2017大型项目加载慢的实用指南。涵盖性能监测、扩展管理、文档恢复优化及版本兼容性检查,帮助开发者精准定位瓶颈并提升工作效率。

    Visual Studio2022设置多启动项目同时调试运行
    Visual Studio2022设置多启动项目同时调试运行

    详解 Visual Studio 2022 多启动项目配置方法,包括启动动作选择、顺序调整及调试技巧,帮助开发者高效调试分布式或前后端分离应用。

    fastapi下载文件接口实现教程
    fastapi下载文件接口实现教程

    深入解析在FastAPI框架中实现文件下载接口的完整方案,涵盖基于FileResponse的本地静态文件传输、基于StreamingResponse的分块流式传输、RFC 5987中文文件名编码规范、路径穿越安全防御及BackgroundTasks临时文件清理,并配备详细代码示例与架构解析图。

    码上飞 codeflying 平台功能介绍
    码上飞 codeflying 平台功能介绍

    了解码上飞CodeFlying如何利用自然语言生成应用。通过物品借用登记实例,学习需求解析、代码生成、测试优化及对话修改的核心操作流程。

    查看更多
    精品专题 更多
    装机必备
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows
    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程
    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    Mac软件 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版
    macOS

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版
    Windows/ macOS/ Linux

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版
    Windows/ macOS/ Linux

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版
    Windows

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。