proto-validator 使用介绍

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

The Go Programming Language

› http://golang.org/

› Go Playground

Go Projects

› Revel Web Framework

这是一个创建于 758 天前的主题，其中的信息可能已经有所发展或是发生改变。

最近把内部的一个工具开源了出来，主要功能就是可以通过配置 proto 的拓展完成 dto 的参数验证定义与执行。

proto-validator

proto-validator 是我们在平时开发中为了解决业务痛点而创造的。为了实现 proto dto 的定义和参数验证，原来我们只能在写业务代码时自己再去做参数验证，会造成一定量的重复劳动。而 proto-validator 可以实现在定义 proto 时就可以声明参数验证规则，通过 proto-gen-av 生成自动验证代码，把参数验证自动处理掉。

与 github 上其它类似的库的区别？我人为最大的区别是更节省了一步。我看了其它库主要是生成 validate 规则，然后需要用户在业务代码中调一下这个验证方法，自行返回错误。我是一步重复劳动都不想做，所以把验证并返回报错这一步也自动化了。

protoc-gen-av

全称 protoc-gen-auto-validator 简称 protoc-gen-av

最佳实践

先安装 protoc-gen-av 插件

go install github.com/Gitforxuyang/proto-validaotr/cmd/protoc-gen-av

简单服务(单个服务)

参考 examples/simple

多个服务(对于有些大仓库，很多服务在同一个目录下)

参考 examples/multi

方法介绍

所有的默认值等于不启用插件比如如果设置 gte=0 ，可能本意是需要入参>=0 ，但是插件无法读取，所以请不要在配置中使用各类型的零值

字段类型	默认值	类型	当字段是 string 类型时	repeated 时	int32/int64/uint32/uint64 时	float/double 时	message 类型时
omitempty	true	bool	不能为空字符串	数组长度不能为 0	值不能为 0	值不能为 0	不能为 nil
gte	0	double	不支持	长度必须>=n	值必须>=	值必须>=	不支持
gt	0	double	不支持	长度必须>n	值必须>	值必须>	不支持
lte	0	double	不支持	长度必须<=n	值必须<=	值必须<=	不支持
lt	0	double	不支持	长度必须<n	值必须<	值必须<	不支持
eq	""	string	字符串=n	长度必须=n	值必须=n	值必须=n	不支持
in	""	string	格式必须是[1,2,3]	不支持	格式必须是[1,2,3]	格式必须是[1.1,2.2,3.3]	不支持
regexp	""	string	正则表达式	不支持	不支持	不支持	不支持