go语言后端开发学习(三)——基于validator包实现接口校验

简介: go语言后端开发学习(三)——基于validator包实现接口校验

前言

在我们开发模块的时候,有一个问题是我们必须要去考虑的,它就是如何进行入参校验,在gin框架的博客中我就介绍过一些常见的参数校验,大家可以参考gin框架学习笔记(四) ——参数绑定与参数验证,而这个其实也不是能够完全应对我们在日常开发中的需要,而今天我们要介绍的就是如何基于validator这个第三方库来实现对接口入参的校验,话不多说,开始发车!

validator包的下载

go get github.com/go-playground/validator/v10

validator的使用

背景介绍

在讲解validator包的使用方式之前我们先来看一个应用场景:博主最近在写自己的博客网站,而博客网站中有一个问题,我们先来看一下表结构:

type User struct {
  gorm.Model
  Username string `gorm:"type:varchar(20)" json:"username"`
  Password string `gorm:"type:varchar(100)" json:"password"`
  Role     int    `gorm:"type:int;default:2" json:"role"`
}

在博客中我设置了两种角色管理员(role=1)普通用户(role=2),而这也造成了一个问题:我们在添加用户按照正常业务情况是不能直接在前台创建管理员,而这个就需要我们在后端进行参数校验了(备注:其实参数校验这件事前后端都是要做的,但是我们这里介绍主要是后端,就以后端视角来介绍了),而接下来我们以给这个用户模块做参数校验为例,来介绍一下我们如何来实现参数校验以及一些其他的相关操作。

为数据模型添加校验条件

type User struct {
  gorm.Model
  Username string `gorm:"type:varchar(20)" json:"username" validate:"required,min=4,max=12"`
  Password string `gorm:"type:varchar(100)" json:"password" validate:"required,min=6 max=20"`
  Role     int    `gorm:"type:int;default:2" json:"role" validate:"required,gte=2"`
}

如上我们利用validate字段指明了数据的验证规则

拓展bindingvalidate的区别:

"validate"通常用于描述数据的验证规则,用于确保输入的数据符合特定的格式、要求或约束。验证通常在
数据提交之前进行,以确保数据的完整性和准确性。
而"binding"通常用于描述数据的绑定规则,用于将用户界面元素与数据模型进行关联。数据绑定确保用户输
入的数据与数据模型的字段正确地同步,使用户界面的更改能够反映在数据模型中,或反之亦然。因此,
"validate"主要关注数据的验证和校验,而"binding"主要关注数据在用户界面元素和数据模型之间的绑定
和同步

编写数据校验模块

我先示范一下数据消炎模块的书写,然后我再给大家具体讲解一下代码,首先我们来看一下最终我们所定义的User数据模型:

type User struct {
  gorm.Model
  Username string `gorm:"type:varchar(20)" json:"username" validate:"required,min=4,max=12" label:"用户名"`
  Password string `gorm:"type:varchar(100)" json:"password" validate:"required,min=6,max=20" label:"密码"`
  Role     int    `gorm:"type:int;default:2" json:"role" validate:"required,gte=2" label:"角色码"`
}

这里主要添加了两个标签:

  • validate:用来记录我们做入参验证的时候所做的限制条件
  • label:作为标记来返回标签值作为字段的名称

我们再来看校验模块的源代码:

package validator
import (
  "fmt"
  "gin_vue_blog/utils/errmsg"
  "github.com/go-playground/locales/zh_Hans_CN"
  ut "github.com/go-playground/universal-translator"
  "github.com/go-playground/validator/v10"
  "github.com/go-playground/validator/v10/translations/zh"
  "reflect"
)
func Validator(data any) (string, int) {
  validate := validator.New()
  uni := ut.New(zh_Hans_CN.New())
  trans, _ := uni.GetTranslator("zh_Hans_CN")
  err := zh.RegisterDefaultTranslations(validate, trans) // 注册翻译器
  if err != nil {
    fmt.Println("err:", err)
  }
  validate.RegisterTagNameFunc(func(field reflect.StructField) string {
    label := field.Tag.Get("label") // 获取label标签
    return label
  })
  err = validate.Struct(data)
  if err != nil {
    for _, err := range err.(validator.ValidationErrors) {
      return err.Translate(trans), errmsg.ERROR
    }
  }
  return "", errmsg.SUCCESS
}

我们可以来测试一下这段代码,效果如下:

我们可以看到我们成功实现了数据的校验功能,我们来看一下这一整个过程:

  1. 初始化valitor
