一. 基础使用
- 解释: 后端接收参数时通常需要对参数进行校验,例如验证某个数据是否为空,数据格式是否正确等,常见验证方式通过if,switch-case等流程语句进行验证,比较繁琐,可以通过validator框架进行验证
- 参考博客1,
- 参考博客2
- 参考博客3
- 参考博客重点
- 参考博客重点
实现步骤
- 下载依赖
//下载validator依赖包
go get github.com/go-playground/validator/v10
go get github.com/go-playground/validator/v10/translations/zh
//下载验证不通过是抛出中文描述依赖包
go get github.com/go-playground/universal-translator
go get github.com/go-playground/locales
- 编写校验工具类
package validator
//1.导入依赖
import (
"fmt"
"github.com/go-playground/locales/zh"
ut "github.com/go-playground/universal-translator"
"github.com/go-playground/validator/v10"
zh_translations "github.com/go-playground/validator/v10/translations/zh"
"reflect"
)
//2.编写校验方法
func ReqValidator(v interface{}) string {
uni := ut.New(zh.New())
trans, _ := uni.GetTranslator("zh")
validate := validator.New()
//注册一个函数,获取struct tag里自定义的label作为字段名
validate.RegisterTagNameFunc(func(fld reflect.StructField) string {
name := fld.Tag.Get("label")
return name
})
//验证器注册翻译器
err := zh_translations.RegisterDefaultTranslations(validate, trans)
if err != nil {
return err.Error()
}
err = validate.Struct(v)
if err == nil {
return ""
}
for _, err := range err.(validator.ValidationErrors) {
fmt.Println(err.Translate(trans))
if err != nil {
return err.Translate(trans)
}
}
return ""
}
- 使用示例
package controllers
import (
"util/validator"
"fmt"
)
//1.测试结构体,添加validator使用tag
type Users struct {
Name string `form:"name" json:"name" validate:"required" label:"用户名"`
Age uint8 `form:"age" json:"age" validate:"required,gt=18" label:"年龄"`
Passwd string `form:"passwd" json:"passwd" validate:"required,max=20,min=6"`
Code string `form:"code" json:"code" validate:"required,len=6"`
}
//2测试方法执行
func Test() {
//创建测试数据
users := &Users{
Name: "admin",
Age: 12,
Passwd: "123",
Code: "123456",
}
//调用验证方法,返回验证结果
errStr := validator.ReqValidator(users)
//当验证结果字符串不为空时说明验证未通过抛出异常
if len(errStr) != 0 {
fmt.Println(errStr)//Age必须大于18
log.ErrorLog(msgid, "--- | %s %s", errStr)
response(ctx, APIResource(msgid, lmerror.HTTP_INPUT_ERROR, errStr))
return
}
}
- 注意点1: 在使用validator对参数进行非空校验时注意使用的validator版本与 tag 是 “required” 还是 “exists”(当前笔记中使用的是v10)
v8 required 和 exists 的区别:required nil和零值都不能通过检验,exists 零值能通过,nil不能通过
v9没有exists了,统一用require,用在基础类型上零值不能通过,用在指针上nil不能通过而零值能通过
- 注意点2: 在导入validator校验框架时查看项目中go.mod文件,也导入了地址,但是还爆红导入失败(代理原因需要设置go)
- 解决导入失败问题设置goproxy: “GOPROXY=https://goproxy.cn,direct”
- 执行 “go mod tidy” 命令,更新依赖