1 Star 16 Fork 2

A-涛 / protoc-go-valid

Create your Gitee Account
Explore and code with more than 12 million developers,Free private repositories !:)
Sign up
Clone or Download
contribute
Sync branch
Cancel
Notice: Creating folder will generate an empty file .keep, because not support in Git
Loading...
README.md
MIT

protoc-go-valid

OSCS Status

🔥项目背景🔥

    1. 孵化之初是在做支付的时候, 抽象类的验证存在多种规则, 后期可能会在增加(为了便于多个规则验证, 实现了验证器, 支持自定义验证 tag), 如下:
// UnifiedOrderReq 下单
type UnifiedOrderReq struct {
 AppName     string            `alipay:"required,size=1~50" wechat:"required,size=1~25"`  // 应用名
 GoodsName   string            `alipay:"required,size=1~150" wechat:"required,size=1~25"` // 商品名
 OutTradeNo  string            `alipay:"required,size=1~64" wechat:"required,size=1~25"`  // 商户订单号
 TotalAmount int32             `alipay:"required,ge=0" wechat:"required,ge=0"`            // 订单总金额,单位为分,详见支付金额
 NotifyUrl   string            `alipay:"required" wechat:"required"`                      // 回调地址
 TimeStart   string            `alipay:"required,datetime"` // 支付时间
 TimeExpire  string            `alipay:"required,datetime" wechat:"datetime"` // 交易过期时间
 OtherMap    map[string]string // 其他补充字段
}
    1. 项目中都是用 protobuf 来交互, 在 protobuf 方面验证器常用的为 go-proto-validators 验证器, 使用方面个人认为较为繁琐, 代码量比较多, 使用如下:
syntax = "proto3";
package validator.examples;
import "github.com/mwitkow/go-proto-validators/validator.proto";

message InnerMessage {
    // some_integer can only be in range (0, 100).
    int32 some_integer = 1 [(validator.field) = {int_gt: 0, int_lt: 100}];
    // some_float can only be in range (0;1).
    double some_float = 2 [(validator.field) = {float_gte: 0, float_lte: 1}];
}
    1. 本验证器, ✨相同功能代码量少, 方便自定义错误信息, 验证规则✨使用如下:
syntax = "proto3";
package examples;

message InnerMessage {
    // some_integer can only be in range (0, 100).
    int32 some_integer = 1; // @tag oto=0~100|应该在0~100
    // some_float can only be in range (0;1).
    double some_float = 2; // @tag oto=0~1|应该在0~1
}

1. 介绍

    1. 通过对 xxx.proto 通过注释的形式加入验证 tag(使用方式文档下方有说明), 然后再使用 inject_tool.sh xxx.proto 编译, 这样生成的 xxx.pb.go 文件中的 struct 注入自定义的 tag
    1. 通过验证器对 struct 中的 tag 进行验证

2. 注入工具使用

    1. 先下载本项目: go get -u gitee.com/xuesongtao/protoc-go-valid
    1. protoc-go-valid 命令操作, 如下:
  • 2.1 protoc-go-valid -init="true"

  • 2.2 protoc-go-valid -d="待注入的目录"

  • 2.3 protoc-go-valid -p="匹配模式"

  • 2.4 protoc-go-valid -f="单个待注入的文件"

    1. 参考 protoc-go-inject-tag

3. 工具补充

    1. protoc-go-valid -h 可以通过这个查看帮助
    1. 由于此操作是先执行 protoc 才再进行注入(需先安装 protoc), 项目中的 inject_tool.sh 整合了这两步操作, 可以执行 protoc-go-valid -init="true" 进行初始化操作, 说明: 如果为 windows 需要使用 powershell 来执行, 如果失败的话, 可以直接将 inject_tool.sh 放到 GOPATH 下(主要是为了工具能命令行全局调用).
    1. 根据自己的项目目录结构调整 inject_tool.shprotopb 的目录, 相对于应用的目录; 如本项目, 修改如下下:
outPdProjectPath="test" # pb 放入的项目路径
protoFileDirName="test" # proto 存放的目录

4. 验证器

4.1 介绍
  • 支持对 一个/多个struct/map类型struct, 会一次性根据对 struct 设置的规则进行验证(包含嵌套验证), 将最终的所有错误都返回
  • 支持对 单个变量 的验证, 变量可以为切片/数组/单个[int,float,bool,string]进行验证
  • 支持对 query url 的验证
  • 支持对 map[string]interface{} 的验证, 暂不支持嵌套类型
