Node.js 使用 gRPC从定义到实现过程详解

rpc SayHello(HelloRequest) returns (HelloResponse) {}

rpc SayHello(HelloRequest) returns (stream HelloResponse) {}

rpc SayHello(stream HelloRequest) returns (HelloResponse) {}

rpc SayHello(stream HelloRequest) returns (stream HelloResponse) {}

// 使用 proto3 语法，不指定的话默认 proto2
syntax = "proto3";
// 是否需要生成的类拆分为多个
option java_multiple_files = true;
// 生成的类所属的层级
option java_package = "io.grpc.examples.helloworld";
option java_outer_classname = "HelloWorldProto";
option objc_class_prefix = "HLW";
// 定义报名，并于避免命名冲突
package helloworld;
// 定义服务
service Greeter {
  // 定义：
  //   1. 参数
  //   2. 返回类型
  rpc SayHello (HelloRequest) returns (HelloReply) {}
  rpc SayHelloStreamReply (HelloRequest) returns (stream HelloReply) {}
}
// 结构化数据：使用 message 定义。
message HelloRequest {
  string name = 1; // 字段类型 字段名 = 字段编号;
}
message HelloReply {
  string message = 1;
}

// Protocol Buffers 文件
let PROTO_PATH = __dirname + './helloworld.proto';
// 用户实现 gRPC 服务和客户端的核心库
let grpc = require('@grpc/grpc-js');
// 加载 .proto 文件
let protoLoader = require('@grpc/proto-loader');
/**
 * protoLoader.loadSync(PROTO_PATH, { ... }) 方法
 * 从指定的 .proto 文件加载定义，并根据选项配置进行解析。
 * 使用到 protoLoader 一个 Node.js 模块
 */
let packageDefinition = protoLoader.loadSync(
  PROTO_PATH,
  {
    keepCase: true, // 保持字段名称的大小写
    longs: String, // 将 Protocol Buffers 中的 long 类型字段解析为 JavaScript 字符串
    enums: String, // 将枚举类型转换为字符串
    defaults: true, // 为所有字段设置默认值
    oneofs: true // 支持 oneof 字段，这是一种在 Protocol Buffers 中定义的互斥字段
  });
/**
 * grpc.loadPackageDefinition(packageDefinition) 方法
 * 将 @grpc/proto-loader 生成的描述加载到 gRPC 库中，
 * 将加载的 Protocol Buffers 描述转换为 gRPC 服务端可以使用的 JavaScript 对象。
 * 以创建客户端和服务端。
 */
let hello_proto = grpc.loadPackageDefinition(packageDefinition).helloworld;
/**
 * 定义 RPC 的方法
 */
function sayHello(call, callback) {
  callback(null, { message: 'Hello ' + call.request.name });
}
function main() {
  // 1. 创建 gRPC 服务器实例
  let server = new grpc.Server();
  // 2. 将 Greeter 服务和实现方法添加到 gRPC 服务器中
  server.addService(hello_proto.Greeter.service, { sayHello: sayHello });
  /**
   * 3. 绑定服务器到指定的地址和端口，并使用不安全的凭据（没有 SSL/TLS）
   *    grpc.ServerCredentials.createInsecure(): 创建不安全的服务器凭据
   */
  server.bindAsync('0.0.0.0:50051', grpc.ServerCredentials.createInsecure(), (err, port) => {
    if (err != null) {
      return console.error(err);
    }
    console.log(`gRPC listening on ${port}`)
  });
}
main();

let PROTO_PATH = __dirname + './helloworld.proto';
// 用户实现 gRPC 服务和客户端的核心库
let grpc = require('@grpc/grpc-js');
// 加载 .proto 文件
let protoLoader = require('@grpc/proto-loader');
// 加载 .proto 文件，并且根据配置项进行解析
let packageDefinition = protoLoader.loadSync(
  PROTO_PATH,
  {
    keepCase: true, // 保持字段名称的大小写
    longs: String, // 将 Protocol Buffers 中的 long 类型字段解析为 JS 字符串
    enums: String, // 将枚举类型转换为字符串
    defaults: true, // 为所有字段设置默认值
    oneofs: true // 支持 oneof 字段
  });
// 将生成的描述添加到 gRPC 库中，并输入可以使用的 JS 对象，来创建服务端和客户端
let hello_proto = grpc.loadPackageDefinition(packageDefinition).helloworld;
function main() {
  // 定义 gRPC 服务器的地址和端口
  let target = 'localhost:50051';
  // 创建一个客户端存根，存根(抽象层)：hello_proto.Greeter，来调用远程服务
  let client = new hello_proto.Greeter(target,
    grpc.credentials.createInsecure());
  let user = 'world';
  // 调用远程服务方法
  client.sayHello({ name: user }, function (err, response) {
    console.log('Greeting:', response.message);
  });
}
main();