Protobuf-TS 使用教程

最新推荐文章于 2024-08-08 08:31:28 发布

卓怡桃Prunella

最新推荐文章于 2024-08-08 08:31:28 发布

阅读量979

点赞数 14

本文链接：https://blog.csdn.net/gitblog_01139/article/details/141013517

版权

Protobuf-TS 使用教程

protobuf-tsProtobuf and RPC for TypeScript项目地址:https://gitcode.com/gh_mirrors/pr/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());