golang validator参数校验的实现

 更新时间:2020年10月21日 10:13:25   作者:darcyaf  
这篇文章主要介绍了golang validator参数校验的实现,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧

今天在改后台页面,参数校验错误时输出全是英文,使用着很难看懂到底时什么错了
故而决定去做i18n前端国际化. 改的时候踩了很多坑,故而记录一下,顺便记录以下查问题的方式。

效果

从原来的Title is required变为标题为必填字段

完成后的代码:

这里主要定义了初始化了一个中文的trans和Validate的变量,并对其做初始化
初始化主要做了以下事情:

注册了TagName函数
// RegisterTagNameFunc registers a function to get alternate names for StructFields.
这个方法主要就是提供一个tag的解析器,返回一个Field替代的字符串
我自己是定义了一个label的tag用于替换

注册了validate的翻译函数
直接使用了原来提供的中文转换,对required等标签做对应的国际化

package service

import (
  zhongwen "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"
  "strings"
)

var Validate *validator.Validate
var trans ut.Translator

func init() {
  zh := zhongwen.New()
  uni := ut.New(zh, zh)
  trans, _ = uni.GetTranslator("zh")

  Validate = validator.New()
  Validate.RegisterTagNameFunc(func(field reflect.StructField) string {
    label := field.Tag.Get("label")
    if label == "" {
      return field.Name
    }
    return label
  })
  zh_translations.RegisterDefaultTranslations(Validate, trans)
}
func Translate(errs validator.ValidationErrors) string {
  var errList []string
  for _, e := range errs {
    // can translate each error one at a time.
    errList = append(errList,e.Translate(trans))
  }
  return strings.Join(errList,"|")
}

调用方式

type ArticlesPost struct {
  Title      string `json:"title" validate:"required,max=32,min=4" label:"标题"`
}
var ap ArticlePost
err = service.Validate.Struct(ap)
if err!=nil{
 errStr =Translate(errs)
 fmt.Sprintln(errStr)
}

思路

  • 最刚开始去百度查了,无果
  • 查了iris的文档,也无果
  • 去看了validate的文档,找到了universal-translator 这个包,可以初步将is required等样式改为必填字段
  • 还是没法将字段名映射成中文,google搜索到了How can I translate fieldName? #364这个issue,评论里给出了en.Add("MyField", "Field", false)的方式添加字段的映射,最后在alidate.RegisterTranslation注册required的时候,通过T方法转换成对应的中文fld, _ := ut.T(fe.Field()),考虑到要每次都注册Struct的字段,而且全局的同一个key肯定没法定义不同的值,弃用
  • 第一次想着是不是校验本身已经提供了对应的位置,看了interface,有些英文半知半解,没找到结果,放弃
  • 继续,想到是不是可以自定义tag,然后重写type TranslationFunc func(ut ut.Translator, fe FieldError) string 函数,想在这个翻译阶段,去动态过去struct中那个tag的值,这样就不会重复了.
  • 研究了这个函数的传参,FieldError中已经只剩下字段对应的数据了,无法获取到tag信息,差点已经想放弃了
  • 再次研究validator关于tag的函数

第一个是设置一个新的tag来替换validate,另一个的说明是注册一个方法来为结构体字段获取替换的名字

仔细看看说明,果然就是这个,在看看TagNameFunc的签名,参数是reflect.StructField,能够拿到tag等一系列信息

// TagNameFunc allows for adding of a custom tag name parser
type TagNameFunc func(field reflect.StructField) string
// SetTagName allows for changing of the default tag name of 'validate'
func (v *Validate) SetTagName(name string) {
  v.tagName = name
}

// RegisterTagNameFunc registers a function to get alternate names for StructFields.
//
// eg. to use the names which have been specified for JSON representations of structs, rather than normal Go field names:
//
//  validate.RegisterTagNameFunc(func(fld reflect.StructField) string {
//    name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]
//    if name == "-" {
//      return ""
//    }
//    return name
//  })
func (v *Validate) RegisterTagNameFunc(fn TagNameFunc) {
  v.tagNameFunc = fn
  v.hasTagNameFunc = true
}

