NodeJS?GRPC?多個?.proto?文件的處理步驟

更新時間：2024年10月16日 10:04:53 作者：田猿筆記

本文教程詳細介紹了在NodeJS環(huán)境中如何使用gRPC框架處理多個.proto文件,步驟包括安裝依賴、定義.proto文件、生成gRPC代碼、實現(xiàn)服務器和客戶端以及運行,適用于開發(fā)者在構建分布式應用時進行接口定義和服務實現(xiàn)

1. 安裝依賴

首先，確保你已經(jīng)安裝了 grpc-tools 和 grpc_tools_node_protoc_ts：

npm install grpc-tools grpc_tools_node_protoc_ts --save-dev

2. 定義 .proto 文件

假設我們有兩個 .proto 文件：service_a.proto 和 service_b.proto。

service_a.proto：

syntax = "proto3";
package myproject;
service ServiceA {
  rpc Method1 (Request1) returns (Response1) {}
  rpc Method2 (Request2) returns (Response2) {}
}
message Request1 { string name = 1; }
message Response1 { string message = 1; }
message Request2 { string name = 1; }
message Response2 { string message = 1; }

service_b.proto：

syntax = "proto3";
package myproject;
service ServiceB {
  rpc Method3 (Request3) returns (Response3) {}
  rpc Method4 (Request4) returns (Response4) {}
}
message Request3 { string name = 1; }
message Response3 { string message = 1; }
message Request4 { string name = 1; }
message Response4 { string message = 1; }

3. 生成 gRPC 代碼

使用 npx grpc_tools_node_protoc 生成 gRPC 代碼，并指定輸出目錄：

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

生成文件解釋

運行上述命令后，將在 ./generated 目錄中生成以下文件：

service_a_pb.js 和 service_b_pb.js：

包含 Protocol Buffers 消息的定義和序列化/反序列化邏輯。
定義了 .proto 文件中聲明的消息類型，并提供了相應的 getter 和 setter 方法。
service_a_grpc_pb.js 和 service_b_grpc_pb.js：
包含 gRPC 服務的客戶端和服務器端的接口定義。
定義了服務的方法，并提供了用于調(diào)用這些方法的客戶端和服務器端的代碼。

4. 實現(xiàn)服務器

創(chuàng)建 server.js 文件，包含服務的實現(xiàn)：

const grpc = require('@grpc/grpc-js');
const serviceAProto = require('./generated/service_a_grpc_pb');
const serviceAMessages = require('./generated/service_a_pb');
const serviceBProto = require('./generated/service_b_grpc_pb');
const serviceBMessages = require('./generated/service_b_pb');
function method1(call, callback) {
  const reply = new serviceAMessages.Response1();
  reply.setMessage('Response from Method1: ' + call.request.getName());
  callback(null, reply);
}
function method2(call, callback) {
  const reply = new serviceAMessages.Response2();
  reply.setMessage('Response from Method2: ' + call.request.getName());
  callback(null, reply);
}
function method3(call, callback) {
  const reply = new serviceBMessages.Response3();
  reply.setMessage('Response from Method3: ' + call.request.getName());
  callback(null, reply);
}
function method4(call, callback) {
  const reply = new serviceBMessages.Response4();
  reply.setMessage('Response from Method4: ' + call.request.getName());
  callback(null, reply);
}
function main() {
  const server = new grpc.Server();
  server.addService(serviceAProto.ServiceAService, { method1: method1, method2: method2 });
  server.addService(serviceBProto.ServiceBService, { method3: method3, method4: method4 });
  server.bindAsync('0.0.0.0:50051', grpc.ServerCredentials.createInsecure(), () => {
    server.start();
  });
}
main();

5. 實現(xiàn)客戶端

創(chuàng)建 client.js 文件，包含客戶端的實現(xiàn)：

const grpc = require('@grpc/grpc-js');
const serviceAProto = require('./generated/service_a_grpc_pb');
const serviceAMessages = require('./generated/service_a_pb');
const serviceBProto = require('./generated/service_b_grpc_pb');
const serviceBMessages = require('./generated/service_b_pb');
function main() {
  const clientA = new serviceAProto.ServiceAClient('localhost:50051', grpc.credentials.createInsecure());
  const clientB = new serviceBProto.ServiceBClient('localhost:50051', grpc.credentials.createInsecure());
  const request1 = new serviceAMessages.Request1();
  request1.setName('World');
  clientA.method1(request1, (err, response) => {
    if (err) console.error(err);
    else console.log('Response from Method1:', response.getMessage());
  });
  const request3 = new serviceBMessages.Request3();
  request3.setName('World');
  clientB.method3(request3, (err, response) => {
    if (err) console.error(err);
    else console.log('Response from Method3:', response.getMessage());
  });
}
main();