当前位置：首页 > article >正文

Gin 验证器详解与案例分析

article 2024/9/19 22:41:49

在Go语言的Web开发中，Gin框架因其高性能和简洁的API而受到广泛欢迎。Gin框架内置了强大的验证器，可以方便地对请求数据进行校验。本文将详细介绍Gin验证器的使用方法和案例，并通过一个综合案例展示如何在实际项目中应用这些验证规则。

1. 基础验证规则

1.1 必填字段

使用binding:"required"标记字段为必填。

案例：

type UserInfo struct {
	Name string `form:"name" json:"name" binding:"required"`
}

1.2 长度限制

min: 最小长度
max: 最大长度
len: 固定长度

案例：

type UserInfo struct {
	Password string `form:"password" json:"password" binding:"min=6,max=20"`
}

1.3 数值比较

eq: 等于
ne: 不等于
gt: 大于
gte: 大于等于
lt: 小于
lte: 小于等于

案例：

type UserInfo struct {
	Age int `form:"age" json:"age" binding:"gte=18"`
}

1.4 字段比较

eqfield: 等于其他字段
nefield: 不等于其他字段

案例：

type UserInfo struct {
	Password   string `form:"password" json:"password" binding:""`
	RePassword string `form:"rePassword" json:"rePassword" binding:"eqfield=Password"`
}

2. 字符串验证规则

2.1 包含与排除

contains: 包含特定字符串
excludes: 不包含特定字符串
startswith: 字符串前缀
endswith: 字符串后缀

案例：

type UserInfo struct {
	Name string `form:"name" json:"name" binding:"contains=demo"`
}

2.2 枚举类型

使用oneof指定字段必须是枚举中的一个值。

案例：

type UserInfo struct {
	Sex string `form:"sex" json:"sex" binding:"oneof=man woman"`
}

3. 数组验证

3.1 针对数组元素的验证

使用dive对数组中的每个元素进行验证。

案例：

type UserInfo struct {
	LikeList []string `form:"likeList" json:"likeList" binding:"required,dive,startswith=i"`
}

4. 网络验证

4.1 IP地址验证

ip: 验证IP地址
ipv4: 验证IPv4地址
ipv6: 验证IPv6地址

案例：

type UserInfo struct {
	IP string `form:"ip" json:"ip" binding:"ipv4"`
}

4.2 URL验证

uri: 统一资源标识符
url: 统一资源定位符

案例：

type UserInfo struct {
	URL string `form:"url" json:"url" binding:"url"`
}

5. 日期验证

5.1 日期格式验证

使用datetime指定日期格式。

案例：

type UserInfo struct {
	Date string `form:"date" json:"date" binding:"datetime=2006-01-02"`
}

6. 综合案例

以下是一个综合案例，展示了如何在实际项目中应用上述验证规则。

package main

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

type SignUserInfo struct {
	Name       string   `form:"name" json:"name" binding:"required"`
	NickName   string   `form:"nickName" json:"nickName" binding:"contains=m"`
	Age        int      `form:"age" json:"age" binding:"lt=30,gt=18"`
	Password   string   `form:"password" json:"password" binding:""`
	RePassword string   `form:"rePassword" json:"rePassword" binding:"eqfield=Password"`
	Sex        string   `form:"sex" json:"sex" binding:"oneof=man woman"`
	LikeList   []string `form:"likeList" json:"likeList" binding:"required,dive,startswith=i"`
	IP         string   `form:"ip" json:"ip" binding:"ip"`
	URL        string   `form:"url" json:"url" binding:"url"`
	Date       string   `form:"date" json:"date" binding:"datetime=2006-01-01 00:00:00"`
}

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

	router.POST("/", func(c *gin.Context) {
		var user SignUserInfo
		err := c.ShouldBind(&user)
		if err != nil {
			fmt.Println(err)
			c.JSON(http.StatusOK, gin.H{"msg": err.Error()})
			return
		}
		c.JSON(http.StatusOK, gin.H{"msg": "注册成功", "user": user})
	})

	router.Run(":8080")
}