4.2 验证
4.2.1 支持的验证如下
标识 结构体 单变量 map url 自定义msg 说明
required yes yes yes yes yes 必填标识, 支持嵌套验证
exist yes no no no yes 子对象有值才验证, 用于嵌套验证
either yes no yes yes no 多选一, 即多个中必须有一个必填, 格式为 "either=xxx"(通过数据进行标识)
botheq yes no yes yes no 多都相等, 即多个中必须都相等, 格式为 "botheq=xxx"(通过数据进行标识)
to yes yes yes yes yes 闭区间验证, 采用 左右闭区间 , 格式为 "to=xxx~xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度), 如: "to=1~10"
ge yes yes yes yes yes 大于或等于验证, 格式为 "ge=xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度)
le yes yes yes yes yes 小于或等于验证, 格式为: "le=xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度)
oto yes yes yes yes yes 开区间验证, 采用 左右开区间 , 格式为 "oto=xxx~xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度), 如: "oto=1~10"
gt yes yes yes yes yes 大于验证, 格式为 "gt=xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度)
lt yes yes yes yes yes 小于验证, 格式为: "lt=xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度)
eq yes yes yes yes yes 等于验证, 格式为: "eq=xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度)
noeq yes yes yes yes yes 不等于验证, 格式为: "noeq=xxx"(字段类型: 字符串为长度, 数字为大小, 切片为长度)
in yes yes yes yes yes 指定输入选项, 格式为 "in=(xxx/xxx/xxx)", 如: "in=(1/abc/3)"
include yes yes yes yes yes 指定输入包含选项, 格式为 "include=(xxx/xxx/xxx)", 如: "include=(hello/2/3)"
phone yes yes yes yes yes 手机号验证
email yes yes yes yes yes 邮箱验证
ip yes yes yes yes yes ip 验证
ipv4 yes yes yes yes yes ipv4 验证
ipv6 yes yes yes yes yes ipv6 验证
idcard yes yes yes yes yes 身份证号码验证
year yes yes yes yes yes 年验证
year2month yes yes yes yes yes 年月验证, 支持分割符, 默认按照"-". 验证:xxxx/xx, 格式: "year2month=/"
date yes yes yes yes yes 日期验证, 支持分割符, 默认按照"-". 验证:xxxx/xx/xx, 格式: "date=/"
datetime yes yes yes yes yes 时间验证, 支持分割符, 默认按照"-". 验证:xxxx/xx/xx xx:xx:xx, 格式: "datetime=/"(说明:支持自定义"日期","日期和时间","时间"分隔符按**,**隔开, 如: "datetime='/, ,/'", 建议参考 ExampleDatetime)
int yes yes yes yes yes 整数型验证
ints yes yes yes yes yes 验证是否为多个数字. 如果输入为 string, 默认按逗号拼接进行验证; 如果为 slice/array, 会将每个值进行匹配判断
float yes yes yes yes yes 浮动数型验证
re yes yes yes yes yes 正则验证, 格式为: "re='xxx'", 如: "re='[a-z]+'"
unique yes yes yes yes yes 唯一验证, 说明: 1.对以逗号隔开的字符串进行唯一验证; 2. 对切片/数组元素[int 系列, float系列, bool系列, string系列]进行唯一验证
json yes yes yes yes yes json 格式验证
prefix yes yes yes yes yes 字符串包含前缀验证
suffix yes yes yes yes yes 字符串包含后缀验证
file yes yes yes yes yes 字符串包含后缀验证
dir yes yes yes yes yes 字符串包含后缀验证
  • 自定义 msg 写法如下, 可以通过调用 GenValidKV 来动态生成:
      1. 如: required|必填, key 为 required, value 为 ``, cusMsg 为 必填;
      1. 如: to=1~2|大于等于 1 且小于等于 2, key 为 to, value 为 1~2, cusMsg 为 大于等于 1 且小于等于 2
      1. 如果自定义信息里有**,**, 此信息必须用 '' 包裹, 如: phone|'需要为手机号,同时为国内的'
4.2.2 设置验证
    1. 通过设置 tag 进行设置验证规则, 默认目标为 valid
    1. 支持通过创建 RM 对象进行自定义设置验证规则, 其验证优先级高于 xxx.pb.go 里的规则, RM 如果要设置嵌套可参考 ExampleNestedStructForRule
4.2.3 其他
    1. 默认按照 tag 进行处理, 如果设置 RM 对象会以此规则为准
    1. 如果验证方法没有实现的, 可以调用 SetCustomerValidFn 自定义
    1. 使用的可以参考 example_test.govalid_test.go

5 使用示例

  • proto 内容如下:
message Man {
    string name = 1; // 姓名 @tag valid:"required,to=1~3"
    int32 age = 2; // 年龄 @tag valid:"to=1~150"
}
  • 注: 编写 xxx.proto 时, 需要加将 @tag xxx 放到注释的最后面
  • 执行命令: inject_tool.sh xxx.proto 生成 pd 内容如下:
type Man struct {
    state protoimpl.MessageState
    sizeCache protoimpl.SizeCache
    unknownFields protoimpl.UnknownFields

    Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty" valid:"required,to=1~3"` // 姓名 @tag valid:"required,to=1~3"
    Age int32 `protobuf:"varint,2,opt,name=age,proto3" json:"age,omitempty" valid:"to=1~150"` // 年龄 @tag valid:"to=1~150"
}
  • 代码里的使用
m := &test.Man{
    Name: "xue",
    Age: -1,
}
fmt.Println(ValidateStruct(m))

// Output: "Man.Age" input "-1" is size less than 1

最后

  • 欢迎大佬们指正, 同时也希望大佬给 ❤️,to gitee github
MIT License Copyright (c) 2022 A-涛 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

🔥🔥🔥1.对 xxx.proto 文件注入 valid tag 2.通过验证器对内容进行验证,3. 验证器易拓展,方便自定义 expand collapse
Go and 2 more languages
MIT
Cancel

Releases

No release

Contributors

All

Activities

Load More
can not load any more
Go
1
https://gitee.com/xuesongtao/protoc-go-valid.git
git@gitee.com:xuesongtao/protoc-go-valid.git
xuesongtao
protoc-go-valid
protoc-go-valid
master

Search

F2647f8d 8189591 Bbdfb06e 8189591