feat(goctl/rpc): support external proto imports with cross-package ty… (#5472)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
kesonan
2026-03-22 12:01:20 +08:00
committed by GitHub
parent c12c82b2f6
commit 004995f06a
93 changed files with 4871 additions and 270 deletions

View File

@@ -0,0 +1,77 @@
# 示例 07外部 Proto — 相同 `go_package`
本示例演示从外部目录导入 proto 文件,且两个文件共享**相同**的 `go_package`
## Proto 定义
`service.proto``ext.proto` 使用相同的 `go_package`
```protobuf
option go_package = "example.com/demo/pb";
```
源码布局:
```
07-external-proto-same-pkg/
├── ext_protos
│ └── ext.proto # 外部 protogo_package = "example.com/demo/pb"
├── service.proto # 服务定义go_package = "example.com/demo/pb"
├── README.md
└── README-cn.md
```
- `ext.proto` 位于独立目录(`ext_protos/`),但与 `service.proto` 有相同的 `go_package`
- `service.proto` 导入 `ext.proto`,使用 `ext.ExtReq` / `ext.ExtReply` 作为 RPC 类型。
## 生成命令
首先,在输出目录中初始化 `go.mod`
```bash
mkdir -p output && cd output && go mod init example.com/demo && cd ..
```
然后生成代码(注意 `-I ./ext_protos`
```bash
goctl rpc protoc service.proto \
--go_out=output \
--go-grpc_out=output \
--zrpc_out=output \
--go_opt=module=example.com/demo \
--go-grpc_opt=module=example.com/demo \
--module=example.com/demo \
-I . -I ./ext_protos
```
生成的目录结构:
```
output/
├── etc
│ └── svc.yaml
├── go.mod
├── internal
│ ├── config
│ │ └── config.go
│ ├── logic
│ │ └── querylogic.go
│ ├── server
│ │ └── queryserviceserver.go
│ └── svc
│ └── servicecontext.go
├── pb
│ ├── ext.pb.go
│ ├── service.pb.go
│ └── service_grpc.pb.go
├── queryservice
│ └── queryservice.go
└── svc.go
```
## 要点说明
- `ext.proto` 位于独立目录(`ext_protos/`),但与 `service.proto` 有相同的 `go_package`
- 使用 `-I ./ext_protos` 将外部目录添加到 proto 搜索路径。
- 当外部 proto 有**相同**的 `go_package` 时,所有类型合并到一个 Go 包中——无需跨包导入。

View File

@@ -0,0 +1,77 @@
# Example 07: External Proto — Same `go_package`
This example demonstrates importing proto files from an external directory where both files share the **same** `go_package`.
## Proto Definition
Both `service.proto` and `ext.proto` use the same `go_package`:
```protobuf
option go_package = "example.com/demo/pb";
```
Source layout:
```
07-external-proto-same-pkg/
├── ext_protos
│ └── ext.proto # External proto (go_package = "example.com/demo/pb")
├── service.proto # Service definition (go_package = "example.com/demo/pb")
├── README.md
└── README-cn.md
```
- `ext.proto` lives in a separate directory (`ext_protos/`), but has the same `go_package` as `service.proto`.
- `service.proto` imports `ext.proto` and uses `ext.ExtReq` / `ext.ExtReply` as RPC types.
## Generation Commands
First, initialize the output directory with a `go.mod`:
```bash
mkdir -p output && cd output && go mod init example.com/demo && cd ..
```
Then generate the code (note `-I ./ext_protos`):
```bash
goctl rpc protoc service.proto \
--go_out=output \
--go-grpc_out=output \
--zrpc_out=output \
--go_opt=module=example.com/demo \
--go-grpc_opt=module=example.com/demo \
--module=example.com/demo \
-I . -I ./ext_protos
```
Generated directory structure:
```
output/
├── etc
│ └── svc.yaml
├── go.mod
├── internal
│ ├── config
│ │ └── config.go
│ ├── logic
│ │ └── querylogic.go
│ ├── server
│ │ └── queryserviceserver.go
│ └── svc
│ └── servicecontext.go
├── pb
│ ├── ext.pb.go
│ ├── service.pb.go
│ └── service_grpc.pb.go
├── queryservice
│ └── queryservice.go
└── svc.go
```
## Key Points
- `ext.proto` lives in a separate directory (`ext_protos/`), but has the same `go_package` as `service.proto`.
- Use `-I ./ext_protos` to add the external directory to the proto search path.
- When the external proto has the **same** `go_package`, all types merge into one Go package — no cross-package imports are needed.

View File

@@ -0,0 +1,14 @@
syntax = "proto3";
package ext;
option go_package = "example.com/demo/pb";
message ExtReq {
string key = 1;
}
message ExtReply {
string value = 1;
int32 code = 2;
}

View File

@@ -0,0 +1,11 @@
syntax = "proto3";
package svc;
option go_package = "example.com/demo/pb";
import "ext.proto";
service QueryService {
rpc Query(ext.ExtReq) returns (ext.ExtReply);
}