protoc-gen-validate 簡介與使用指南
✅ 什麼是 protoc-gen-validate
protoc-gen-validate（簡稱 PGV）是一個 Protocol Buffers 插件，用於 在生成的 Go 代碼中添加結構體字段的驗證邏輯。
它通過在 .proto 文件中添加 validate 規則，自動爲每個字段生成驗證代碼，避免你手動寫驗證邏輯。
🌟 示例
syntax = "proto3";
import "validate/validate.proto";
message User {string name = 1 [(validate.rules).string.min_len = 3];
int32 age = 2 [(validate.rules).int32.gte = 18];
}
生成後的 Go 代碼中會自動包含：
user := &User{Name: "Tom", Age: 16}
if err := user.Validate(); err != nil {// err 會指出字段不符合要求}
✅ 支持的驗證規則類型
string:min_len,max_len,email,ip,uri,pattern等number:gte,lte,lt,gtrepeated:min_items,unique,items rulesmap:min_pairs,keys rules,values rulesmessage: 嵌套驗證oneof: 子字段驗證required: 字段是否必須
✅ 支持語言
- Go（官方最強支持）
- C++
- Java
- Python
- C#
- Rust（通過社區插件）
✅ 成熟度與使用建議
| 項目 | 說明 |
|---|---|
| 成熟度 | 非常成熟，在很多微服務項目中廣泛使用（如 buf.build 生態） |
| 社區支持 | 擁有活躍社區，已由原始作者轉移到 bufbuild 維護 |
| 與其他工具兼容 | 完美支持 protoc-gen-go，可搭配 buf, grpc-gateway, govalidator 等使用 |
| 適用場景 | 服務端字段校驗、API 請求校驗、微服務接口參數校驗 |
🛠 使用步驟（簡要）
- 安裝插件：
go install github.com/bufbuild/protoc-gen-validate@latest
- 下載 PGV 所需的 proto 文件定義：
git clone https://github.com/bufbuild/protoc-gen-validate
或使用 buf registry 引用：buf.build/buf/validate
- 編譯命令：
protoc \
--proto_path=./proto \
--go_out=. \
--go-grpc_out=. \
--validate_out=lang=go:. \
your_file.proto
📦 常見替代方案
| 工具 | 簡介 |
|---|---|
| cel | Google 出品的表達式語言，可用於 proto 校驗，但複雜度略高 |
| 手寫驗證 | 靈活但重複勞動，容易出錯 |
go-playground/validator |
通用 Go struct 校驗工具，不依賴 proto |
✅ 總結
protoc-gen-validate 是一個 成熟、穩定、易用 的 protobuf 字段驗證方案，特別適合：
- 微服務架構中的參數校驗
- 自動生成驗證邏輯
- 希望減少手寫重複驗證的項目團隊
正文完