讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中 Protobuf 序列化怎么配置与使用

夜涛同学_4276

夜涛同学_4276

发布时间:2026-10-29 10:57:01

|

332人浏览过

|

来源于php中文网

原创

Java中使用Protobuf序列化需三步:定义.proto文件、用protoc生成Java类、调用toByteArray()和parseFrom()完成序列化与反序列化;其轻量高效,不依赖反射,性能优于JSON和JDK序列化。

java 中 protobuf 序列化怎么配置与使用

Java 中使用 Protobuf 序列化,核心是三步:定义数据结构(.proto 文件)、生成 Java 类、在代码中调用序列化/反序列化方法。整个流程轻量、高效,不依赖运行时反射,生成的类直接操作二进制字节,性能远超 JSON 或 JDK 自带序列化。

配置环境与添加依赖

确保项目能编译和运行 Protobuf 代码:

  • 下载并安装 protoc 编译器:从 GitHub 官方发布页 下载对应系统的预编译包(如 protoc-24.4-win64.zip),解压后把 bin/protoc.exe(Windows)或 bin/protoc(Linux/macOS)路径加入系统 PATH,终端执行 protoc --version 验证是否成功
  • 在 Maven 项目中添加 Java 运行时依赖(以最新稳定版为例):

  com.google.protobuf
  protobuf-java
  3.21.12

注意:版本号需与 protoc 编译器主版本尽量一致(如 protoc v3.21.x 对应 protobuf-java v3.21.x),避免生成代码与运行时 API 不兼容。

编写并编译 .proto 文件

Protobuf 的数据契约由 .proto 文件定义,必须明确语法版本和字段规则:

立即学习“Java免费学习笔记(深入)”;

  • 开头声明 syntax = "proto3";(推荐 proto3,无 required/optional 区分,默认字段可为空)
  • 设置 Java 相关选项,例如:
    option java_package = "com.example.model";
    option java_outer_classname = "UserProto";
    option java_multiple_files = true;(生成独立 .java 文件,更易管理)
  • 定义 message,字段编号从 1 开始,不可重复,建议预留扩展空间(如跳着编号:1, 2, 4, 7)

示例 user.proto:

java-api-doc-generator
java-api-doc-generator

分析 Java Spring Boot 后端 Controller 代码,自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。

下载
syntax = "proto3";
option java_package = "com.example.model";
option java_outer_classname = "UserProto";
option java_multiple_files = true;

message User {
  int64 id = 1;
  string name = 2;
  int32 age = 3;
  repeated string tags = 4;
}

编译命令(当前目录含 user.proto):

protoc --java_out=. user.proto

执行后会在当前目录生成 com/example/model/User.java 等文件,将其纳入项目源码路径即可。

Java 代码中序列化与反序列化

生成的类自带构建器(Builder)和序列化方法,无需额外配置:

  • 使用 newBuilder() 构建对象,链式设值,最后调用 build()
  • 序列化:调用 toByteArray() 得到紧凑二进制字节数组
  • 反序列化:静态方法 User.parseFrom(byte[]) 直接还原对象
  • 支持部分解析(如只读取前几个字段)、流式读写(parseDelimitedFrom)、JSON 互转(需 com.google.protobuf.util.JsonFormat)

典型用法示例:

import com.example.model.UserProto.User;

User user = User.newBuilder()
  .setId(1001)
  .setName("Alice")
  .setAge(28)
  .addTags("dev").addTags("java")
  .build();

byte[] data = user.toByteArray(); // 序列化
User restored = User.parseFrom(data); // 反序列化
System.out.println(restored.getName()); // 输出 Alice

注意事项与常见避坑点

实际集成中容易忽略但影响稳定性的细节:

  • 字段编号不能变更:一旦发布,修改编号会导致旧数据无法解析;新增字段只能用新编号,且应设为 optional(proto3 默认)或提供默认值
  • proto2 与 proto3 不兼容:不要混用;proto3 已移除 required/optional 关键字,所有标量字段均可为空
  • 枚举和嵌套 message 要显式定义:避免隐式引用导致编译失败或类加载异常
  • 多模块项目注意 classpath 冲突:不同模块若引入不同版本的 protobuf-java,可能引发 NoClassDefFoundError 或 InvalidProtocolBufferException
  • 大对象慎用 toByteArray():该方法一次性复制全部数据;超大消息建议用 writeTo(OutputStream) 流式写出

热门AI工具

更多
PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

11437

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

8542

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

7352

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1224

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

988

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

1456

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

3009

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

20271

2023.08.03

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

20

2026.10.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn