如何调试protoc插件？（或修复protoc-gen-bq-schema插件）

1. 验证插件架构兼容性 #

M3 Mac为ARM64架构，先确认插件是原生ARM64编译版本：

• 执行以下命令查看插件架构：

  file $(which protoc-gen-bq-schema)
  

  输出需包含arm64，若显示x86_64，说明是通过Rosetta兼容运行，存在潜在兼容性问题。需重新用ARM64版本的Go编译插件：
  先确认Go架构：

  go env GOARCH
  

  输出应为arm64，再执行编译：

  go install github.com/GoogleCloudPlatform/protoc-gen-bq-schema@latest
  

2. 启用protoc详细调试日志 #

protoc自带隐藏调试参数，可捕获插件交互的完整过程：

• 执行命令时添加日志参数，并将错误输出重定向到文件：

  protoc --bq-schema_out . -I <proto包路径> <proto文件路径> --debug=plugin 2>&1 > protoc_debug.log
  

  查看生成的protoc_debug.log，可获取插件是否被找到、启动状态、通信过程等细节。

3. 手动模拟protoc与插件的通信流程 #

protoc通过标准输入输出与插件交互，可手动拆分步骤排查：

1. 让protoc生成插件所需的请求数据：

   protoc --bq-schema_out . -I <proto包路径> <proto文件路径> --dry-run --descriptor_set_out=request.pb
   

2. 将请求数据直接传给插件，观察输出：

   cat request.pb | protoc-gen-bq-schema --bq-schema_out .
   

   若此步骤有输出/报错，说明是protoc传递数据环节的问题；若仍无输出，尝试给插件添加 verbose 参数（若支持）：

   cat request.pb | protoc-gen-bq-schema --bq-schema_out . -v
   

4. 检查输出路径与权限 #

确认当前目录有写入权限，尝试指定绝对输出路径排查路径问题：

protoc --bq-schema_out /绝对输出路径 -I <proto包路径> <proto文件路径>

同时检查macOS隐私设置是否阻止插件写入文件。

5. 用极简Proto文件测试 #

排除复杂消息结构导致的插件静默失败：
创建test.proto：

syntax = "proto3";
message TestMessage {
  string name = 1;
  int32 age = 2;
}

执行生成命令：

protoc --bq-schema_out . -I . test.proto

若此命令能正常生成Schema，说明原Proto的复杂结构（如oneof、嵌套消息、自定义选项等）在ARM64环境下触发了插件bug，需逐步拆解排查。

内容的提问来源于stack exchange，提问作者Mike Williamson