protoc-gen-validate 使用教程

最新推荐文章于 2025-01-21 09:53:09 发布

缪昱锨Hunter

最新推荐文章于 2025-01-21 09:53:09 发布

阅读量792

点赞数 22

本文链接：https://blog.csdn.net/gitblog_00029/article/details/139877059

版权

protoc-gen-validate 使用教程

protoc-gen-validate Protocol Buffer Validation - Being replaced by github.com/bufbuild/protovalidate 项目地址: https://gitcode.com/gh_mirrors/pr/protoc-gen-validate

1. 项目介绍

protoc-gen-validate（PGV）是一个用于生成多语言消息验证器的 protoc 插件。虽然 Protocol Buffers 能够有效地保证数据的类型，但它们无法强制执行值的语义规则。这个插件通过在生成的代码中添加验证支持，来解决这个问题。开发者可以在 .proto 文件中使用 PGV 扩展，并通过注解来定义字段值的约束规则。

PGV 目前处于维护模式，推荐新项目和现有项目迁移到 protovalidate。

2. 项目快速启动

安装依赖

首先，确保你已经安装了以下依赖：

Go 工具链（≥ v1.7）
protoc 编译器
protoc-gen-validate 插件
目标语言的官方插件

下载并安装 PGV

你可以从 GitHub Releases 下载预编译的二进制文件，或者从源码构建：

# 从源码构建
go get -d github.com/envoyproxy/protoc-gen-validate
cd $GOPATH/src/github.com/envoyproxy/protoc-gen-validate
make build

生成验证代码

假设你有一个名为 example.proto 的文件，你可以使用以下命令生成验证代码：

protoc \
  -I . \
  -I path/to/validate/ \
  --go_out=":.generated" \
  --validate_out="lang=go:.generated" \
  example.proto

生成的代码将包含 Validate() 和 ValidateAll() 方法，用于验证消息的有效性。

3. 应用案例和最佳实践

案例1：验证用户输入

假设你有一个 Person 消息，你希望确保 id 大于 999，email 是有效的邮箱地址，name 符合特定的模式，并且 home 字段是必需的。

syntax = "proto3";
package examplepb;

import "validate/validate.proto";

message Person {
  uint64 id = 1 [(validate.rules).uint64.gt = 999];
  string email = 2 [(validate.rules).string.email = true];
  string name = 3 [(validate.rules).string = {
    pattern: "^[A-Za-z]+( [A-Za-z]+)*$",
    max_bytes: 256
  }];
  Location home = 4 [(validate.rules).message.required = true];
}

message Location {
  double lat = 1 [(validate.rules).double = {gte: -90, lte: 90}];
  double lng = 2 [(validate.rules).double = {gte: -180, lte: 180}];
}