引入google.protobuf的Proto文件在NodeJS中使用时出现问题

Hey，我帮你搞定Node.js里用这个带google.protobuf依赖的proto文件的问题，大概率是依赖没装全或者加载配置不对，咱们一步步来解决：

1. 先装对必要的依赖 #

首先得把Node.js端gRPC和protobuf相关的包装全，别漏了google官方的protobuf类型定义包：

npm install @grpc/grpc-js @grpc/proto-loader google-protobuf

这里用@grpc/grpc-js是因为它是gRPC官方推荐的纯JS实现，比旧的grpc包更活跃、兼容性更好。

2. 正确加载Proto文件（关键！） #

问题大多出在加载proto时没指定google protobuf文件的搜索路径——你的proto里引入了google/protobuf/duration.proto和empty.proto，加载工具得知道这些文件在哪。

用@grpc/proto-loader加载的话，一定要配置includeDirs指向google-protobuf包的src目录，下面是完整的客户端代码示例：

const grpc = require('@grpc/grpc-js');
const protoLoader = require('@grpc/proto-loader');
const path = require('path');
// 可选：如果要操作Duration类型，引入官方的类
const { Duration } = require('google-protobuf/google/protobuf/duration_pb');

// 加载proto文件，核心是includeDirs配置
const packageDefinition = protoLoader.loadSync(
  path.resolve(__dirname, 'tech.proto'), // 你的proto文件路径
  {
    keepCase: true,
    longs: String,
    enums: String,
    defaults: true,
    oneofs: true,
    // 告诉loader去哪找google的proto文件
    includeDirs: [path.resolve(__dirname, 'node_modules/google-protobuf/src')]
  }
);

// 初始化客户端
const apiPackage = grpc.loadPackageDefinition(packageDefinition).api;
const techClient = new apiPackage.Tech('localhost:50051', grpc.credentials.createInsecure());

// 调用BasicInfo接口
techClient.BasicInfo({}, (err, res) => {
  if (err) {
    console.error('调用失败:', err);
    return;
  }
  console.log('获取到的描述:', res.desc);
  // 处理Duration类型：返回的res.ttl是包含seconds和nanos的对象
  console.log('TTL时长:', res.ttl.seconds + '秒', res.ttl.nanos + '纳秒');
  
  // 可选：转成官方Duration实例做更多操作
  const ttlDuration = Duration.fromObject(res.ttl);
  console.log('TTL转成字符串:', ttlDuration.toString());
});

3. 如果你用protoc手动编译（不推荐，但也说下） #

要是你习惯用protoc把proto编译成JS文件，记得加-I参数指定google protobuf的路径：

# 先确保装了grpc-tools：npm install -g grpc-tools
protoc --js_out=import_style=commonjs,binary:. \
  --grpc_out=. \
  --plugin=protoc-gen-grpc=`which grpc_tools_node_protoc_plugin` \
  -I. \
  -I./node_modules/google-protobuf/src \
  tech.proto

编译后就能直接引入生成的JS文件使用，但这种方式不如proto-loader灵活，推荐用loader的方式。

常见坑点排查 #

• 要是遇到"Could not find google/protobuf/empty.proto"错误，百分百是includeDirs路径配错了，检查下node_modules/google-protobuf/src是否存在，路径是否正确。
• 确保Node.js版本是LTS（比如16.x及以上），避免包兼容性问题。
• 确认gRPC服务器的地址和端口没错，客户端能正常连通服务器。

内容的提问来源于stack exchange，提问作者Semper Virens