goctl-generated client code produces incorrect local path references in imports

[Meng-Xin]

环境信息

• goctl 版本: 1.9.2
• 操作系统: Windows 10
• Go 版本: 1.25.5

项目结构

zero-rpc/
├── go.work
├── sales-admin/ # RPC 服务端
│ ├── go.mod # module sales-admin
│ ├── protoc/
│ │ └── admin.proto
│ └── adminClient/
│ └── admin.go # goctl 生成的客户端代码
├── sales-app/ # 另一个 RPC 服务端
│ └── go.mod # module sales-app
└── sales-center/ # 中央 proto 仓库（存储公用桩代码）
├── go.mod # module sales-center
└── gen/
└── admin/
├── admin.pb.go
└── admin_grpc.pb.go

执行命令

在 sales-admin 目录下执行：
goctl rpc protoc protoc/admin.proto --go_out=../sales-center --go-grpc_out=../sales-center --zrpc_out=. --style=goZero

Proto 文件

syntax = "proto3";
package admin;
option go_package = "../sales-center/gen/admin";

service Admin {
rpc GetUser (GetUserReq) returns (GetUserResp);
}

问题现象

生成的 sales-admin/adminClient/admin.go 文件中，导入路径出现了错误的本地文件系统路径：

package adminClient

import (
"context"

  "sales-admin/F:/coding/learn/zero-rpc/sales-center/gen/admin"  // ❌ 错误：混合了模块名和本地路径

  "github.com/zeromicro/go-zero/zrpc"
  "google.golang.org/grpc"

)

期望行为

生成的导入路径应该是纯模块引用：
import (
"sales-center/gen/admin" // ✅ 正确：纯包引用
)

根本原因分析

1. option go_package 使用了相对路径 ../sales-center/gen/admin
2. goctl 在解析时，将本地文件系统绝对路径（F:/coding/learn/zero-rpc/sales-center/gen/admin）错误地拼接到当前模块名（sales-admin）后面
3. 正确行为应该是识别出输出目录 ../sales-center 属于 sales-center 模块，并使用该模块名作为导入前缀

临时解决方案

手动修改生成的 adminClient/admin.go，将导入路径改为：
"sales-center/gen/admin"

建议

在使用中央 proto 仓库模式时，option go_package 应支持或建议使用完整的模块路径格式，例如：
option go_package = "sales-center/gen/admin";

goctl 应该能够：

1. 识别 --go_out 输出目录所属的 Go 模块
2. 自动将包引用转换为正确的模块路径引用

[kevwan]

Thanks for the detailed report!

Translation of this issue: When using a central proto repository pattern with go.work, running goctl rpc protoc with option go_package = "../sales-center/gen/admin" (a relative path) causes the generated client code to produce a malformed import like "sales-admin/F:/coding/learn/zero-rpc/sales-center/gen/admin" — mixing the current module name with a Windows absolute filesystem path.

原文摘要：在使用中央 proto 仓库模式和 go.work 时，goctl 生成的客户端代码中出现了混合模块名和本地路径的错误导入。

---

Root Cause: goctl's proto parser stores the raw go_package value as-is without resolving relative paths to proper Go module import paths. When go_package contains a relative path like "../sales-center/gen/admin", it gets resolved to a filesystem absolute path and incorrectly concatenated with the current module name.

Workaround: Use an absolute module path in the go_package option instead of a relative path:

// ❌ Relative path — causes malformed imports
option go_package = "../sales-center/gen/admin";

// ✅ Full module path — works correctly
option go_package = "sales-center/gen/admin";

Then run:

goctl rpc protoc protoc/admin.proto \
  --go_out=../sales-center --go-grpc_out=../sales-center --zrpc_out=. --style=goZero

Since you're using go.work, the module sales-center is already locally resolvable, so the generated import "sales-center/gen/admin" will work correctly.

Note: protoc itself accepts relative paths in go_package to determine the output directory, but goctl additionally uses the go_package value to construct Go import paths in generated code — that's where the mismatch happens. Using the full module path works for both purposes.

---

For better international collaboration, we encourage writing issues in English. Thank you! 🙏

[kevwan]

Thank you for this detailed bug report!

Translation / English summary:

The issue occurs when using goctl rpc protoc with a central proto repository pattern (common in Go workspace/multi-module setups). When --go_out / --go-grpc_out point to a sibling module outside the current module, goctl incorrectly constructs the import path by concatenating the current module name with the absolute disk path, producing imports like:

"sales-admin/F:/coding/learn/zero-rpc/sales-center/gen/admin"  // ❌ invalid

Instead of the correct:

"sales-center/gen/admin"  // ✅

Original (原文): 项目结构在 Go workspace 下，--go_out 指向的是另一个 module (sales-center)，但 goctl 将本机绝对路径错误地拼接到当前模块名后面，生成了无效的导入路径。

---

A fix is available in PR #5552, which detects when the pb output directory belongs to a different Go module and correctly uses that module's name as the import prefix.

Workaround (until merged): Manually edit the generated adminClient/admin.go and change the import path from "sales-admin/F:/..." to the correct module path "sales-center/gen/admin". Also, use the full module path format in your proto file:

option go_package = "sales-center/gen/admin";

instead of a relative path like ../sales-center/gen/admin.

Please also consider writing in English for future issues to help the broader community participate — thank you!