【Golang】Gin 框架之请求参数多语言验证

我们在web开发中,你的应用可能会在不同国家使用,所以需要将相关的错误提示根据本地语言进行相应的提示,也即是所谓的国际化。本文简单的介绍一下,在Gin中如何实现多语言的验证。我们借助validator.v10以及相应的语言包。

集成关键点

  1. 导入需要转换语言包
    • 公共包: "github.com/go-playground/validator/v10"
    • 需要转换的包,比如英文和中文
    en2 "github.com/go-playground/locales/en"
    zh2 "github.com/go-playground/locales/zh"
    ut "github.com/go-playground/universal-translator"
    en_translations "github.com/go-playground/validator/v10/translations/en"
    zh_translations "github.com/go-playground/validator/v10/translations/zh"
  1. 结构体定义不在是 binding,而是validate
type Person struct {
    Age     int    `form:"age" validate:"required,gt=10"`
    Name    string `form:"name" validate:"required"`
    Address string `form:"address" validate:"required"`
}
  1. 构建语言转换器以及注册
tans, _ := uni.GetTranslator(local)
tans, _ := uni.GetTranslator(local)
    switch local {
    case "en":
        en_translations.RegisterDefaultTranslations(validate, tans)
    case "zh":
        zh_translations.RegisterDefaultTranslations(validate, tans)
    default:
        en_translations.RegisterDefaultTranslations(validate, tans)
    }
  1. 校验以及获取错误信息

    校验,调用err := validate.Struct(xx);如果对返回的错误信息进行处理,validator返回的绑定错误信息格式:key = namespace & value = translated error;我们可以一次性获取所有的转换信息或者每次一次,具体如下:

err := validate.Struct(person)
if err != nil {
    errs := err.(validator.ValidationErrors)
    // 一次性转换所有与的错误信息方式
    fmt.Println(errs.Translate(trans))
    // 每次转换一次
    for _, e := range errs {
            fmt.Println(e.Translate(trans))
    }
}

具体示例

package main
import (
    "github.com/gin-gonic/gin"
    en2 "github.com/go-playground/locales/en"
    zh2 "github.com/go-playground/locales/zh"
    ut "github.com/go-playground/universal-translator"
    "github.com/go-playground/validator/v10"
    en_translations "github.com/go-playground/validator/v10/translations/en"
    zh_translations "github.com/go-playground/validator/v10/translations/zh"
    "log"
    "net/http"
)

type Person struct {
    Age     int    `form:"age" validate:"required,gt=10"`
    Name    string `form:"name" validate:"required"`
    Address string `form:"address" validate:"required"`
}

// use a single instance , it caches struct info
var (
    uni      *ut.UniversalTranslator
    validate *validator.Validate
)

func multiLangBindingHandler(c *gin.Context) {
    local := c.DefaultQuery("local", "en")
    log.Println("local:", local)
    tans, _ := uni.GetTranslator(local)
    switch local {
    case "en":
        en_translations.RegisterDefaultTranslations(validate, tans)
    case "zh":
        zh_translations.RegisterDefaultTranslations(validate, tans)
    default:
        en_translations.RegisterDefaultTranslations(validate, tans)
    }
    var person Person

    if err := c.ShouldBind(&person); err != nil {
        c.JSON(http.StatusBadRequest, gin.H{
            "message": err.Error(),
        })
        return
    }
    if err := validate.Struct(person); err != nil {

        errs := err.(validator.ValidationErrors)
        sliceErrs := []string{}
        for _, e := range errs {
            // can translate each error one at a time.
            sliceErrs = append(sliceErrs, e.Translate(tans))
        }
        c.JSON(http.StatusBadRequest, gin.H{
            // translate all error at once
            // returns a map with key = namespace & value = translated error
            // NOTICE: 2 errors are returned and you'll see something surprising
            // translations are i18n aware!!!!
            // eg. '10 characters' vs '1 character'
            "message":   errs.Translate(tans),
            "sliceErrs": sliceErrs,
        })
        return
    }
    c.JSON(http.StatusOK, gin.H{
        "personInfo": person,
    })
}

func main() {
    zh := zh2.New()
    en := en2.New()
    uni = ut.New(en, zh)

    validate = validator.New()
    router := gin.Default()
    router.GET("/testMultiLangBinding", multiLangBindingHandler)
    router.Run(":9999")
}

测试

测试案例 测试结果
$ curl -X GET "localhost:9999/testMultiLangBinding" {"sliceErrs":["Age is a required field","Name is a required field","Address is a required field"]}
$ curl -X GET "localhost:9999/testMultiLangBinding?local=zh&age=12&name=yunfeng&address=wuhan" {"personInfo":{"Age":12,"Name":"yunfeng","Address":"wuhan"}}
$ curl -X GET "localhost:9999/testMultiLangBinding?local=zh&age=12&name=yunfeng&address=wuhan" {"personInfo":{"Age":12,"Name":"yunfeng","Address":"wuhan"}}
$ curl -X GET "localhost:9999/testMultiLangBinding?local=zh" {"message":{"Person.Address":"Address为必填字段","Person.Age":"Age为必填字段","Person.Name":"Name为必填字段"},"sliceErrs":["Age为必填字段","Name为必填字段","Address为必填字段"]}

参考资料

validator.v10
Translations & Custom Errors

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,558评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,002评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 159,036评论 0 349
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,024评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,144评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,255评论 1 292
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,295评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,068评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,478评论 1 305
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,789评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,965评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,649评论 4 336
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,267评论 3 318
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,982评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,223评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,800评论 2 365
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,847评论 2 351

推荐阅读更多精彩内容