Go工程师体系课 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, gt
• repeated: min_items, unique, items rules
• map: min_pairs, keys rules, values rules
• message: 嵌套验证
• oneof: 子字段验证
• required: 字段是否必须

---

✅ 支持语言

• Go（官方最强支持）
• C++
• Java
• Python
• C#
• Rust（通过社区插件）

---

✅ 成熟度与使用建议

项目	说明
成熟度	非常成熟，在很多微服务项目中广泛使用（如 buf.build 生态）
社区支持	拥有活跃社区，已由原始作者转移到 bufbuild 维护
与其他工具兼容	完美支持 protoc-gen-go，可搭配 buf, grpc-gateway, govalidator 等使用
适用场景	服务端字段校验、API 请求校验、微服务接口参数校验

---

🛠 使用步骤（简要）

1. 安装插件：

go install github.com/bufbuild/protoc-gen-validate@latest

1. 下载 PGV 所需的 proto 文件定义：

git clone https://github.com/bufbuild/protoc-gen-validate

或使用 buf registry 引用：buf.build/buf/validate

1. 编译命令：

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 字段验证方案，特别适合：

• 微服务架构中的参数校验
• 自动生成验证逻辑
• 希望减少手写重复验证的项目团队