如何在Golang工程中使用Protoc-gen-validate校验参数-Golang-PHP中文网

protoc-gen-validate生成的校验代码默认不生效，因其仅生成validate()方法而未自动拦截请求，需手动调用或配合中间件；grpc中须在服务端显式执行req.validate()，http+grpc-gateway需启用withvalidateenabled()并正确配置proto注解。

如何在golang工程中使用protoc-gen-validate校验参数

Protoc-gen-validate 生成的校验代码为什么没生效

默认情况下，protoc-gen-validate 生成的校验逻辑只存在于结构体方法中（如 Validate()），不会自动拦截 gRPC 请求或 HTTP 绑定参数。你得主动调用它，或者配合中间件/拦截器使用。

常见错误：定义了 validate = true 字段但没调用 msg.Validate()，导致校验完全不触发

gRPC 场景下，必须在 server 实现里手动调用，例如：

if err := req.Validate(); err != nil {
    return nil, status.Error(codes.InvalidArgument, err.Error())
}

HTTP+gRPC-Gateway 场景下，需启用 WithValidateEnabled() 选项，并确保 proto 文件中字段已加 (validate.rules) 注解

如何正确安装和启用 protoc-gen-validate

新版（v0.10+）不再内置到 protoc-gen-go，必须单独安装插件并显式调用。

安装命令：

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

生成时必须显式添加插件参数：

protoc --go_out=. --go-grpc_out=. --validate_out="lang=go:." *.proto

注意 --validate_out 的路径必须与 --go_out 一致，否则生成的 Validate() 方法无法找到对应 struct
若用 buf 工具，需在 buf.gen.yaml 中声明：
```
plugins:
  - name: validate
    out: gen/proto
```

validate.rules 常见写法和易错点

校验规则写在 proto 字段的 option 里，语法看似简单，但几个细节不注意就会静默失效。

Golang Naming

Go（Golang）命名规范 — 包括包、构造函数、结构体、接口、常量、枚举、错误、布尔值、接收器、getter/setter、函数等。

下载

string 长度校验必须用 min_len/max_len，不是 min/max：

string name = 1 [(validate.rules).string = {min_len: 1, max_len: 50}];

repeated 字段要校验元素个数，用 min_items/max_items；要校验每个元素，需嵌套 rule：

repeated string tags = 2 [(validate.rules).repeated = {min_items: 1, max_items: 10, items: {string: {min_len: 1}}}];

自定义 message 类型必须也加 (validate.rules)，否则其内部字段不参与递归校验
空值（nil）对 optional 字段不触发校验，若需强制非空，用 required 或显式检查 has_XXX 字段

与 gRPC-Gateway 结合时的坑

HTTP 请求经过 gRPC-Gateway 转发后，校验行为和原生 gRPC 不同——它默认不调用 Validate()，也不解析 query/path 参数中的嵌套结构。

必须初始化 gateway mux 时启用验证：
```
runtime.WithValidateEnabled()
```
query 参数只支持一级字段映射，比如 ?name=abc 可绑定到 message.name，但 ?user.name=abc 会丢失
JSON body 中的嵌套对象能被校验，但要注意 json_name 和 proto 字段名不一致时，Validate() 检查的是 proto 字段名，不是 JSON key
错误返回是 400 Bad Request，但默认 error message 是原始 validation error 字符串，建议用 status.FromError() 提取 code