validator库的使用详解

news2024/11/19 8:46:54

@TOC

基本使用

前言

在做API开发时，需要对请求参数的校验，防止用户的恶意请求。例如日期格式，用户年龄，性别等必须是正常的值，不能随意设置。以前会使用大量的if判断参数的值是否符合规范，现在可以使用validator库来进行参数校验。我们只需要在结构体的Tag中添加 validator 标签就可以实现参数校验。同时Gin框架当前内部也集成了validator.v10这个库，在Gin框架中只要在结构体的Tag中添加 binding 标签就可以实现参数校验。使用binding标签和validator标签都是可以的，但是在Gin框架中我们一般会使用binding标签来实现参数校验。

请求模型的定义

//请求的参数必须存在并且由数字或字母组成
type UserRequest struct {
	Username string `json:"username" form:"username" binding:"required,alphanum"`
	Password string `json:"password" form:"password" binding:"required,alphanum"`
}

编写接口及测试

// ModifyUser 用来修改用户的密码
func ModifyUser(c *gin.Context) {
	var user UserRequest
	if err := c.BindQuery(&user); err != nil {
		c.JSON(http.StatusOK, gin.H{
			"msg": err.Error(),
		})
		return
	}
	//查询是否存在该用户
	result := service.SelectUserIfExist(user.Username)
	if result == 1 { //该用户存在
		userInfo := service.ChangeUserSecret(user.Username, user.Password)
		c.JSON(http.StatusOK, gin.H{
			"msg": userInfo,
		})
	} else {
		c.JSON(http.StatusOK, gin.H{
			"msg": "用户不存在",
		})
	}
}

现在数据库中有一个用户。

mysql> select * from user;
+---------+----------+----------+
| user_id | username | password |
+---------+----------+----------+
|       4 | abc123   | abc123   |
+---------+----------+----------+

我们在修改密码时，将密码设置为空或者改成 xyz@456 看看参数校验能不能通过。

image-20231011173623783 image-20231011173823585

可以看到将密码设置为空或者改成 xyz@456 会曝出不同的错误。下面使用满足校验规则的密码进行测试：

image-20231011174027471

可以看到密码已经被成功修改。

翻译校验错误提示信息

当参数校验错误的时候会返回错误信息，可以看到上面的错误信息都是英文，有时候看英文确实会不太舒服，所以也没有什么办法可以把错误信息翻译成中文？答案是有的，validator 库本身是支持国际化的，借助相应的语言包可以实现校验错误提示信息的自动翻译。下面的示例代码演示了如何将错误提示信息翻译成中文。可以新建一个目录utils，目录下面新建一个translate.go文件。文件内容如下：

package utils

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

// Trans 一个全局翻译器
var Trans ut.Translator

func Translate(locale string) (err error) {
	// 修改gin框架中的Validator引擎属性，实现自定制
	if value, ok := binding.Validator.Engine().(*validator.Validate); ok {

		zhT := zh.New() // 中文翻译器
		enT := en.New() // 英文翻译器

		// 第一个参数是备用（fallback）的语言环境
		// 后面的参数是支持的语言环境（支持多个）
		uni := ut.New(enT, zhT, enT)

		// locale 通常取决于 http 请求头的 'Accept-Language'
		var ok bool
		// 也可以使用 uni.FindTranslator(...) 传入多个locale进行查找
		Trans, ok = uni.GetTranslator(locale)
		if !ok {
			return fmt.Errorf("uni.GetTranslator(%s) failed", locale)
		}

		// 注册翻译器
		switch locale {
		case "en":
			err = enTranslations.RegisterDefaultTranslations(value, Trans)
		case "zh":
			err = zhTranslations.RegisterDefaultTranslations(value, Trans)
		default:
			err = enTranslations.RegisterDefaultTranslations(value, Trans)
		}
		return
	}
	return
}

然后需要在main函数中初始化 Translate 这个函数。

func main() {
	if err := utils.Translate("zh"); err != nil {
		fmt.Printf("init trans failed, err:%v\n", err)
		return
	}
}

接下来就能使用这个翻译器翻译英文信息。

