【亲测免费】 Protobuf-TS 使用教程

项目介绍

Protobuf-TS 是一个用于 TypeScript 的 Protocol Buffers 实现，它包括一个 protoc 插件，用于从 proto 定义文件生成 TypeScript 代码，以及一些运行时库，这些库被生成的代码使用以保持代码大小较小。生成的代码除了运行时库（@protobuf-ts/runtime）外没有其他依赖，并且严格遵循 protobuf 规范。

项目快速启动

安装

首先，你需要安装 @protobuf-ts/plugin：

# 使用 npm 安装
npm install @protobuf-ts/plugin

# 或者使用 yarn 安装
yarn add @protobuf-ts/plugin

生成 TypeScript 代码

编写一个简单的 proto 文件 example.proto：

syntax = "proto3";
package example;

message Person {
  string name = 1;
  uint64 age = 2;
}

使用 protoc 生成 TypeScript 代码：

protoc --plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts --ts_out=. example.proto

使用生成的代码

生成的代码文件 example_pb.ts 包含了对 Person 消息的定义。你可以这样使用：

import { Person } from './example_pb';

const person = new Person();
person.setName('Alice');
person.setAge(30);

const bytes = person.serializeBinary();
const decodedPerson = Person.deserializeBinary(bytes);

console.log(decodedPerson.getName(), decodedPerson.getAge());

应用案例和最佳实践

案例一：Web 应用中的数据序列化

在 Web 应用中，Protobuf-TS 可以用于高效地序列化和反序列化数据。例如，前端与后端通过 gRPC-web 进行通信时，可以使用 Protobuf-TS 生成的 TypeScript 代码来处理数据。

案例二：微服务间的数据交换

在微服务架构中，不同服务之间需要高效且可靠的数据交换。使用 Protobuf-TS 可以确保数据格式的一致性，并且由于其高效的二进制格式，可以减少网络传输的数据量。

最佳实践

• 使用 proto3 语法：确保你的 proto 文件使用 proto3 语法，这是 Protobuf-TS 支持的版本。
• 优化代码大小：通过设置 optimize_for = CODE_SIZE，可以减少生成的代码大小。
• 使用 bigint 支持：如果你的应用需要处理大整数，确保你的 TypeScript 编译目标支持 ES2020 以使用 bigint。

典型生态项目

gRPC-web

Protobuf-TS 与 gRPC-web 结合使用，可以在浏览器中直接调用 gRPC 服务，实现高效的前后端通信。

Twirp

Twirp 是一个简单的 RPC 框架，与 Protobuf-TS 结合使用，可以快速搭建起一个基于 Protobuf 的 RPC 服务。

grpc-client

Protobuf-TS 生成的代码可以直接与各种 gRPC 客户端库集成，如 Node.js 的 grpc 库，实现服务间的通信。

通过以上内容，你可以快速上手并深入了解 Protobuf-TS 的使用和最佳实践。