近期的项目需要使用grpc通信，手写protobuf message的字段验证是一个很麻烦的事情，就想找找有没有现成的轮子。先想到了kubernetes，发现人家是先写的golang代码，然后转成的protobuf。

最终找到了envoyproxy仓库中的protobuf校验插件，protoc-gen-validate（PGV） ，体验下来感觉还是非常好用，节省了大量CRUD的工作量。代码链接见文末。

TL;DR

PGV其工作原理是根据消息中字段的annotation，执行protoc时，自动生成消息的Validate函数。代码中只需要调用消息结构体的Validate函数。demo如下。

probuf定义如下：

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:   "^[^[0-9]A-Za-z]+( [^[0-9]A-Za-z]+)*#34;,
  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 }];
  }
}

golang代码中的调用：

p := new(Person)

err := p.Validate(false) 
// err: Id must be greater than 999
p.Id = 1000

err = p.Validate(false) 
// err: Email must be a valid email address
p.Email = "example@lyft.com"

err = p.Validate(false) 
// err: Name must match
// pattern '^[^\d\s]+( [^\d\s]+)*#39;
p.Name = "Protocol Buffer"

err = p.Validate(false) 
// err: Home is required
p.Home = &Location{37.7, 999}

err = p.Validate(false) 
// err: Home.Lng must be
// within [-180, 180]
p.Home.Lng = -122.4

err = p.Validate(false) 
// err: nil

支持语言：

golang，java，c++（部分），python（runtime）

目前仅支持proto3.

基本数据类型校验

• 数字：常量，逻辑，有效列表，空值
• 布尔
• 字符串：常量，长度，字节数，正则表达式，前缀，后缀，子串，有效列表，空值。

字符串校验内置了email，hostname，ipv4，ipv6等内置格式。

• 字节 byte：与字符串差不多，差别是判断字节，而不是字符。
• 枚举 enum：常量，有效定义值，有效列表
• 消息 message：跳过校验，非空校验
• 列表 repeated：列表长度，元素有效性
• 哈希 map：map长度，赋值非空，嵌套关键字校验，嵌套赋值校验

常用类型校验

• Any： 非空校验，有效值类型列表
• Duration：逻辑，有效值列表
• TimeStamp: 逻辑
• OneOf: 非空

protoc代码生成

以golang为例：

protoc \
  -I . \
  -I ${GOPATH}/src \
  -I ${GOPATH}/src/github.com/envoyproxy/protoc-gen-validate \
  --go_out=":../generated" \
  --validate_out="lang=go:../generated" \
  example.proto

有兴趣的同学可以详细看一下PGV的github，文档非常详细。

https://github.com/envoyproxy/protoc-gen-validate

#grpc#
#程序员#
#GitHub#