validate := validator.New()
  1. 编写中间件,实现国际化
    validator中其默认的错误信息是英文,一定程度上会影响我们阅读,我们可以尝试将其转换为其他语言,这里我选择转换为简体中文:
uni := ut.New(zh_Hans_CN.New())
  trans, _ := uni.GetTranslator("zh_Hans_CN")
  err := zh.RegisterDefaultTranslations(validate, trans) // 注册翻译器
  if err != nil {
    fmt.Println("err:", err)
  }
  1. 进行数据校验并返回错误消息
err = validate.Struct(data)
if err != nil {
  for _, err := range err.(validator.ValidationErrors) {
    return err.Translate(trans), errmsg.ERROR
  }
}
return "", errmsg.SUCCESS
}

就这样我们就实现了一个通用的数据校验模块了。

目录
打赏
0
0
1
0
13
分享
相关文章
【01】对APP进行语言包功能开发-APP自动识别地区ip后分配对应的语言功能复杂吗?-成熟app项目语言包功能定制开发-前端以uniapp-基于vue.js后端以laravel基于php为例项目实战-优雅草卓伊凡
【01】对APP进行语言包功能开发-APP自动识别地区ip后分配对应的语言功能复杂吗?-成熟app项目语言包功能定制开发-前端以uniapp-基于vue.js后端以laravel基于php为例项目实战-优雅草卓伊凡
163 72
【01】对APP进行语言包功能开发-APP自动识别地区ip后分配对应的语言功能复杂吗?-成熟app项目语言包功能定制开发-前端以uniapp-基于vue.js后端以laravel基于php为例项目实战-优雅草卓伊凡
Go语言包与模块(module)的基本使用-《Go语言实战指南》
本章深入讲解Go语言中的包(Package)和模块(Module)概念。包是代码组织的最小单位,每个`.go`文件属于一个包,通过`import`实现复用;主程序包需命名为`main`。模块是Go 1.11引入的依赖管理机制,支持自动版本管理和私有/远程仓库,无需依赖GOPATH。通过实际示例,如自定义包`mathutil`和第三方模块`gin`的引入,展示其使用方法。常用命令包括`go mod init`、`go mod tidy`等,帮助开发者高效管理项目依赖。最后总结,包负责功能划分,模块实现现代化依赖管理,提升团队协作效率。
百炼-千问模型通过openai接口构建assistant 等 go语言
由于阿里百炼平台通义千问大模型没有完善的go语言兼容openapi示例,并且官方答复assistant是不兼容openapi sdk的。 实际使用中发现是能够支持的,所以自己写了一个demo test示例,给大家做一个参考。
Go语言中的包(package)是如何组织的?
在Go语言中,包是代码组织和管理的基本单元,用于集合相关函数、类型和变量,便于复用和维护。包通过目录结构、文件命名、初始化函数(`init`)及导出规则来管理命名空间和依赖关系。合理的包组织能提高代码的可读性、可维护性和可复用性,减少耦合度。例如,`stringutils`包提供字符串处理函数,主程序导入使用这些函数,使代码结构清晰易懂。
225 11
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
本文介绍了如何在 VSCode 中禁用点击 Go 包名时自动打开浏览器跳转到 pkg.go.dev 的功能。通过将 gopls 的 `ui.navigation.importShortcut` 设置为 "Definition",可以实现仅跳转到定义处而不打开链接。具体操作步骤包括:打开设置、搜索 gopls、编辑 settings.json 文件并保存更改,最后重启 VSCode 使设置生效。
175 8
怎么禁用 vscode 中点击 go 包名时自动打开浏览器跳转到 pkg.go.dev
Go nil 空结构体 空接口有什么区别?
本文介绍了Go语言中的`nil`、空结构体和空接口的区别。`nil`是预定义的零值变量,适用于指针、管道等类型;空结构体大小为0,多个空结构体实例指向同一地址;空接口由`_type`和`data`字段组成,仅当两者均为`nil`时,空接口才为`nil`。
113 1
Go nil 空结构体 空接口有什么区别?
|
6月前
|
go语言使用strings包
go语言使用strings包
129 3
go语言中导入相关包
【11月更文挑战第1天】
82 3
|
7月前
|
后端使用的语言是什么?
【10月更文挑战第12天】后端使用的语言是什么?
268 14
|
7月前
|
后端语言
【10月更文挑战第12天】后端语言
118 5
AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等