ts-proto 使用教程
2024-09-15 16:09:24作者:滑思眉Philip
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。
登录后查看全文
热门项目推荐
- QQwen3-Next-80B-A3B-InstructQwen3-Next-80B-A3B-Instruct 是一款支持超长上下文(最高 256K tokens)、具备高效推理与卓越性能的指令微调大模型00
- QQwen3-Next-80B-A3B-ThinkingQwen3-Next-80B-A3B-Thinking 在复杂推理和强化学习任务中超越 30B–32B 同类模型,并在多项基准测试中优于 Gemini-2.5-Flash-Thinking00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0265cinatra
c++20实现的跨平台、header only、跨平台的高性能http库。C++00AI内容魔方
AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。02- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GOT-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).Dockerfile06
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp课程页面空白问题的技术分析与解决方案2 freeCodeCamp博客页面工作坊中的断言方法优化建议3 freeCodeCamp音乐播放器项目中的函数调用问题解析4 freeCodeCamp论坛排行榜项目中的错误日志规范要求5 freeCodeCamp猫照片应用教程中的HTML注释测试问题分析6 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析7 freeCodeCamp全栈开发课程中React实验项目的分类修正8 freeCodeCamp课程视频测验中的Tab键导航问题解析9 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析10 freeCodeCamp 课程中关于角色与职责描述的语法优化建议
最新内容推荐
Jetson TX2开发板官方资源完全指南:从入门到精通 PCDViewer-4.9.0-Ubuntu20.04:专业点云可视化与编辑工具全面解析 STM32到GD32项目移植完全指南:从兼容性到实战技巧 JDK 8u381 Windows x64 安装包:企业级Java开发环境的完美选择 SAP S4HANA物料管理资源全面解析:从入门到精通的完整指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南 基恩士LJ-X8000A开发版SDK样本程序全面指南 - 工业激光轮廓仪开发利器 ZLIB 1.3 静态库 Windows x64 版本:高效数据压缩解决方案完全指南 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 全球GEOJSON地理数据资源下载指南 - 高效获取地理空间数据的完整解决方案
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
139
1.91 K

deepin linux kernel
C
22
6

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
192
273

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
923
551

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
421
392

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
189

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
74
64

本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
344
1.3 K

Elasticsearch
国内Top1 elasticsearch搜索引擎框架es ORM框架,索引全自动智能托管,如丝般顺滑,与Mybatis-plus一致的API,屏蔽语言差异,开发者只需要会MySQL语法即可完成对Es的相关操作,零额外学习成本.底层采用RestHighLevelClient,兼具低码,易用,易拓展等特性,支持es独有的高亮,权重,分词,Geo,嵌套,父子类型等功能...
Java
36
8