问题背景
Gin 以轻量、性能高出名;正所谓鱼和熊掌不可兼得,所以我们在使用的时候会出现很多问题,对于不熟悉的开发者来说是一头雾水。今天我们主要介绍Gin 参数验证方面的问题,
总结的问题
- 中文翻译问题
- 自定义验证规则封装问题
字段标签中文问题
这些事我遇到的问题。如果我总结的不够全面希望大家提出来!
这是我使用过程中遇到的这些问题,我在网上也查过其它开发者分享的内容,基本上都能解决,唯一就是封装上大家都没有解决,所以我就专门写了一个包 gsadminValidator,一是针对我我自开源框架用gsadmin (希望大家多多star),另外也是希望能帮助其它开发者让大家不用重复造轮子,更专注自己的业务开发,基本问题已经描述清楚了,下面我们说解决方案。
正文开始
gsadminValidate 是开源gsadmin核心的一部分; gsadmin它是golang 开发的一个企业级后台。遵循MIT开源协议。前端框架是scui,SCUI基于 Vue3、elementPlus 持续性的提供独家组件和丰富的业务模板帮助你快速搭建企业级中后台前端任务。后端框架是gin,Gin是一个golang的微框架,封装比较优雅,具有快速灵活,容错方便等特点。内置了权限管理、用户管理等基础模块儿,还支持了事件服务,方便业务解耦。后续会根据用户的反馈更新内容!
安装
可以独立于gsadmin 之外使用;但是依赖gin 框架
go get -u github.com/sonhineboy/gsadminValidator
初始化
中文翻译
// initTrans 初始化 中文翻译
func initTrans() *ginValidator.Trans {
tran := ginValidator.NewDefaultTrans()
err := tran.SetUp()
if err != nil {
panic(err)
}
return tran
}
初始化自定义
// initCustomValidator 第一步
func initCustomValidator(tran *ginValidator.Trans) *ginValidator.CustomValidatorManager {
customValidator := ginValidator.NewCustomValidatorManager(make(map[string]ginValidator.CustomValidator), tran.GetValidate(), tran.GetTrans())
// 注册验证规则,内部使用map类型注册,为协程不安全的,所以需要项目出事化是注册
customValidator.Adds(
new(validators.DemoValidator),
)
customValidator.RegisterToValidate()
return customValidator
}
//执行
initCustomValidator(initTrans())
自定义验证规则
package validators
import (
"github.com/go-playground/validator/v10"
"github.com/sonhineboy/gsadminValidator/ginValidator"
)
// DemoValidator 命名规则 名字+Validator
type DemoValidator struct {
ginValidator.BaseValidator
}
//TagName 返回规则名字
func (d *DemoValidator) TagName() string {
return "demo"
}
//Messages 规则错误提示信息
func (d *DemoValidator) Messages() string {
return "{0}长度必须超过6个"
}
//Validator 规则验证逻辑
func (d *DemoValidator) Validator(fl validator.FieldLevel) bool {
return len(fl.Field().String()) > 6
}
注册验证规则
customValidator.Adds(
new(validators.DemoValidator),...
)
声明的是:要在项目的初始化的时候注册进去
使用验证规则
type Login struct {
Name string `json:"name" form:"name" binding:"required,demo=xxx" label:"名字"`
Password string `json:"password" form:"password" binding:"required"`
}
其中 label:是对字段的翻译,如果不需要可以不用
执行效果
//demo 规则不通过
{
"code": 402,
"msg": "名字长度必须超过6个",
"data": ""
}
//无label 效果
{
"code": 402,
"msg": "Name 长度必须超过6个",
"data": ""
}
**粗体** _斜体_ [链接](http://example.com) `代码` - 列表 > 引用
。你还可以使用@
来通知其他用户。