至此,终于找到了正确的解决方案

总结

在这里发现为了解决这个问题走了很多弯路,查了一大堆资料才发现甚至原来就有提供该功能。

发现自己的几个问题:

  • 英文不是很好,偶尔有些单词不认识,阻止了进一步发现问题,这里也突然想到,英语好一些确实可以在学编程这个路子上受益匪浅
  • 看文档不是很仔细,鄙人觉得大部分的编程问题都不是很高深,能读得懂错误是什么意思,然后去查查文档或者搜索引擎就能解决,另一个是大部分的编程文档还是英文好一些,细节性的东西在翻译的时候可能会被略掉。

到此这篇关于golang validator参数校验的实现的文章就介绍到这了,更多相关golang validator参数校验内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Go设计模式之原型模式图文详解

    Go设计模式之原型模式图文详解

    原型模式是一种创建型设计模式, 使你能够复制已有对象, 而又无需使代码依赖它们所属的类,本文将通过图片和文字让大家可以详细的了解Go的原型模式,感兴趣的通过跟着小编一起来看看吧
    2023-07-07
  • 一文详解Go语言切片是如何扩容的

    一文详解Go语言切片是如何扩容的

    切片是一个拥有相同类型元素的可变长度的序列,它是基于数组类型做的一层封装。它非常灵活,支持自动扩容。所以本文就来看看Go语言切片是如何扩容的吧
    2023-04-04
  • Golang设计模式之组合模式讲解

    Golang设计模式之组合模式讲解

    这篇文章主要介绍了Golang设计模式之组合模式,组合模式针对于特定场景,如文件管理、组织管理等,使用该模式能简化管理,使代码变得非常简洁
    2023-01-01
  • Golang设计模式中抽象工厂模式详细讲解

    Golang设计模式中抽象工厂模式详细讲解

    抽象工厂模式用于生成产品族的工厂,所生成的对象是有关联的。如果抽象工厂退化成生成的对象无关联则成为工厂函数模式。比如本例子中使用RDB和XML存储订单信息,抽象工厂分别能生成相关的主订单信息和订单详情信息
    2023-01-01
  • 如何编写Go语言中间件的实例教程

    如何编写Go语言中间件的实例教程

    不知道大家有没有写过中间件呢,它是怎么写的呢?下面这篇文中就来给大家分享一下使用Go,如何编写中间件,文中通过示例代码介绍的非常详细,供大家参考学习,下面随着小编来一起学习学习吧。
    2018-04-04
  • Goland使用Go Modules创建/管理项目的操作

    Goland使用Go Modules创建/管理项目的操作

    这篇文章主要介绍了Goland使用Go Modules创建/管理项目的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-05-05
  • Go 泛型和非泛型代码详解

    Go 泛型和非泛型代码详解

    Go 在 1.17 中支持泛型,但是默认未开启;1.18 中会正式支持泛型,下面文章内容小编将给大家讲解Go 语言中的泛型和非泛型并且附上代码详解,刚兴趣的小伙伴请参考下面文章的具体内容
    2021-10-10
  • 举例详解Go语言中os库的常用函数用法

    举例详解Go语言中os库的常用函数用法

    这篇文章主要介绍了Go语言中os库的常用函数用法,os函数的使用是Go语言入门学习中的基础知识,需要的朋友可以参考下
    2015-10-10
  • Go语言实现单端口转发到多个端口

    Go语言实现单端口转发到多个端口

    这篇文章主要为大家详细介绍了Go语言实现单端口转发到多个端口,文中的示例代码讲解详细,具有一定的参考价值,对大家的学习或工作有一定的帮助,需要的小伙伴可以了解下
    2024-02-02
  • 一文带你深入了解Golang中的自旋锁

    一文带你深入了解Golang中的自旋锁

    自旋锁是一种忙等待锁,当一个线程尝试获取一个已经被其它线程持有的锁时,这个线程会持续循环检查锁的状态(即“自旋”) ,直到锁被释放后获得所有权,下面我们就来深入了解下自旋锁的具体操作吧
    2024-01-01

最新评论