gin自定义验证器+中文翻译

2024-05-13 14:44

本文主要是介绍gin自定义验证器+中文翻译,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

gin自定义验证器+中文翻译

    • 1、说明
    • 2、global.go
    • 3、validator.go
    • 4、eg:main.go
    • 5、调用接口测试

1、说明

gin官网自定义验证器给的例子相对比较简单,主要是语法级别,便于入门学习,并且没有给出翻译相关的处理,因此在这里记录一下通用一点的自定义验证器+中文翻译的代码,可以直接在往后的go-web项目直接使用

2、global.go

// Package global 当前包存放全局的变量,便于项目所有包使用
package globalimport ("net/http""strings""github.com/gin-gonic/gin"ut "github.com/go-playground/universal-translator""github.com/go-playground/validator/v10"
)/****************************** 全局变量 ****************************/
var (// Trans 全局的翻译器Trans ut.Translator
)/****************************** 辅助函数 ****************************/// removeTopStruct 移除打印的错误信息中的结构体包前缀
func removeTopStruct(fields map[string]string) map[string]string {rsp := map[string]string{}for field, err := range fields {rsp[field[strings.Index(field, ".")+1:]] = err}return rsp
}// HandlerValidatorError 处理校验错误响应
func HandlerValidatorError(c *gin.Context, err error) {errs, ok := err.(validator.ValidationErrors)if !ok {c.JSON(http.StatusOK, gin.H{"msg": err.Error(),})return}c.JSON(http.StatusBadRequest, gin.H{"error": removeTopStruct(errs.Translate(Trans)),})return
}

3、validator.go

