Protobuf-ES 项目使用指南
项目介绍
Protobuf-ES 是一个完全符合 Protocol Buffers 标准的 JavaScript 库,专为 ECMAScript 设计。它不仅通过了 Protocol Buffers 的一致性测试,还提供了完整的 TypeScript 支持,适用于 Web 浏览器和 Node.js 环境。Protobuf-ES 由 Buf 创建,旨在为 JavaScript 开发者提供一个高效、可靠的 Protocol Buffers 实现。
项目快速启动
安装依赖
首先,你需要安装 Protobuf-ES 的代码生成器、运行时库以及 Buf CLI:
npm install @bufbuild/protobuf @bufbuild/protoc-gen-es @bufbuild/buf
配置生成器
创建一个 buf.gen.yaml
文件,配置如下:
version: v2
inputs:
- directory: proto
plugins:
- local: protoc-gen-es
opt: target=ts
out: src/gen
下载示例 .proto
文件
创建一个 proto
目录,并下载示例 .proto
文件:
mkdir proto
curl https://raw.githubusercontent.com/bufbuild/protobuf-es/main/packages/protobuf-example/proto/example.proto > proto/example.proto
生成代码
使用 Buf 或 protoc 生成代码:
npx buf generate
生成完成后,你会在 src/gen
目录下看到生成的 example_pb.ts
文件,其中包含 User
类型和 UserSchema
。
使用生成的代码
你可以像这样使用生成的代码:
import { UserSchema } from "./gen/example_pb";
import { create, toBinary, toJson } from "@bufbuild/protobuf";
let user = create(UserSchema, {
firstName: "Homer",
lastName: "Simpson",
active: true,
locations: ["Springfield"],
projects: { SPP: "Springfield Power Plant" },
manager: { firstName: "Montgomery", lastName: "Burns" },
});
const bytes = toBinary(UserSchema, user);
const json = toJson(UserSchema, user);
应用案例和最佳实践
案例1:Web 应用中的数据序列化
在 Web 应用中,Protobuf-ES 可以用于高效地序列化和反序列化数据。例如,前端应用可以将用户数据序列化为二进制格式,通过 HTTP 请求发送到后端,后端再将其反序列化为对象进行处理。
案例2:微服务间的数据交换
在微服务架构中,Protobuf-ES 可以用于服务间的数据交换。通过定义统一的 .proto
文件,不同语言编写的服务可以生成对应的类型定义,确保数据交换的一致性和高效性。
最佳实践
- 统一数据模型:在项目中统一使用
.proto
文件定义数据模型,确保前后端和不同服务间数据结构的一致性。 - 代码生成自动化:将代码生成步骤集成到 CI/CD 流程中,确保每次更新
.proto
文件后自动生成最新的代码。 - 性能优化:利用 Protobuf-ES 的二进制序列化格式,减少数据传输的大小,提升应用性能。
典型生态项目
Connect-ES
Connect-ES 是 Protobuf-ES 的配套 RPC 库,支持 Connect、gRPC 和 gRPC-Web 协议。它提供了类型安全的 API,使得在 TypeScript 中使用 Protobuf 更加便捷。
Buf CLI
Buf CLI 是一个强大的工具,用于管理和生成 Protobuf 文件。它支持代码生成、格式检查、依赖管理等功能,是 Protobuf-ES 开发者的得力助手。
Buf Schema Registry
Buf Schema Registry 是一个集中式的 Protobuf 模式注册中心,用于管理和共享 .proto
文件。它可以帮助团队更好地协作,确保所有服务使用相同的数据模型。
通过以上模块的介绍,你应该已经对 Protobuf-ES 有了初步的了解,并能够快速上手使用。希望这篇指南能帮助你在项目中更好地应用 Protobuf-ES。
HunyuanImage-3.0
HunyuanImage-3.0 统一多模态理解与生成,基于自回归框架,实现文本生成图像,性能媲美或超越领先闭源模型00- DDeepSeek-V3.2-ExpDeepSeek-V3.2-Exp是DeepSeek推出的实验性模型,基于V3.1-Terminus架构,创新引入DeepSeek Sparse Attention稀疏注意力机制,在保持模型输出质量的同时,大幅提升长文本场景下的训练与推理效率。该模型在MMLU-Pro、GPQA-Diamond等多领域公开基准测试中表现与V3.1-Terminus相当,支持HuggingFace、SGLang、vLLM等多种本地运行方式,开源内核设计便于研究,采用MIT许可证。【此简介由AI生成】Python00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0369Hunyuan3D-Part
腾讯混元3D-Part00ops-transformer
本项目是CANN提供的transformer类大模型算子库,实现网络在NPU上加速计算。C++097AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-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).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选









