后端示例工程【免费下载链接】go-gin-exampleAn example of gin项目地址https://gitcode.com/gh_mirrors/go/go-gin-example点击查看免费下载本文是一份面向 Go 开发者的表单校验实战指南。它以 beego/validation 库当前仓库 vendor/github.com/astaxie/beego/validation/README.md 所讲解的对象为核心系统讲解其命令式直接调用与Struct Tag 声明式校验两种用法、自定义校验函数、全部内置校验器清单并结合作品 go-gin-example 中 pkg/app/form.go 的BindAndValid封装与 routers/api/v1/tag.go、routers/api/v1/article.go 的真实业务代码说明如何把它接入 Gin 的请求参数校验流程。读完本文你将掌握如何用该库做数据校验与错误收集并能直接套用到自己的 Gin 项目中。一、库定位数据校验与错误收集validation是 beego 框架中独立出的一个 Go 校验子包它的定位非常清晰对数据进行校验并统一收集错误。它不依赖 Web 框架纯 Go 结构体即可使用因此可以无缝嵌入 gin、echo 等任意框架的请求处理流程中。在 go-gin-example 中该库被集中用于 REST API 的入参校验标签接口新增、编辑的validTag 校验见 routers/api/v1/tag.go文章接口新增、编辑、删除的validTag 与命令式valid.Min(...)校验见 routers/api/v1/article.go统一的绑定 校验封装BindAndValid见 pkg/app/form.go。二、安装与测试在 Go Modules 项目中将该库加入依赖并运行测试go get github.com/astaxie/beego/validation go test github.com/astaxie/beego/validation当前仓库中该库位于 vendor 目录下vendor/github.com/astaxie/beego/validation包含四个核心文件validation.go校验上下文与驱动逻辑、validators.go内置校验器实现、util.goTag 解析与自定义函数注册。运行测试命令后可确认本地 vendor 副本的完整性。三、直接使用命令式校验不依赖任何结构体 Tag直接在代码中逐个调用校验方法适合处理单个字段或动态参数。完整示例来自文档并补充了Message自定义提示import ( github.com/astaxie/beego/validation log ) type User struct { Name string Age int } func main() { u : User{man, 40} valid : validation.Validation{} valid.Required(u.Name, name) valid.MaxSize(u.Name, 15, nameMax) valid.Range(u.Age, 0, 140, age) if valid.HasErrors() { // validation does not pass // print invalid message for _, err : range valid.Errors { log.Println(err.Key, err.Message) } } // or use like this if v : valid.Max(u.Age, 140, ageMax); !v.Ok { log.Println(v.Error.Key, v.Error.Message) } }要点拆解Validation{}是校验上下文所有校验方法都挂在它上面每个校验方法接受(obj interface{}, key string)key用于标识该错误归属的字段valid.HasErrors()判断是否出现校验失败valid.Errors是[]*Error切片Error结构包含Message、Key、Name、Field、Value、LimitValue等字段见 validation.go每个方法返回*Result包含Ok bool与Error *Error可链式调用.Key(key)与.Message(format, args...)覆盖默认错误文案见 validation.go。go-gin-example 中命令式校验的典型用法是对路径参数做边界检查例如删除标签时valid : validation.Validation{} id : com.StrTo(c.Param(id)).MustInt() valid.Min(id, 1, id).Message(ID必须大于0) if valid.HasErrors() { app.MarkErrors(valid.Errors) appG.Response(http.StatusBadRequest, e.INVALID_PARAMS, nil) }见 routers/api/v1/tag.go。注意这里用.Message(ID必须大于0)覆盖了默认英文提示验证了Result.Message的自定义能力。四、Struct Tag 使用声明式校验把校验规则直接写在结构体字段的validTag 上然后调用一次valid.Valid(u)即可完成整个结构体的校验。规则语法校验函数名跟在validTag 中多个函数用;分隔参数写在()中多个参数用,分隔Match函数的正则模式字符串必须放在//之间。官方示例import ( github.com/astaxie/beego/validation ) // validation function follow with valid tag // functions divide with ; // parameters in parentheses () and divide with , // Match functions pattern string must in // type user struct { Id int Name string valid:Required;Match(/^(test)?\\w*;com$/) Age int valid:Required;Range(1, 140) } func main() { valid : validation.Validation{} // ignore empty field valid // see CanSkipFuncs // valid : validation.Validation{RequiredFirst:true} u : user{Name: test, Age: 40} b, err : valid.Valid(u) if err ! nil { // handle error } if !b { // validation does not pass // blabla... } }关键语义Valid(obj)要求obj必须是结构体或结构体指针否则返回err见 validation.go返回的b bool表示整体是否通过校验err只在解析 Tag 出错如函数名不存在、参数个数不匹配、正则非法或obj类型错误时非 nil字段值为空时默认仍会执行全部校验规则若希望空字段跳过可跳过的校验函数可创建validation.Validation{RequiredFirst: true}配合CanSkipFuncs中列出的函数Email、IP、Mobile、Tel、Phone、ZipCode实现只有填了才校验格式的效果见 validators.go。go-gin-example 中的声明式校验go-gin-example 的接口层把 Tag 校验与表单绑定合二为一。以新增标签为例routers/api/v1/tag.gotype AddTagForm struct { Name string form:name valid:Required;MaxSize(100) CreatedBy string form:created_by valid:Required;MaxSize(100) State int form:state valid:Range(0,1) }文章模块的表单规则更完整routers/api/v1/article.gotype AddArticleForm struct { TagID int form:tag_id valid:Required;Min(1) Title string form:title valid:Required;MaxSize(100) Desc string form:desc valid:Required;MaxSize(255) Content string form:content valid:Required;MaxSize(65535) CreatedBy string form:created_by valid:Required;MaxSize(100) CoverImageUrl string form:cover_image_url valid:Required;MaxSize(255) State int form:state valid:Range(0,1) }这里的formTag 是 Gin 的绑定标签validTag 是 beego/validation 的校验标签两者互不干扰、协作生效——Gin 负责把请求参数绑定进结构体validation 负责校验结构体字段。五、使用自定义校验函数当内置校验器无法表达业务规则时可通过AddCustomFunc注册自定义函数并在validTag 中直接引用其名称。官方示例import ( github.com/astaxie/beego/validation ) type user struct { Id int Name string valid:Required;IsMe Age int valid:Required;Range(1, 140) } func IsMe(v *validation.Validation, obj interface{}, key string) { name, ok : obj.(string) if !ok { // wrong use case? return } if name ! me { // valid false v.SetError(Name, is not me!) } } func main() { valid : validation.Validation{} if err : validation.AddCustomFunc(IsMe, IsMe); err ! nil { // hadle error } u : user{Name: test, Age: 40} b, err : valid.Valid(u) if err ! nil { // handle error } if !b { // validation does not pass // blabla... } }实现细节见 util.go自定义函数签名固定为func(v *validation.Validation, obj interface{}, key string)即CustomFunc类型注册时会先做保留名检查Clear、HasErrors、ErrorMap、Error、apply、Check、Valid、NoMatch这些名字不可用于自定义函数否则AddCustomFunc返回错误若自定义函数名与已存在的内置校验器同名会覆盖原实现在Valid反射驱动阶段Tag 中引用的函数名会被映射到注册表funcs并反射调用见 util.go因此自定义函数必须在调用Valid之前完成注册。六、Struct Tag 内置校验函数清单下表完整收录 README 列出的全部内置校验函数并依据 validators.go 补充了默认错误模板MessageTmpls见 validators.go方便在报错时对照定位函数参数校验含义默认错误模板Required无非空字符串去空格后非空、数值非 0、切片非空、time.Time非零值Can not be emptyMinmin int数值int 系列不小于 minMinimum is %dMaxmax int数值不大于 maxMaximum is %dRangemin, max int数值在闭区间 [min, max] 内Range is %d to %dMinSizemin int字符串/切片长度不小于 min按 UTF-8 rune 计数Minimum size is %dMaxSizemax int字符串/切片长度不大于 maxMaximum size is %dLengthlength int字符串/切片长度恰等于 lengthRequired length is %dAlpha无字符串仅含[a-zA-Z]Must be valid alpha charactersNumeric无字符串仅含[0-9]Must be valid numeric charactersAlphaNumeric无字符串仅含[0-9a-zA-Z]Must be valid alpha or numeric charactersMatchpattern字符串匹配正则模式须写在//中Must match %sAlphaDash无仅含字母、数字、-、_正则[^\d\w-_]取反Must be valid alpha or numeric or dash(-_) charactersEmail无合法邮箱地址Must be a valid email addressIP无合法 IPv4 地址点分十进制Must be a valid ip addressBase64无合法 Base64 编码Must be valid base64 charactersMobile无中国大陆手机号支持 86/86 前缀Must be valid mobile numberTel无中国大陆固定电话可带区号与-Must be valid telephone numberPhone无手机号或固定电话二选一Must be valid telephone or mobile phone numberZipCode无中国大陆邮政编码[1-9]\d{5}Must be valid zipcode补充说明Min/Max/Range支持int8~int64、uint等整型家族int64在 32 位平台上会返回ErrInt64On32错误见 util.go所有字符串类校验均要求类型断言为string才生效传入非字符串类型会直接判定不通过默认错误消息可通过validation.SetDefaultMessage(map[string]string{...})全局覆盖按函数名传入即可见 validators.go。七、与 Gin 的整合BindAndValid 实战模式go-gin-example 将表单绑定 校验 错误处理封装为一个函数这是本项目对 validation 库最核心的工程化用法pkg/app/form.go// BindAndValid binds and validates data func BindAndValid(c *gin.Context, form interface{}) (int, int) { err : c.Bind(form) if err ! nil { return http.StatusBadRequest, e.INVALID_PARAMS } valid : validation.Validation{} check, err : valid.Valid(form) if err ! nil { return http.StatusInternalServerError, e.ERROR } if !check { MarkErrors(valid.Errors) return http.StatusBadRequest, e.INVALID_PARAMS } return http.StatusOK, e.SUCCESS }其执行链路为c.Bind(form)Gin 依据form/json等 Tag 将请求参数绑定到结构体绑定失败直接返回 400validation.Validation{}.Valid(form)对结构体执行validTag 规则校验Tag 解析失败视为服务端错误500!check存在校验失败时调用MarkErrors(valid.Errors)记录错误日志并返回 400全部通过后返回(http.StatusOK, e.SUCCESS)。其中MarkErrors的实现位于 pkg/app/request.go它遍历[]*validation.Error逐条将Key与Message写入日志func MarkErrors(errors []*validation.Error) { for _, err : range errors { logging.Info(err.Key, err.Message) } }在路由处理函数中的调用形态以编辑标签为例见 routers/api/v1/tag.goform EditTagForm{ID: com.StrTo(c.Param(id)).MustInt()} httpCode, errCode : app.BindAndValid(c, form) if errCode ! e.SUCCESS { appG.Response(httpCode, errCode, nil) return }这种一次封装、处处复用的模式让所有 POST/PUT 接口都只需定义带validTag 的 Form 结构体即可获得统一的参数校验、错误日志与 HTTP 状态码语义无需在每个 handler 里重复编写校验代码。八、源码级原理Valid 是如何驱动 Tag 校验的为了更准确地使用该库可以简要了解其底层机制源码见 validation.go 与 util.go注册表构建包初始化时通过反射遍历Validation类型的所有方法把除保留名unFuncs之外的方法注册进funcs映射表见 util.go因此 Tag 中可用的函数名与Validation的方法集合一一对应Tag 解析getValidFuncs读取字段的validTag先抽取Match(/.../)正则段getRegFuncs见 util.go再按;切分普通规则由parseFunc解析函数名与参数参数会按校验函数声明的类型int、string、regexp 等做类型转换parseParam见 util.go反射执行Valid通过reflect遍历结构体字段对每个字段按 Tag 顺序调用校验函数任一失败即收集Error到v.Errors与按Field分组的v.ErrorsMap见 validation.go扩展接口若被校验的结构体实现了ValidFormer接口方法Valid(*Validation)则在所有 Tag 规则通过后还会回调该方法允许在 Tag 之外补充跨字段的业务校验见 validation.go递归校验RecursiveValid支持先校验自身、再递归校验结构体类型的嵌套字段见 validation.go适合多层级对象的场景。九、小结beego/validation 提供了两套互补的校验方式命令式调用适合轻量、动态的单字段校验Struct Tag 声明式适合成体系的表单/请求结构体校验。将其与 Gin 绑定机制结合如 go-gin-example 的BindAndValid模式可以实现结构体定义即文档、一处封装全局复用的参数校验体系。若需要自定义业务规则AddCustomFunc与ValidFormer接口提供了清晰的扩展点默认错误文案也可通过SetDefaultMessage全局定制。相关可继续深入阅读的文件校验驱动源码 validation.go、内置校验器 validators.go、Tag 解析与自定义函数 util.go以及项目中的集成示例 pkg/app/form.go 与 routers/api/v1/article.go。赞分享后端示例工程【免费下载链接】go-gin-exampleAn example of gin项目地址https://gitcode.com/gh_mirrors/go/go-gin-example点击查看免费下载相关推荐go-gin-example 集成 gin-swagger为 Gin 应用自动生成 Swagger 2.0 API 文档的完整实战指南go gin example 集成 gin swagger为 Gin 应用自动生成 Swagger 2.0 API 文档的完整实战指南 gin swagger后端示例工程go-gin-example 依赖的 Gin 默认校验引擎go-playground/validator.v8 标签式结构体校验完整实战指南go gin example 依赖的 Gin 默认校验引擎go playground/validator.v8 标签式结构体校验完整实战指南 本篇技术指南以仓后端示例工程如何快速掌握Gin框架go-gin-example项目实战指南如何快速掌握Gin框架go gin example项目实战指南 go gin example是一个基于Gin框架的完整示例项目它展示了如何使用Gin构建RE后端示例工程上一篇微信自动化实战指南wxauto 框架原理与完整使用教程下一篇一台能自己站稳的机器人怎么造FOC双轮腿机器人零基础实战手册创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考