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,71 @@
#!/usr/bin/env bash
# Scenario 05: compare old vs new goctl output — multiple services (--multiple mode)
# Usage: bash compare.sh
# Requires: go install github.com/zeromicro/go-zero/tools/goctl@latest (auto-installed)
set -e
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
GOCTL_ROOT="$(cd "$SCRIPT_DIR/../../../.." && pwd)"
NEW_GOCTL="$GOCTL_ROOT/bin/goctl"
OLD_GOCTL="$(go env GOPATH)/bin/goctl"
OUT_OLD="$SCRIPT_DIR/output_old"
OUT_NEW="$SCRIPT_DIR/output_new"
verify_build() {
local dir="$1" label="$2"
echo "Verifying $label ..."
cd "$dir"
go mod tidy
if go build ./...; then
echo "$label: build passed"
else
echo "$label: build failed"
exit 1
fi
cd "$SCRIPT_DIR"
}
# Install released goctl and build local goctl
echo ">>> Installing goctl@latest ..."
go install github.com/zeromicro/go-zero/tools/goctl@latest
echo ">>> Building local goctl ..."
go build -o "$NEW_GOCTL" "$GOCTL_ROOT"
# Generate with old goctl
echo ">>> Generating with old goctl ..."
rm -rf "$OUT_OLD" && mkdir -p "$OUT_OLD/pb"
(cd "$OUT_OLD" && go mod init example.com/demo/s05_multiple > /dev/null 2>&1)
cd "$SCRIPT_DIR"
"$OLD_GOCTL" rpc protoc multi.proto \
--go_out="$OUT_OLD/pb" \
--go-grpc_out="$OUT_OLD/pb" \
--zrpc_out="$OUT_OLD/rpc" \
--go_opt=paths=source_relative \
--go-grpc_opt=paths=source_relative \
--proto_path=. \
--multiple
verify_build "$OUT_OLD" "old"
# Generate with new goctl
echo ">>> Generating with new goctl ..."
rm -rf "$OUT_NEW" && mkdir -p "$OUT_NEW/pb"
(cd "$OUT_NEW" && go mod init example.com/demo/s05_multiple > /dev/null 2>&1)
cd "$SCRIPT_DIR"
"$NEW_GOCTL" rpc protoc multi.proto \
--go_out="$OUT_NEW/pb" \
--go-grpc_out="$OUT_NEW/pb" \
--zrpc_out="$OUT_NEW/rpc" \
--go_opt=paths=source_relative \
--go-grpc_opt=paths=source_relative \
--proto_path=. \
--multiple
verify_build "$OUT_NEW" "new"
# Diff old vs new (exclude go.mod / go.sum)
echo ""
echo ">>> Diff (old vs new):"
if diff -rq --exclude="go.mod" --exclude="go.sum" "$OUT_OLD" "$OUT_NEW" > /dev/null 2>&1; then
echo " [identical] no differences between old and new output"
else
diff -r --exclude="go.mod" --exclude="go.sum" "$OUT_OLD" "$OUT_NEW" || true
fi

View File

@@ -0,0 +1,40 @@
#!/usr/bin/env bash
# Scenario 05: multiple services (--multiple mode)
# Usage: bash gen.sh
set -e
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
GOCTL_ROOT="$(cd "$SCRIPT_DIR/../../../.." && pwd)"
GOCTL="$GOCTL_ROOT/bin/goctl"
OUT="$SCRIPT_DIR/output"
# Build goctl from source
go build -o "$GOCTL" "$GOCTL_ROOT"
# Clean and initialize output directory
rm -rf "$OUT" && mkdir -p "$OUT/pb"
(cd "$OUT" && go mod init example.com/demo/s05_multiple > /dev/null 2>&1)
# Generate code
cd "$SCRIPT_DIR"
"$GOCTL" rpc protoc multi.proto \
--go_out="$OUT/pb" \
--go-grpc_out="$OUT/pb" \
--zrpc_out="$OUT/rpc" \
--go_opt=paths=source_relative \
--go-grpc_opt=paths=source_relative \
--proto_path=. \
--multiple
# Verify build
echo "Running go mod tidy..."
cd "$OUT" && go mod tidy
echo "Checking build..."
if go build ./...; then
echo "✅ Build passed"
else
echo "❌ Build failed"
exit 1
fi
echo "Done. Output: $OUT"

View File

@@ -0,0 +1,35 @@
syntax = "proto3";
// 场景05多 service + import使用 --multiple 模式
// 预期goctl --multiple 应同时生成 shared.pb.go 和 multi.pb.go
package multisvc;
option go_package = "example.com/demo/s05_multiple/pb";
import "shared.proto";
message SearchReq {
shared.Meta meta = 1;
string keyword = 2;
}
message SearchReply {
repeated string items = 1;
}
message NotifyReq {
shared.Meta meta = 1;
string message = 2;
}
message NotifyReply {
bool ok = 1;
}
service SearchService {
rpc Search(SearchReq) returns (SearchReply);
}
service NotifyService {
rpc Notify(NotifyReq) returns (NotifyReply);
}

View File

@@ -0,0 +1,11 @@
syntax = "proto3";
// 场景05多 service 场景共享的基础类型
package shared;
option go_package = "example.com/demo/s05_multiple/pb";
message Meta {
string trace_id = 1;
string version = 2;
}