首页
/ ts-proto 使用教程

ts-proto 使用教程

2024-09-15 16:09:24作者:滑思眉Philip

1. 项目介绍

ts-proto 是一个将 .proto 文件转换为强类型、符合习惯的 TypeScript 文件的工具。它能够将 Protobuf 定义转换为 TypeScript 接口和类型,使得在前端项目中使用 Protobuf 变得更加简单和直观。ts-proto 的目标是生成符合 TypeScript/ES6 习惯的类型定义,并且尽可能地简化 Protobuf 在前端的使用。

2. 项目快速启动

安装

首先,你需要安装 ts-protoprotoc(Protobuf 编译器):

npm install ts-proto

编译 Protobuf 文件

假设你有一个 person.proto 文件,内容如下:

syntax = "proto3";
package person;

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

你可以使用以下命令将其编译为 TypeScript 文件:

protoc --plugin=node_modules/ts-proto/protoc-gen-ts_proto --ts_proto_out=. person.proto

这将生成一个 person.ts 文件,包含 Person 接口和相关的编码/解码方法。

使用生成的 TypeScript 文件

在你的 TypeScript 项目中,你可以像使用普通 TypeScript 接口一样使用生成的类型:

import { Person } from './person';

const person: Person = {
  name: 'Alice',
  age: 30,
};

console.log(person);

3. 应用案例和最佳实践

案例1:使用 ts-proto 生成客户端和服务端类型

假设你有一个 gRPC 服务,定义了以下 .proto 文件:

syntax = "proto3";
package example;

service Greeter {
  rpc SayHello (HelloRequest) returns (HelloReply);
}

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

使用 ts-proto 生成 TypeScript 文件后,你可以在客户端和服务端共享这些类型定义,确保类型安全。

案例2:使用 ts-proto 生成 GraphQL 类型

如果你正在使用 GraphQL,你可以使用 ts-proto 生成的类型来定义 GraphQL 的输入和输出类型,确保前后端类型一致。

最佳实践

  • 使用 ts-proto 生成类型:确保你的 Protobuf 定义和 TypeScript 类型保持同步。
  • 避免手动修改生成的文件:生成的文件应该只由 ts-proto 工具更新,避免手动修改以防止冲突。
  • 使用 ts-proto 的配置选项:根据项目需求,合理配置 ts-proto 的选项,如 esModuleInteropuseDate 等。

4. 典型生态项目

NestJS 支持

ts-proto 提供了对 NestJS 的集成支持,可以生成 NestJS 友好的类型和服务接口。你可以通过配置 nestJs=true 选项来启用 NestJS 支持。

gRPC-Web 支持

ts-proto 也支持 gRPC-Web,你可以通过配置 outputClientImpl=grpc-web 选项来生成 gRPC-Web 客户端实现。

其他生态项目

  • nice-grpc:一个基于 ts-proto 的 gRPC 框架,提供了更简洁的 API 和更好的 TypeScript 支持。
  • starpc:另一个基于 ts-proto 的 RPC 框架,提供了灵活的配置选项和强大的类型支持。

通过这些生态项目,你可以更方便地在 TypeScript 项目中集成 Protobuf 和 gRPC。

登录后查看全文
热门项目推荐

项目优选

收起
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K
kernelkernel
deepin linux kernel
C
22
6
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
192
273
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K
easy-eseasy-es
Elasticsearch 国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8