问题描述
这是我项目的src
目录的结构:
.
├── config.ts
├── protos
│ ├── index.proto
│ ├── index.ts
│ ├── share
│ │ ├── topic.proto
│ │ ├── topic_pb.d.ts
│ │ ├── user.proto
│ │ └── user_pb.d.ts
│ ├── topic
│ │ ├── service.proto
│ │ ├── service_grpc_pb.d.ts
│ │ ├── service_pb.d.ts
│ │ ├── topic.integration.test.ts
│ │ ├── topic.proto
│ │ ├── topicServiceImpl.ts
│ │ ├── topicServiceImplDynamic.ts
│ │ └── topic_pb.d.ts
│ └── user
│ ├── service.proto
│ ├── service_grpc_pb.d.ts
│ ├── service_pb.d.ts
│ ├── user.proto
│ ├── userServiceImpl.ts
│ └── user_pb.d.ts
└── server.ts
share/user.proto
:
Syntax = "proto3";
package share;
message UserBase {
string loginname = 1;
string avatar_url = 2;
}
topic/topic.proto
:
Syntax = "proto3";
package topic;
import "share/user.proto";
enum Tab {
share = 0;
ask = 1;
good = 2;
job = 3;
}
message Topic {
string id = 1;
string author_id = 2;
Tab tab = 3;
string title = 4;
string content = 5;
share.UserBase author = 6;
bool good = 7;
bool top = 8;
int32 reply_count = 9;
int32 visit_count = 10;
string create_at = 11;
string last_reply_at = 12;
}
如您所见,我尝试导入share
程序包并在UserBase
消息类型中使用Topic
消息类型。当我尝试启动服务器时,出现错误:
.topic.Topic类型中没有此类Type或Enum'share.UserBase'
但是当我将包导入路径更改为相对路径import "../share/user.proto";
时。它工作正常,并获得服务器日志:Server is listening on http://localhost:3000
。
现在,我切换到使用静态代码生成器,这是用于生成代码的shell脚本:
protoc \
--plugin=protoc-gen-ts=./node_modules/.bin/protoc-gen-ts \
--ts_out=./src/protos \
-I ./src/protos \
./src/protos/**/*.proto
../share/user.proto: Backslashes,consecutive slashes,".",or ".." are not allowed in the virtual path
然后,我将包导入路径更改回import "share/user.proto";
。它正确生成了代码,但是当我尝试启动服务器时,出现了相同的错误:
.topic.Topic类型中没有此类Type或Enum'share.UserBase'
这很奇怪。
打包版本:
"grpc-tools": "^1.6.6","grpc_tools_node_protoc_ts": "^4.1.3",
protoc --version
libprotoc 3.10.0
更新:
回购:https://github.com/mrdulin/nodejs-grpc/tree/master/src
解决方法
您的动态代码生成失败,因为您未指定搜索导入的.proto
文件的路径。您可以在调用includeDirs
时使用protoLoader.loadSync
选项来执行此操作,其工作方式与传递给-I
的{{1}}选项非常相似。在这种情况下,您将从protoc
目录中加载原型文件,因此只需传递选项src/protos
就足够了。然后,includeDirs: [__dirname]
文件中的导入路径应相对于该目录,就像使用.proto
时一样。
当您尝试使用静态代码生成时,您可能会看到相同的错误,因为它实际上是动态代码生成错误。在尝试使用静态生成的代码时,您似乎并没有删除动态代码生成代码。
但是,静态生成的代码将面临的主要问题是仅生成TypeScript类型定义文件。您还需要生成JavaScript文件才能实际运行它。 protoc
的官方Node gRPC插件在proto
软件包中分发。它带有一个名为grpc-tools
的二进制文件,应代替grpc_tools_node_protoc
使用该二进制文件,并自动包含该插件。您仍然需要传递protoc
标志来生成该代码。