protoc-go-inject-tag 项目常见问题解决方案

protoc-go-inject-tag 项目常见问题解决方案

protoc-go-inject-tag Inject custom tags to protobuf golang struct 项目地址: https://gitcode.com/gh_mirrors/pr/protoc-go-inject-tag

项目基础介绍

protoc-go-inject-tag 是一个用于在生成的 Go 语言 protobuf 结构体中注入自定义标签的工具。该项目的主要编程语言是 Go。它允许开发者在生成的 protobuf 文件中添加自定义的 Go 标签，这些标签通常用于字段验证、JSON 数据字段的忽略等场景。

新手使用注意事项及解决方案

1. 安装 protobuf 和 Go 支持

问题描述: 新手在使用 protoc-go-inject-tag 时，可能会遇到 protobuf 和 Go 支持未正确安装的问题。

解决方案:

1. 安装 protobuf:

   • 对于 macOS 用户，可以使用 Homebrew 安装 protobuf：

     brew install protobuf
     

   • 对于其他操作系统，请参考 protobuf 官方文档进行安装。

2. 安装 Go 支持:

   • 确保 Go 环境已正确配置。然后运行以下命令安装 protobuf 的 Go 支持：

     go get -u github.com/golang/protobuf/proto
     go get -u github.com/golang/protobuf/protoc-gen-go
     

3. 安装 protoc-go-inject-tag:

   • 运行以下命令安装 protoc-go-inject-tag：

     go install github.com/favadi/protoc-go-inject-tag@latest
     

2. 生成 protobuf 文件时的路径问题

问题描述: 新手在生成 protobuf 文件时，可能会遇到路径配置错误的问题。

解决方案:

1. 指定正确的 proto 文件路径:

   • 在运行 protoc 命令时，确保 --proto_path 参数指向正确的 proto 文件目录。例如：

     protoc --proto_path=. --go_out=paths=source_relative:. test.proto
     

2. 指定生成的 Go 文件输出路径:

   • 使用 --go_out 参数指定生成的 Go 文件的输出路径。例如：

     protoc --proto_path=. --go_out=paths=source_relative:. test.proto
     

3. 注入自定义标签时的语法错误

问题描述: 新手在为 protobuf 字段添加自定义标签时，可能会遇到语法错误。

解决方案:

1. 正确添加自定义标签:

   • 在 protobuf 文件中，使用以下语法为字段添加自定义标签：

     // @gotags: custom_tag:"custom_value"
     string Address = 1;
     

2. 运行 protoc-go-inject-tag:

   • 生成 Go 文件后，运行 protoc-go-inject-tag 命令注入自定义标签：

     protoc-go-inject-tag -input=./test.pb.go
     

3. 检查生成的 Go 文件:

   • 确保生成的 Go 文件中包含自定义标签。例如：

     type IP struct {
         // @gotags: valid:"ip"
         Address string `protobuf:"bytes,1,opt,name=Address,json=address" json:"Address,omitempty" valid:"ip"`
     }
     

通过以上步骤，新手可以顺利使用 protoc-go-inject-tag 项目，并在生成的 Go 语言 protobuf 结构体中注入自定义标签。

protoc-go-inject-tag Inject custom tags to protobuf golang struct 项目地址: https://gitcode.com/gh_mirrors/pr/protoc-go-inject-tag