简介
grpc_tools_node_protoc_ts
是一个基于Google Protocol Buffers
和gRPC
的 npm 包,能够自动生成 TypeScript 的gRPC 服务的客户端或服务器端。它提供了一种简单的方式创建一个可编程,易扩展和优化的通信架构。
安装
在使用之前,需要将其安装到项目之中。
--- ------- ---------- ------------------------- ----------
安装后,在使用 protobuf 文件时,需要在项目根目录下创建一个 tsconfig.json
文件,并添加以下配置:
- ------------------ - --------- --------- --------- ----------- ------------------- ------- --------------- ----- --------- --------- --------- ----- ------------------------------- ------ -------------- ----- --------- ---- -- ---------- -------------------- -
注意:./src/**/*.proto
是你的 proto 文件存放的路径。也可以根据你的项目路径修改。
使用
grpc_tools_node_protoc_ts
提供了两种使用方式:命令行和 API。下面分别详细介绍:
命令行使用
通过命令行,直接调用这个包提供的命令进行生成。
- -- ------ -- ------------------------- -------------------------------------------------------- - ------------------------------- ------------------------------ - -------------------------- - ------------------------
- -- ------ -- ------------------------- -------------------------------------------------------- - ------------------------------- ------------------------------ - -------------------------- - -------------------- ------------------------------------ - ------------------------
其中,--grpc_out
和 --ts_out
指定的两个路径为生成代码存放的路径。
--plugin
指定的是 grpc_tools_node_protoc_plugin
的路径。在安装了 grpc_tools_node_protoc_ts
后,grpc_tools_node_protoc_plugin
就存在于 node_modules/.bin/
目录下。
注意:在 Windows 下需要将 which
改为 where
.
API 使用
- 首先需要引入这个 npm 包。
----- ---- - ------------------------- ----- ----------- - ------------------------------ ----- - --------------------- - - ------------------------- ----- - -------- - - ---------------------- ----- - --------- - - ---------------- ----- - ------- - - ---------------- ----- - --------- - - -------------- ----- --------- - -------------------------------------
- 使用
generator.compile()
方法生成代码。
----- ------- - - --------- ----- ------ ------- ------ ------- --------- ----- ------- ----- ------------ ----------------- -- ----- ----------------- - ------------------------------------------- --------- ----- ----- - -------------------------------- ----- ------- - -------------------------------- ----- -------------- - ----------------- ----- -------- - ------------------ ------------------------- ------------------- ------------------------------ ----- --- ----- -- - -- ----- - ------------------- - ---- - ------------------------- ----- -------------- - --- ----- ------------- - ------------------------------- ----- ---------- - ----------- -- ------------- -- -------- -- ------------------- ------------------ ----- ---------------------------- ----- ---------- - ----------------------- ----- --------- - ------------------------------------- ----- --------- - ------------------ -------------------------- ----- ---------- - - --------- ----- ------ ------- ------ ------- --------- ----- ------- ----- ------------ ----------------- -- ------------------ -------------------------- ------------------------------------------------------------------------ -------------------------- ------------------------ -------------------- ------- -- -- - -- ------- - --------------------- ------- - ---- - -------------------- -- ---------- -- -------- - - --
以上代码能够生成 protobuf 文件中定义的 Message
对象,并将其保存到 message_helper.json
文件中。同时,还能编译 helloworld.proto
文件并生成相应的代码。
总结
本文介绍了如何使用 npm 包 grpc_tools_node_protoc_ts
,包括命令行和 API 两种使用方式。通过该包,可以轻松创建可编程的通信架构。使用该工具可以提高编写 TypeScript 应用程序时的生产力,同时还能减少错误,提高代码的可维护性。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/5eedb658b5cbfe1ea0611504