// ModifyUser 用来修改用户的密码
func ModifyUser(c *gin.Context) {
	var user UserRequest
	if err := c.ShouldBindQuery(&user); err != nil {
		// 获取validator.ValidationErrors类型的errors
		errs, ok := err.(validator.ValidationErrors)
		if !ok {
			// 非validator.ValidationErrors类型错误直接返回
			c.JSON(http.StatusOK, gin.H{
				"msg": err.Error(),
			})
			return
		}
		// validator.ValidationErrors类型错误则进行翻译
		c.JSON(http.StatusOK, gin.H{
			"msg": errs.Translate(utils.Trans),
		})
		return
	}
	//查询是否存在该用户
	result := service.SelectUserIfExist(user.Username)
	if result == 1 { //该用户存在
		userInfo := service.ChangeUserSecret(user.Username, user.Password)
		c.JSON(http.StatusOK, gin.H{
			"msg": userInfo,
		})
	} else {
		c.JSON(http.StatusOK, gin.H{
			"msg": "用户不存在",
		})
	}
}

测试结果如下：

image-20231011192954175 image-20231011192918100

自定义错误提示信息的字段名

上面的错误提示看起来是可以了，但是还是差点意思，首先是错误提示中的字段并不是请求中使用的字段，例如：Password 是我们后端定义的结构体中的字段名，而请求中使用的是小写的 password 字段。如何让错误提示中的字段使用自定义的名称，例如json tag指定的值呢？

其实只需要在初始化翻译器的时候像下面一样添加一个获取json tag的自定义方法即可。

func Translate(locale string) (err error) {
	// 修改gin框架中的Validator引擎属性，实现自定制
	if value, ok := binding.Validator.Engine().(*validator.Validate); ok {
	
		// 注册一个获取json tag的自定义方法
		value.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() // 英文翻译器

        // 第一个参数是备用（fallback）的语言环境
        // 后面的参数是支持的语言环境（支持多个）
        uni := ut.New(enT, zhT, enT)

        ······
	}
	return
}

现在错误信息中的password就变成了小写了。测试结果如下：

image-20231011194814448

但是还是有点瑕疵，那就是最终的错误提示信息中心还是有我们后端定义的结构体名称（UserRequest），这个名称其实是不需要随错误提示返回给前端的，前端并不需要这个值。我们需要想办法把它去掉。其实可以定义一个去掉结构体名称前缀的自定义方法：

func removeTopStruct(fields map[string]string) map[string]string {
	res := map[string]string{}
	for field, err := range fields {
		res[field[strings.Index(field, ".")+1:]] = err
	}
	return res
}

我们在代码中使用上述函数将翻译后的 errors 做一下处理即可：

if err := c.ShouldBindQuery(&user); err != nil {
		// 获取validator.ValidationErrors类型的errors
		errs, ok := err.(validator.ValidationErrors)
		if !ok {
			// 非validator.ValidationErrors类型错误直接返回
			c.JSON(http.StatusOK, gin.H{
				"msg": err.Error(),
			})
			return
		}
		// validator.ValidationErrors类型错误则进行翻译
    	// 并使用removeTopStruct函数去除字段名中的结构体名称标识
		c.JSON(http.StatusOK, gin.H{
			"msg": removeTopStruct(errs.Translate(utils.Trans)),
		})
		return
	}

测试结果如下：

image-20231011195855386

自定义校验规则

先在又有一个需求，那就是要求密码必须是由数字、字母或下划线组成，且第一个字符不能是下划线，那么这个需求又该如何实现呢？

func CustomFunc(fl validator.FieldLevel) bool {
	// 正则表达式来匹配字母、数字和下划线，且第一个字符不能是下划线
	re := regexp.MustCompile(`^[a-zA-Z0-9][a-zA-Z0-9_]*$`)
	return re.MatchString(fl.Field().String())
}

// tag参数就是我们自己自定义的校验规则的名字
func Custom(tag string) (err error) {
	if value, ok := binding.Validator.Engine().(*validator.Validate); ok {
		// 在校验器注册自定义的校验方法
		if err := value.RegisterValidation(tag, CustomFunc); err != nil {
			return err
		}
	}
	return err
}

接下来只需要在main函数或者一些初始化函数当中注册这个Custom函数就可以了。需要注意的是，要添加上binding的字段校验规则，比如：

// Password的校验规则就是我们自定义的校验规则：password
type UserRequest struct {
	Username string `json:"username" form:"username" binding:"required,alphanum"`
	Password string `json:"password" form:"password" binding:"required,password"`
}

测试结果如下：

image-20231011204702960 image-20231011204618021

可以看到 abc_123 满足校验规则，而 _abc123 不满足校验规则。

常见的参数校验字段

下面是一些常见的校验规则：

