Gin框架系列之数据校验

一、基本使用

在前面的文章中说明了数据绑定，就是将传递的参数绑定到结构体上，避免一个个的通过方法去获取，那么又该如何对传递的参数值进行校验呢？

可以在结构体上打上标签：

type LoginInfo struct {
    UserName string `form:"username" json:"username" binding:"required"`
    PassWord string `form:"password" json:"password" binding:"required"`
}

如果前端提交的是form数据，则会进行form标签的校验；如果提交的是json数据，则会进行json标签的的校验。

前端：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<form action="/do_index" method="post">
    用户名：<input type="text" name="username"> <br>
    密  码：<input type="password" name="password"> <br>
    <input type="submit">
</form>
</body>
</html>

后端：

package main

import (
    "fmt"
    "github.com/gin-gonic/gin"
    "net/http"
)

type LoginInfo struct {
    UserName string `form:"username" json:"username" binding:"required"`
    PassWord string `form:"password" json:"password" binding:"required"`
}

func Index(ctx *gin.Context) {
    ctx.HTML(http.StatusOK, "index.html", nil)
}

func DoIndex(ctx *gin.Context) {
    var loginInfo LoginInfo
    err := ctx.ShouldBind(&loginInfo)
    if err != nil {
        fmt.Println(err)
        ctx.JSON(400, gin.H{
            "msg":  "fail",
            "code": 400,
        })
    }

    ctx.JSON(200, gin.H{
        "msg":  "success",
        "code": 200,
    })
}

func main() {
    router := gin.Default()

    router.LoadHTMLGlob("template/*")

    router.GET("/index", Index)
    router.POST("/do_index", DoIndex)

    router.Run(":8080")
}

二、验证器

1、什么是验证器

type LoginInfo struct {
    UserName string `form:"username" json:"username" binding:"required"`
    PassWord string `form:"password" json:"password" binding:"required"`
}

在上面的UserName和PassWord字段的标签中通过binding进行绑定不同的校验规则，binding后面的就是验证器，可以拥有多个，不同之间使用逗号分隔。如：

type LoginInfo struct {
    UserName string `form:"username" json:"username" binding:"required,min=5,max=10"` // 表示该字段不能为空，并且最小长度为5，最大长度为10

}

2、常用验证器

required：必填字段，如：binding:"required"
min 最小长度，如：binding:"min=5"
max 最大长度，如：binding:"max=10"
len 长度，如：binding:"len=6"
eq 等于，如：binding:"eq=3"
ne 不等于，如：binding:"ne=12"
gt 大于，如：binding:"gt=10"
gte 大于等于，如：binding:"gte=10"
lt 小于，如：binding:"lt=10"
lte 小于等于，如：binding:"lte=10"
eqfield 等于其他字段的值，如：PassWord string `binding:"eqfield=ConfirmPassword"`
nefield 不等于其他字段的值
- 忽略字段，如：binding:"-"
| 或，如：binding:"rgb|rgba"

三、自定义验证器

1、安装依赖

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

2、定义验证器

package handler

import "github.com/go-playground/validator"

var CustomValid validator.Func = func(fl validator.FieldLevel) bool {

    data := fl.Field().Interface().(string)

    if len(data) > 3 {
        return false
    } else {
        return true
    }
}

3、注册验证器

在路由匹配之前进行注册：

func main() {

    router := gin.Default()

    if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
        v.RegisterValidation("len_valid", handler.CustomValid)
    }

    router.LoadHTMLGlob("template/*")

    // 数据校验
    router.GET("/valid_index", ValidIndex)
    router.POST("/do_valid_index", DoValidIndex)

    router.Run(":8080")

}

4、使用验证器

type LoginInfo struct {
    UserName string `form:"username" json:"username" binding:"len_valid"`
    PassWord string `form:"password" json:"password" binding:"len_valid"`
}

四、beego验证器

（一）简单使用

1、安装依赖

go get github.com/astaxie/beego/validation

2、结构体中使用

验证函数写在 "valid" tag 的标签里
各个验证规则之间用分号 ";" 分隔，分号后面可以有空格
参数用括号 "()" 括起来，多个参数之间用逗号 "," 分开，逗号后面可以有空格
正则函数(Match)的匹配模式用两斜杠 "/" 括起来
各个函数的结果的 key 值为字段名.验证函数名

