NodeJS 利用代码生成工具编写GRPC

生成的 gRPC 代码优点

1. 自动化和效率：

   • 减少手动编码：生成代码自动处理了消息的序列化和反序列化、服务接口的定义等，减少了手动编码的工作量。
   • 一致性：生成的代码确保了客户端和服务器之间的一致性，避免了手动编码可能带来的错误。

2. 跨语言支持：

   • 多语言兼容：gRPC 支持多种编程语言，通过生成的代码，不同语言的客户端和服务器可以无缝地进行通信。
   • 简化集成：你可以使用相同的 .proto 文件为不同语言生成代码，简化了跨语言系统的集成。

3. 高效的序列化：

   • 性能优化：Protocol Buffers 提供了高效的二进制序列化格式，比 JSON 或 XML 更加紧凑和高效。
   • 自动处理：生成的代码自动处理消息的序列化和反序列化，提高了性能和开发效率。

4. 内置功能：

   • 负载均衡和重试机制：gRPC 提供了内置的负载均衡和重试机制，生成的代码会自动包含这些功能，帮助你构建更加健壮和可靠的分布式系统。

1. 定义 .proto 文件

首先，创建一个 .proto 文件，定义服务和消息：

syntax = "proto3";

package helloworld;

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

message HelloRequest {
  string name = 1;
}

message HelloReply {
  string message = 1;
}

2. 生成 gRPC 代码

2.1 安装依赖

首先，确保你已经安装了 grpc-tools 和 grpc_tools_node_protoc_ts：

npm install grpc-tools grpc_tools_node_protoc_ts --save-dev

使用 `protoc` 编译器生成 gRPC 代码：

```sh
npx grpc_tools_node_protoc --js_out=import_style=commonjs,binary:. --grpc_out=grpc_js:. --proto_path=. helloworld.proto

这将生成两个文件：helloworld_pb.js 和 helloworld_grpc_pb.js。

2.2 protoc 指令说明

基本指令结构

npx grpc_tools_node_protoc 基本指令结构如下：

npx grpc_tools_node_protoc [OPTIONS] PROTO_FILES

选项解释

1. --proto_path：

   • 指定 .proto 文件的搜索路径。如果你的 .proto 文件在当前目录，可以使用 --proto_path=.。
   • 例如：--proto_path=.

2. --js_out：

   • 指定生成 JavaScript 代码的输出目录和样式。
   • import_style=commonjs,binary 表示生成 CommonJS 模块格式的代码，并使用二进制序列化。
   • 例如：--js_out=import_style=commonjs,binary:./generated

3. --grpc_out：

   • 指定生成 gRPC 代码的输出目录。
   • grpc_js 表示生成 gRPC 的 JavaScript 代码。
   • 例如：--grpc_out=grpc_js:./generated

示例指令

假设你有两个 .proto 文件：service_a.proto 和 service_b.proto，并且希望将生成的代码放在 ./generated 目录中，可以使用以下指令：

npx grpc_tools_node_protoc --proto_path=. --js_out=import_style=commonjs,binary:./generated --grpc_out=grpc_js:./generated service_a.proto
npx grpc_tools_node_protoc --proto_path=. --js_out=import_style=commonjs,binary:./generated --grpc_out=grpc_js:./generated service_b.proto

生成文件解释

运行上述指令后，将在 ./generated 目录中生成以下文件：

1. service_a_pb.js 和 service_b_pb.js：

   • 包含 Protocol Buffers 消息的定义和序列化/反序列化逻辑。
   • 定义了 .proto 文件中声明的消息类型，并提供了相应的 getter 和 setter 方法。

2. service_a_grpc_pb.js 和 service_b_grpc_pb.js：

   • 包含 gRPC 服务的客户端和服务器端的接口定义。
   • 定义了服务的方法，并提供了用于调用这些方法的客户端和服务器端的代码。

使用生成的文件

在你的服务器和客户端代码中，你需要导入这些生成的文件。例如：