Tag描述
eqfield一个字段等于另一个字段
alpha仅限字母
alphanum仅限字母数字
excludes排除
jsonJSON
jwtJSON Web Token (JWT)
emailE-mail 字符串
html_encodedHTML编码
eq等于
gt大于
gte大于或等于
lt小于
lte小于或等于
ne不等于
len长度
max最大
min最小
required必需的
unique唯一

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1081805.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

电脑如何查看是否支持虚拟化及如何开启虚拟化

电脑如何查看是否支持虚拟化及如何开启虚拟化

什么是虚拟化? Intel Virtualization Technology就是以前众所周知的“Vanderpool”技术（简称VT，中文译为虚拟化技术），这种技术可以让一个CPU工作起来就像多个CPU并行运行，从而使得在一部电脑内同时运行多个操作系统成…
阅读更多...
rabbitmq-----黑马资料

rabbitmq-----黑马资料

rabbit的三种发送订阅模式 消息从发送，到消费者接收，会经理多个过程： 其中的每一步都可能导致消息丢失，常见的丢失原因包括： 发送时丢失：生产者发送的消息未送达exchange消息到达exchange后未到达queueMQ…
阅读更多...
使用Python进行食品配送时间预测

使用Python进行食品配送时间预测

一般的食品配送服务需要显示交付订单所需的准确时间，以保持与客户的透明度。这些公司使用机器学习算法来预测食品配送时间，基于配送合作伙伴过去在相同距离上花费的时间。 食品配送时间预测 为了实时预测食物的交付时间，我们需要计算食物准…
阅读更多...
[安洵杯 2019]easy_web - RCE(关键字绕过)+md5强碰撞+逆向思维

[安洵杯 2019]easy_web - RCE(关键字绕过)+md5强碰撞+逆向思维

[安洵杯 2019]easy_web 1 解题流程1.1 阶段一1.2 阶段二2 思考总结1 解题流程 1.1 阶段一 1、F12发现提示md5 is funny ~；还有img标签中，有伪协议和base64编码 2、url地址是index.php?img=TXpVek5UTTFNbVUzTURabE5qYz0&cmd= 　　这就有意思了，这里的img明显是编码后的…
阅读更多...
如何给苹果ipa和安卓apk应用APP包体修改手机屏幕上logo图标iocn？

如何给苹果ipa和安卓apk应用APP包体修改手机屏幕上logo图标iocn？

虽然修改应用文件图标是一个简单的事情，但是还是有很多小可爱是不明白的，你要是想要明白的话，那我就让你今天明白明白，我们今天采用的非常规打包方式，常规打包方式科技一下教程铺天盖地，既然小弟我出马&…
阅读更多...
阿里云华中1（武汉）本地地域公网带宽价格表

阿里云华中1（武汉）本地地域公网带宽价格表

阿里云华中1（武汉）地域上线，本地地域只有一个可用区A，高可用需要多可用区部署的应用，不建议选择本地地域，可以选择上海或杭州地域，阿里云服务器华中1（武汉）地域公网带宽价…
阅读更多...
windows下开启Telnet功能并访问百度

windows下开启Telnet功能并访问百度

Telnet 是一个实用的远程连接命令，采用的是 TCP/IP 协议。它为用户提供了在本地计算机上完成远程主机工作的能力，在终端使用者的电脑上使用 Telnet 程序，用它连接到服务器。终端使用者可以在 Telnet 程序中输入命令，这些命令会在服…
阅读更多...
并购交易：纽交所上市公司Alamo Group宣布收购皇家卡车设备公司

并购交易：纽交所上市公司Alamo Group宣布收购皇家卡车设备公司

来源：猛兽财经 作者：猛兽财经 猛兽财经获悉，纽交所上市公司Alamo Group(ALG)周二宣布已收购皇家卡车设备公司(Royal Truck & Equipment)。 皇家卡车设备公司在2022年的年收入接近4000万美元，截至2023年8月底，该公…
阅读更多...
Linux python运维

Linux python运维

Python 是一种高级编程语言，它具有简单易学、可移植性强、丰富的第三方库等特点，因此成为了广泛应用于各个领域的编程语言之一。而在 Linux 系统中，Python 的使用也十分普遍。本文将介绍如何在 Linux 系统中执行 Python 脚本并传入参数&#…
阅读更多...
Ajax使用流程

Ajax使用流程

Ajax在不刷新页面的情况下，进行页面局部更新。 Ajax使用流程： 创建XmlHttpReqeust对象发送Ajax请求处理服务器响应 1. 创建XmlHttpReqeust对象 XmlHttpReqeust对象是Ajax的核心，使用该对象发起请求，接收响应 不同的浏览器创建…
阅读更多...
【网路安全 --- Linux，window常用命令】网络安全领域，Linux和Windows常用命令，记住这些就够了，收藏起来学习吧！！