如下：

type LoginInfo struct {
    UserName string `form:"username" json:"username" valid:"Required"`
    PassWord string `form:"password" json:"password" valid:"Required"`
}

3、使用方式

绑定结构体变量
初始化beego验证器
进行验证

func DoValidIndex(ctx *gin.Context) {
    // 1、声明结构体变量
    var loginInfo LoginInfo
    // 2、绑定结构体变量
    _ = ctx.ShouldBind(&loginInfo)
    // 3、初始化beego验证器
    valid := validation.Validation{}
    // 4、开始验证
    b, _ := valid.Valid(&loginInfo)
    if !b {
        // 5、输出未验证通过的错误信息
        // UserName.Required. can not be empty
        // PassWord.Required. can not be empty
        for _, err1 := range valid.Errors {
            fmt.Println(err1.Key)
            fmt.Println(err1.Message)
        }
    }
    fmt.Printf("UserName:%s,PassWord:%s", loginInfo.UserName, loginInfo.PassWord)
    ctx.String(http.StatusOK, "submit success!")
}

（二）验证方法

在beego中验证的方法有很多，比如上面的Requird方法，另外还有下面的常用方式：

Required 不为空，即各个类型要求不为其零值
Min(min int) 最小值，有效类型：int，其他类型都将不能通过验证
Max(max int) 最大值，有效类型：int，其他类型都将不能通过验证
Range(min, max int) 数值的范围，有效类型：int，他类型都将不能通过验证
MinSize(min int) 最小长度，有效类型：string slice，其他类型都将不能通过验证
MaxSize(max int) 最大长度，有效类型：string slice，其他类型都将不能通过验证
Length(length int) 指定长度，有效类型：string slice，其他类型都将不能通过验证
Alpha alpha字符，有效类型：string，其他类型都将不能通过验证
Numeric 数字，有效类型：string，其他类型都将不能通过验证
AlphaNumeric alpha 字符或数字，有效类型：string，其他类型都将不能通过验证
Match(pattern string) 正则匹配，有效类型：string，其他类型都将被转成字符串再匹配(fmt.Sprintf(“%v”, obj).Match)
AlphaDash alpha 字符或数字或横杠 -_，有效类型：string，其他类型都将不能通过验证
Email 邮箱格式，有效类型：string，其他类型都将不能通过验证
IP IP 格式，目前只支持 IPv4 格式验证，有效类型：string，其他类型都将不能通过验证
Base64 base64 编码，有效类型：string，其他类型都将不能通过验证
Mobile 手机号，有效类型：string，其他类型都将不能通过验证
Tel 固定电话号，有效类型：string，其他类型都将不能通过验证
Phone 手机号或固定电话号，有效类型：string，其他类型都将不能通过验证
ZipCode 邮政编码，有效类型：string，其他类型都将不能通过验证

（三）自定制错误信息

在验证未通过时会提示错误信息，但是是英文的提示，如何将其转变成自己想要显示的信息呢？我们只需要在第4步开始验证之前重写一下错误信息提示即可：

...
    // 3、初始化beego验证器
    valid := validation.Validation{}
    // 定制错误信息
    var messages = map[string]string{
        "Required": "不能为空",
        "MinSize":  "最短长度为 %d",
        "Length":   "长度必须为 %d",
        "Numeric":  "必须是有效的数字",
        "Email":    "必须是有效的电子邮件地址",
        "Mobile":   "必须是有效的手机号码",
    }
    validation.SetDefaultMessage(messages)

    // 4、开始验证
    b, _ := valid.Valid(&loginInfo)
...

posted @ 2022-05-02 10:59 iveBoy 阅读(3093) 评论(0) 编辑收藏举报

刷新页面返回顶部

iveBoy

Gin框架系列之数据校验

一、基本使用

二、验证器

1、什么是验证器

2、常用验证器

三、自定义验证器

1、安装依赖

2、定义验证器

3、注册验证器

4、使用验证器

四、beego验证器

（一）简单使用

1、安装依赖

2、结构体中使用

3、使用方式

（二）验证方法

（三）自定制错误信息

公告