package validatorimport ("fmt""reflect""regexp""strings""github.com/gin-gonic/gin/binding""github.com/go-playground/locales/en""github.com/go-playground/locales/zh"ut "github.com/go-playground/universal-translator""github.com/go-playground/validator/v10"entranslations "github.com/go-playground/validator/v10/translations/en"zhtranslations "github.com/go-playground/validator/v10/translations/zh"
)// 验证器
var (trans ut.Translator
)/****************************** 翻译器、自定义的验证器的初始化 ****************************/// InitChineseTranslator 初始化中文翻译器
func InitChineseTranslator(){if err := initTrans("zh"); err != nil {panic("初始化翻译器错误" + err.Error())} else {fmt.Println("初始化中文翻译器成功")}
}// InitEnglishTranslator 初始化英文翻译器
func InitEnglishTranslator(){if err := initTrans("en"); err != nil {panic("初始化翻译器错误" + err.Error())} else {fmt.Println("初始化英文翻译器成功")}
}// initTrans 初始化翻译器
func initTrans(locale string) (err error) {//修改gin框架中的validator引擎属性, 实现定制if v, ok := binding.Validator.Engine().(*validator.Validate); ok {//注册一个获取json的tag的自定义方法v.RegisterTagNameFunc(func(fld reflect.StructField) string {name := strings.SplitN(fld.Tag.Get("json"), ",", 2)[0]if name == "-" {return ""}return name})zhT := zh.New() //中文翻译器enT := en.New() //英文翻译器//第一个参数是备用的语言环境,后面的参数是应该支持的语言环境uni := ut.New(enT, zhT, enT)// 根据输入获取传入指定的翻译器trans, ok = uni.GetTranslator(locale)if !ok {return fmt.Errorf("uni.GetTranslator(%s)", locale)}switch locale {case "en":err = entranslations.RegisterDefaultTranslations(v, trans)case "zh":err = zhtranslations.RegisterDefaultTranslations(v, trans)default:err = entranslations.RegisterDefaultTranslations(v, trans)}}return
}// InitValidationRules 注册自定义的验证器
func InitValidationRules() {if v, ok := binding.Validator.Engine().(*validator.Validate); ok {// 1、mobile验证器相关{// 设置自定义验证器的翻译配置,每个验证器搭配一个翻译规则err := v.RegisterTranslation("mobile", trans, func(ut ut.Translator) error {return ut.Add("mobile", "{0} 非法的手机号!", true) // see universal-translator for details}, func(ut ut.Translator, fe validator.FieldError) string {t, _ := ut.T("mobile", fe.Field())return t})// mobile验证器err = v.RegisterValidation("mobile", validateMobile)if err != nil {panic("mobile验证器注册失败:" + err.Error())}}//	2、XXX验证器相关{}fmt.Println("初始化验证器成功")}
}/****************************** 自定义验证器 ****************************/// validateMobile 手机号码的校验规则,用于gin的请求参数自动校验
func validateMobile(fl validator.FieldLevel) bool {// 内部通过反射获取mobile的值mobile := fl.Field().String()//使用正则表达式判断是否合法isValid, _ := regexp.MatchString(`^1([38][0-9]|14[579]|5[^4]|16[6]|7[1-35-8]|9[189])\d{8}$`, mobile)return isValid
}/****************************** 自定义验证器 ****************************/// validateMobile 手机号码的校验规则,用于gin的请求参数自动校验
func validateMobile(fl validator.FieldLevel) bool {// 内部通过反射获取mobile的值mobile := fl.Field().String()//使用正则表达式判断是否合法isValid, _ := regexp.MatchString(`^1([38][0-9]|14[579]|5[^4]|16[6]|7[1-35-8]|9[189])\d{8}$`, mobile)return isValid
}

4、eg:main.go

使用样例,需要在main函数中先调用validator包中的函数,初始化翻译器跟验证器
在接口解析参数的地方,判断处理验证异常

package mainimport ("fmt""net/http""github.com/gin-gonic/gin"// 引入全局的校验异常处理函数"Go_Bible/valiator_test/global"// 引入通用的验证器相关代码"Go_Bible/valiator_test/validator"
)/****************************** 表单结构体、配置校验约束 ****************************/// PasswordLoginForm 用户名、密码登录表单结构体
type PasswordLoginForm struct {Mobile   string `form:"mobile" json:"mobile" binding:"required,mobile"` // 自定义了mobile验证器,使用自定义的校验规则Password string `form:"password" json:"password" binding:"required,min=3,max=10"`
}/****************************** 接口实现 ****************************/// Login 登录接口
func Login(c *gin.Context) {passwordLoginForm := PasswordLoginForm{}// 解析form参数或者json参数if err := c.ShouldBindJSON(&passwordLoginForm); err != nil {// 处理验证异常global.HandlerValidatorError(c, err)return}fmt.Println("参数通过验证,登录接口请求参数:", passwordLoginForm)c.JSON(http.StatusOK, gin.H{"msg": passwordLoginForm,})
}/****************************** 主函数 ****************************/
func main() {// 1、初始化中文翻译器validator.InitChineseTranslator()// 2、初始化自定义的验证器+验证信息翻译validator.InitValidationRules()// 3、初始化gin路由配置router := gin.Default()router.POST("/login", Login)fmt.Println("Gin启动")if err := router.Run(":8081"); err != nil {panic("Gin启动错误:" + err.Error())}
}

5、调用接口测试

启动main.go,发送请求测试接口:http://127.0.0.1:8081/login

在这里插入图片描述

这篇关于gin自定义验证器+中文翻译的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/986003

相关文章

Java JDK Validation 注解解析与使用方法验证

《JavaJDKValidation注解解析与使用方法验证》JakartaValidation提供了一种声明式、标准化的方式来验证Java对象,与框架无关,可以方便地集成到各种Java应用中,... 目录核心概念1. 主要注解基本约束注解其他常用注解2. 核心接口使用方法1. 基本使用添加依赖 (Maven

C#中通过Response.Headers设置自定义参数的代码示例

《C#中通过Response.Headers设置自定义参数的代码示例》:本文主要介绍C#中通过Response.Headers设置自定义响应头的方法,涵盖基础添加、安全校验、生产实践及调试技巧,强... 目录一、基础设置方法1. 直接添加自定义头2. 批量设置模式二、高级配置技巧1. 安全校验机制2. 类型

python库pydantic数据验证和设置管理库的用途

《python库pydantic数据验证和设置管理库的用途》pydantic是一个用于数据验证和设置管理的Python库,它主要利用Python类型注解来定义数据模型的结构和验证规则,本文给大家介绍p... 目录主要特点和用途:Field数值验证参数总结pydantic 是一个让你能够 confidentl

SpringBoot AspectJ切面配合自定义注解实现权限校验的示例详解

《SpringBootAspectJ切面配合自定义注解实现权限校验的示例详解》本文章介绍了如何通过创建自定义的权限校验注解,配合AspectJ切面拦截注解实现权限校验,本文结合实例代码给大家介绍的非... 目录1. 创建权限校验注解2. 创建ASPectJ切面拦截注解校验权限3. 用法示例A. 参考文章本文

Vite 打包目录结构自定义配置小结

《Vite打包目录结构自定义配置小结》在Vite工程开发中,默认打包后的dist目录资源常集中在asset目录下,不利于资源管理,本文基于Rollup配置原理,本文就来介绍一下通过Vite配置自定义... 目录一、实现原理二、具体配置步骤1. 基础配置文件2. 配置说明(1)js 资源分离(2)非 JS 资

聊聊springboot中如何自定义消息转换器

《聊聊springboot中如何自定义消息转换器》SpringBoot通过HttpMessageConverter处理HTTP数据转换,支持多种媒体类型,接下来通过本文给大家介绍springboot中... 目录核心接口springboot默认提供的转换器如何自定义消息转换器Spring Boot 中的消息

Go语言使用Gin处理路由参数和查询参数

《Go语言使用Gin处理路由参数和查询参数》在WebAPI开发中,处理路由参数(PathParameter)和查询参数(QueryParameter)是非常常见的需求,下面我们就来看看Go语言... 目录一、路由参数 vs 查询参数二、Gin 获取路由参数和查询参数三、示例代码四、运行与测试1. 测试编程路

Python自定义异常的全面指南(入门到实践)

《Python自定义异常的全面指南(入门到实践)》想象你正在开发一个银行系统,用户转账时余额不足,如果直接抛出ValueError,调用方很难区分是金额格式错误还是余额不足,这正是Python自定义异... 目录引言:为什么需要自定义异常一、异常基础:先搞懂python的异常体系1.1 异常是什么?1.2

Linux中的自定义协议+序列反序列化用法

《Linux中的自定义协议+序列反序列化用法》文章探讨网络程序在应用层的实现,涉及TCP协议的数据传输机制、结构化数据的序列化与反序列化方法,以及通过JSON和自定义协议构建网络计算器的思路,强调分层... 目录一,再次理解协议二,序列化和反序列化三,实现网络计算器3.1 日志文件3.2Socket.hpp

C语言自定义类型之联合和枚举解读

《C语言自定义类型之联合和枚举解读》联合体共享内存,大小由最大成员决定,遵循对齐规则;枚举类型列举可能值,提升可读性和类型安全性,两者在C语言中用于优化内存和程序效率... 目录一、联合体1.1 联合体类型的声明1.2 联合体的特点1.2.1 特点11.2.2 特点21.2.3 特点31.3 联合体的大小1