【网路安全 --- Linux，window常用命令】网络安全领域，Linux和Windows常用命令，记住这些就够了，收藏起来学习吧！！

一，Linux 1-1 重要文件目录 1-1-1 系统运行级别 /etc/inittab 1-1-2 开机启动配置文件 /etc/rc.local /etc/rc.d/rc[0~6].d## 当我们需要开机启动自己的脚本时，只需要将可执行脚本丢在 /etc/init.d 目录下，然后在 /etc/rc.d/rc*.d 中建…
阅读更多...
集成学习的小九九

集成学习的小九九

集成学习（Ensemble Learning）是一种机器学习的方法，通过结合多个基本模型的预测结果来进行决策或预测。集成学习的目标是通过组合多个模型的优势，并弥补单个模型的不足，从而提高整体性能。 集成学习的主要策略 在集成…
阅读更多...
docker 部署 xxl-job SpringBoot 整合 xxl-job 执行任务

docker 部署 xxl-job SpringBoot 整合 xxl-job 执行任务

概述 XXL-JOB是一个轻量级的分布式任务调度平台，具有以下特点： 调度模块：负责管理调度信息，发出调度请求，支持可视化和动态的操作，监控调度结果和日志，支持执行器Failover 执行模块&#xff1…
阅读更多...
地产三维实景vr展示的功能及特点

地产三维实景vr展示的功能及特点

随着科技的不断发展，VR(虚拟现实)技术也越来越成熟。VR技术的广泛应用，已经逐渐渗透到各个领域，其中引人注目的就是虚拟展馆。虚拟展馆是一种利用VR技术构建的线上展示空间，让观众可以在家中就能参观展览，带来了极大地…
阅读更多...
ctfshow萌新计划web1-5（正则匹配绕过）

ctfshow萌新计划web1-5（正则匹配绕过）

目录 web1 web2 web3 web4 web5 web1 题目注释相当于已经审计了代码 存在一个对id的检测，并且告诉我们flag在id100 这里讲三个方法 （1）payload：?id10*100 （2）使用or来绕过 payload：?…
阅读更多...
Jetpack：005-文本组件的扩展

Jetpack：005-文本组件的扩展

文章目录 1. 概念介绍2. 使用方法2.1 可以选择的文本2.2 可以点击的文本2.3 多种形式的文本 3. 示例代码4. 内容总结 我们在上一章回中介绍了Jetpack中文本组件的使用方法，本章回中主要介绍 文本组件的扩展。闲话休提，让我们一起Talk Android Jetpack吧…
阅读更多...
【深度学习实验】循环神经网络（二）：使用循环神经网络（RNN）模型进行序列数据的预测

【深度学习实验】循环神经网络（二）：使用循环神经网络（RNN）模型进行序列数据的预测

目录 一、实验介绍 二、实验环境 1. 配置虚拟环境 2. 库版本介绍 三、实验内容 0. 导入必要的工具包 1. RNN模型 a. 初始化__init__ b. 前向传播方法forward 2. 训练和预测 a. 超参数 b. 创建模型实例 c. 模型训练 d. 预测结果可视化 3. 代码整合 经验是智慧之父…
阅读更多...
云服务器带宽对上传下载速度的影响

云服务器带宽对上传下载速度的影响

简单来说就是 云服务器收到数据代表入&#xff0c;带宽大小 < 10时&#xff0c;入带宽大小10 带宽大小 > 10时&#xff0c;出入带宽上限 等于实际购买时候的大小
阅读更多...
2023Linux C/C++全栈开发知识技术合集（基础入门到高级进阶）

2023Linux C/C++全栈开发知识技术合集（基础入门到高级进阶）

C/Linux服务器开发」别名可以叫「C后台开发」,目前BAT里面都是有大量的C开发岗位&#xff0c;鹅厂在c后台开发岗都是急需。虽然岗位对技术要求难度系数较高&#xff0c;但是有大厂情结的朋友们还是可以冲一冲的。 很多有c/c语言基础的朋友&#xff0c;在面试后台岗的时候都会有…
阅读更多...
Response Status Code 301、302

Response Status Code 301、302

目录 Information Django redirect Influence Information HTTP状态码301、302和304分别表示以下情况&#xff1a; codeinformation301&#xff08;Moved Permanently&#xff09; 永久重定向。当请求的资源已经被永久地移动到了一个新的URI时&#xff0c;服务器会返回这个…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023