ts-proto 使用教程
2024-09-15 17:09:27作者:滑思眉Philip
ts-proto
An idiomatic protobuf generator for TypeScript
1. 项目介绍
ts-proto 是一个将 .proto
文件转换为强类型、符合习惯的 TypeScript 文件的工具。它能够将 Protobuf 定义转换为 TypeScript 接口和类型,使得在前端项目中使用 Protobuf 变得更加简单和直观。ts-proto 的目标是生成符合 TypeScript/ES6 习惯的类型定义,并且尽可能地简化 Protobuf 在前端的使用。
2. 项目快速启动
安装
首先,你需要安装 ts-proto
和 protoc
(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
的选项,如esModuleInterop
、useDate
等。
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。
ts-proto
An idiomatic protobuf generator for TypeScript
热门项目推荐
相关项目推荐
- CangjieCommunity为仓颉编程语言开发者打造活跃、开放、高质量的社区环境Markdown6690
- redis-sdk仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。Cangjie32226
- Yi-CoderYi Coder 编程模型,小而强大的编程助手305
- qwerty-learner为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workersTypeScript15.77 K1.48 K
- advanced-javaAdvanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。JavaScript76.1 K19.07 K
- taro开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/TypeScript35.51 K4.79 K
- CommunityCangjie-TPC(Third Party Components)仓颉编程语言三方库社区资源汇总252
- Wwindows暂无简介Shell16.14 K1.35 K
- byzer-langByzer(以前的 MLSQL):一种用于数据管道、分析和人工智能的低代码开源编程语言。Scala1.88 K551
- AanacondaAnaconda turns your Sublime Text 3 in a full featured Python development IDE including autocompletion, code linting, IDE features, autopep8 formating, McCabe complexity checker Vagrant and Docker support for Sublime Text 3 using Jedi, PyFlakes, pep8, MyPy, PyLint, pep257 and McCabe that will never freeze your Sublime Text 3Python2.22 K263
热门内容推荐
展开
最新内容推荐
展开
项目优选
收起
CangjieCommunity
为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
669
0
RuoYi-Vue
🎉 基于SpringBoot,Spring Security,JWT,Vue & Element 的前后端分离权限管理系统,同时提供了 Vue3 的版本
Java
136
18
openHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
10
4
redis-sdk
仓颉语言实现的Redis客户端SDK。已适配仓颉0.53.4 Beta版本。接口设计兼容jedis接口语义,支持RESP2和RESP3协议,支持发布订阅模式,支持哨兵模式和集群模式。
Cangjie
322
26
advanced-java
Advanced-Java是一个Java进阶教程,适合用于学习Java高级特性和编程技巧。特点:内容深入、实例丰富、适合进阶学习。
JavaScript
75.83 K
19.04 K
qwerty-learner
为键盘工作者设计的单词记忆与英语肌肉记忆锻炼软件 / Words learning and English muscle memory training software designed for keyboard workers
TSX
15.56 K
1.44 K
Jpom
🚀简而轻的低侵入式在线构建、自动部署、日常运维、项目监控软件
Java
1.41 K
292
Yi-Coder
Yi Coder 编程模型,小而强大的编程助手
HTML
30
5
easy-es
Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
1.42 K
231
taro
开放式跨端跨框架解决方案,支持使用 React/Vue/Nerv 等框架来开发微信/京东/百度/支付宝/字节跳动/ QQ 小程序/H5/React Native 等应用。 https://taro.zone/
TypeScript
35.34 K
4.77 K