gin参数验证

已于 2024-01-24 20:42:37 修改
阅读量655 收藏 8
点赞数 6
分类专栏： gin从入门到实践 文章标签： gin xcode golang
于 2024-01-20 17:01:14 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/liu289747235/article/details/135718318
版权

1. 结构体验证

用gin框架的数据验证，可以不用解析数据，减少if else，会简洁许多。

package main

import (
    "fmt"
    "time"

    "github.com/gin-gonic/gin"
)

//Person ..
type Person struct {
    //不能为空并且大于10
    Age      int       `form:"age" binding:"required,gt=10"`
    Name     string    `form:"name" binding:"required"`
    Birthday time.Time `form:"birthday" time_format:"2006-01-02" time_utc:"1"`
}

func main() {
    r := gin.Default()
    r.GET("/5lmh", func(c *gin.Context) {
        var person Person
        if err := c.ShouldBind(&person); err != nil {
            c.String(500, fmt.Sprint(err))
            return
        }
        c.String(200, fmt.Sprintf("%#v", person))
    })
    r.Run()
}

2. 自定义验证

都在代码里自己看吧

package main

import (
    "net/http"
    "reflect"
    "github.com/gin-gonic/gin"
    "github.com/gin-gonic/gin/binding"
    "gopkg.in/go-playground/validator.v8"
)

/*
    对绑定解析到结构体上的参数，自定义验证功能
    比如我们要对 name 字段做校验，要不能为空，并且不等于 admin ，类似这种需求，就无法 binding 现成的方法
    需要我们自己验证方法才能实现 官网示例（https://godoc.org/gopkg.in/go-playground/validator.v8#hdr-Custom_Functions）
    这里需要下载引入下 gopkg.in/go-playground/validator.v8
*/
type Person struct {
    Age int `form:"age" binding:"required,gt=10"`
    // 2、在参数 binding 上使用自定义的校验方法函数注册时候的名称
    Name    string `form:"name" binding:"NotNullAndAdmin"`
    Address string `form:"address" binding:"required"`
}

// 1、自定义的校验方法
func nameNotNullAndAdmin(v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value, field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string) bool {

    if value, ok := field.Interface().(string); ok {
        // 字段不能为空，并且不等于  admin
        return value != "" && !("5lmh" == value)
    }

    return true
}

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

    // 3、将我们自定义的校验方法注册到 validator中
    if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
        // 这里的 key 和 fn 可以不一样最终在 struct 使用的是 key
        v.RegisterValidation("NotNullAndAdmin", nameNotNullAndAdmin)
    }

    /*
        curl -X GET "http://127.0.0.1:8080/testing?name=&age=12&address=beijing"
        curl -X GET "http://127.0.0.1:8080/testing?name=lmh&age=12&address=beijing"
        curl -X GET "http://127.0.0.1:8080/testing?name=adz&age=12&address=beijing"
    */
    r.GET("/5lmh", func(c *gin.Context) {
        var person Person
        if e := c.ShouldBind(&person); e == nil {
            c.String(http.StatusOK, "%v", person)
        } else {
            c.String(http.StatusOK, "person bind err:%v", e.Error())
        }
    })
    r.Run()
}

示例2：

package main

import (
    "net/http"
    "reflect"
    "time"

    "github.com/gin-gonic/gin"
    "github.com/gin-gonic/gin/binding"
    "gopkg.in/go-playground/validator.v8"
)

// Booking contains binded and validated data.
type Booking struct {
    //定义一个预约的时间大于今天的时间
    CheckIn time.Time `form:"check_in" binding:"required,bookabledate" time_format:"2006-01-02"`
    //gtfield=CheckIn退出的时间大于预约的时间
    CheckOut time.Time `form:"check_out" binding:"required,gtfield=CheckIn" time_format:"2006-01-02"`
}

func bookableDate(
    v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value,
    field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string,
) bool {
    //field.Interface().(time.Time)获取参数值并且转换为时间格式
    if date, ok := field.Interface().(time.Time); ok {
        today := time.Now()
        if today.Unix() > date.Unix() {
            return false
        }
    }
    return true
}

func main() {
    route := gin.Default()
    //注册验证
    if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
        //绑定第一个参数是验证的函数第二个参数是自定义的验证函数
        v.RegisterValidation("bookabledate", bookableDate)
    }

    route.GET("/5lmh", getBookable)
    route.Run()
}

func getBookable(c *gin.Context) {
    var b Booking
    if err := c.ShouldBindWith(&b, binding.Query); err == nil {
        c.JSON(http.StatusOK, gin.H{"message": "Booking dates are valid!"})
    } else {
        c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
    }
}

// curl -X GET "http://localhost:8080/5lmh?check_in=2019-11-07&check_out=2019-11-20"
// curl -X GET "http://localhost:8080/5lmh?check_in=2019-09-07&check_out=2019-11-20"
// curl -X GET "http://localhost:8080/5lmh?check_in=2019-11-07&check_out=2019-11-01"

3. 多语言翻译验证

当业务系统对验证信息有特殊需求时，例如：返回信息需要自定义，手机端返回的信息需要是中文而pc端发挥返回的信息需要时英文，如何做到请求一个接口满足上述三种情况。

package main

import (
    "fmt"

    "github.com/gin-gonic/gin"
    "github.com/go-playground/locales/en"
    "github.com/go-playground/locales/zh"
    "github.com/go-playground/locales/zh_Hant_TW"
    ut "github.com/go-playground/universal-translator"
    "gopkg.in/go-playground/validator.v9"
    en_translations "gopkg.in/go-playground/validator.v9/translations/en"
    zh_translations "gopkg.in/go-playground/validator.v9/translations/zh"
    zh_tw_translations "gopkg.in/go-playground/validator.v9/translations/zh_tw"
)

var (
    Uni      *ut.UniversalTranslator
    Validate *validator.Validate
)

type User struct {
    Username string `form:"user_name" validate:"required"`
    Tagline  string `form:"tag_line" validate:"required,lt=10"`
    Tagline2 string `form:"tag_line2" validate:"required,gt=1"`
}

func main() {
    en := en.New()
    zh := zh.New()
    zh_tw := zh_Hant_TW.New()
    Uni = ut.New(en, zh, zh_tw)
    Validate = validator.New()

    route := gin.Default()
    route.GET("/5lmh", startPage)
    route.POST("/5lmh", startPage)
    route.Run(":8080")
}

func startPage(c *gin.Context) {
    //这部分应放到中间件中
    locale := c.DefaultQuery("locale", "zh")
    trans, _ := Uni.GetTranslator(locale)
    switch locale {
    case "zh":
        zh_translations.RegisterDefaultTranslations(Validate, trans)
        break
    case "en":
        en_translations.RegisterDefaultTranslations(Validate, trans)
        break
    case "zh_tw":
        zh_tw_translations.RegisterDefaultTranslations(Validate, trans)
        break
    default:
        zh_translations.RegisterDefaultTranslations(Validate, trans)
        break
    }

    //自定义错误内容
    Validate.RegisterTranslation("required", trans, func(ut ut.Translator) error {
        return ut.Add("required", "{0} must have a value!", true) // see universal-translator for details
    }, func(ut ut.Translator, fe validator.FieldError) string {
        t, _ := ut.T("required", fe.Field())
        return t
    })

    //这块应该放到公共验证方法中
    user := User{}
    c.ShouldBind(&user)
    fmt.Println(user)
    err := Validate.Struct(user)
    if err != nil {
        errs := err.(validator.ValidationErrors)
        sliceErrs := []string{}
        for _, e := range errs {
            sliceErrs = append(sliceErrs, e.Translate(trans))
        }
        c.String(200, fmt.Sprintf("%#v", sliceErrs))
    }
    c.String(200, fmt.Sprintf("%#v", "user"))
}

正确的链接：http://localhost:8080/testing?user_name=枯藤&tag_line=9&tag_line2=33&locale=zh

http://localhost:8080/testing?user_name=枯藤&tag_line=9&tag_line2=3&locale=en 返回英文的验证信息

http://localhost:8080/testing?user_name=枯藤&tag_line=9&tag_line2=3&locale=zh 返回中文的验证信息

参考文章：

https://www.fansimao.com/928916.html

https://www.fansimao.com/928933.html

流光影下
关注
  • 6
    点赞
  • 踩
  • 8
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
gin+skywalking demo源码
08-04
中间件函数接收一个 `gin.Context` 参数，可以在请求处理链中进行操作。 2. SkyWalking 基础 - SkyWalking 的核心功能是分布式追踪，它可以收集服务调用链路数据，生成调用图，从而识别性能瓶颈。 - SkyWalking ...
gin框架学习笔记(四) ——参数绑定与参数验证
最新发布
qq_73924465的博客
05-16 537
import ("reflect"Username string `json:"username" binding:"required" msg:"用户名不能为空"`Password string `json:"password" binding:"min=3,max=6" msg:"密码长度不能小于3大于6"`// GetValidMsg 返回结构体中的msg参数// 使用的时候，需要传obj的指针// 将err接口断言为具体类型ok {// 断言成功// 循环每一个错误信息。
Gin请求参数校验
追梦者的部落格
06-10 1万+
gin参数校验使用的是 validator库，因此本文的内容同样适用于使用validator来做参数校验的地方 校验规则 完整的校验规则可参考 https://godoc.org/github.com/go-playground/validator,下面分享常用的校验规则规则： 数字值限制 注：如果限制之间存在冲突，如 eq=10,ne=10，则会根据先后顺序，后面的会覆盖前面的定义，已后面定义的为准，eq=10,ne=10定义方式，只会生效ne=10 限制范围 max=10 # 最大值为1.
gin中使用validator做参数校验
liu289747235的专栏
01-23 1886
RePassword是我们后端定义的结构体中的字段名，而请求中使用的是字段。如何是错误提示中的字段使用自定义的名称，例如jsontag指定的值呢？只需要在初始化翻译器的时候像下面一样添加一个获取jsontag的自定义方法即可。// InitTrans 初始化翻译器// 修改gin框架中的Validator引擎属性，实现自定制ok {// 注册一个获取json tag的自定义方法return ""})zhT := zh.New() // 中文翻译器。
学会gin参数校验之validator库，看这一篇就足够了
热门推荐
qq_39397165的博客
08-22 1万+
前言 哈喽，大家好，我是asong。这是我的第十篇原创文章。这周在公司做项目，在做API部分开发时，需要对请求参数的校验，防止用户的恶意请求。例如日期格式，用户年龄，性别等必须是正常的值，不能随意设置。最开始在做这一部分的时候，我采用老方法，自己编写参数检验方法，统一进行参数验证。后来在同事CR的时候，说GIN有更好的参数检验方法，gin框架使用github.com/go-playground/validator进行参数校验，我们只需要在定义结构体时使用binding或validatetag标识相关校验规则
gin 参数验证
qq_29744347的博客
07-25 2461
gin的参数验证
gin参数,校验validator库
乐观的阿锡的博客
08-23 4621
包验证器 包验证器基于标签为结构和单个字段实现值验证。 它具有以下独特的功能： 使用验证标签或自定义验证器进行跨字段和跨结构验证。 切片、数组和映射潜水，允许验证多维字段的任何或所有级别。 能够深入研究映射键和值以进行验证 通过在验证之前确定它的基础类型来处理类型接口。 处理自定义字段类型，例如 sql 驱动程序 Valuer 请参阅Valuer 别名验证标签，允许将多个验证映射到单个标签，以便更轻松地定义结构上的验证 提取自定义定义的字段名称，例如可以指定在验证时提取 JSON 名称并使其在结果 Fie
Go语言中的gin框架之GET/POST请求参数接收传值（五）
06-15
在实际应用中，你可能还需要处理错误，验证参数，并根据需要添加中间件进行日志记录、权限控制等操作。 此外，`templates`目录通常用于存放HTML模板文件，用于渲染动态网页。Gin框架内置了对模板引擎的支持，你可以...
Golang-Gin框架示例二十多个源码
04-26
此外，Gin支持参数绑定，包括路径参数、查询参数和POST表单数据。例如： ```go ginEngine.GET("/user/:id", func(c *gin.Context) { id := c.Param("id") c.String(200, "User ID is: %s", id) }) ``` 这里的`:id...
golang gin简单基础框架
09-18
Gin 中间件是处理请求的关键部分，它可以记录日志、验证身份、处理跨域等问题。一个中间件就是一个接收 `*gin.Context` 的函数： ```go func Logger() gin.HandlerFunc { return func(c *gin.Context) { // 记录...
golang validator参数校验的实现
12-16
今天在改后台页面，参数校验错误时输出全是英文，使用着很难看懂到底时什么错了 故而决定去做i18n前端国际化. 改的时候踩了很多坑，故而记录一下，顺便记录以下查问题的方式。 效果 从原来的Title is required变为标题为必填字段 完成后的代码: 这里主要定义了初始化了一个中文的trans和Validate的变量，并对其做初始化 初始化主要做了以下事情: 注册了TagName函数 // RegisterTagNameFunc registers a function to get alternate names for StructFields. 这个方法主要就是提供一个tag的解
Gin（gin-1.9.1.zip ）
08-28
在 Gin 中，中间件是一个接收一个 `c *gin.Context` 参数的函数，它可以在请求被处理之前或之后执行。你可以自定义中间件，或者使用内置的如日志记录、GZIP 压缩、身份验证等功能。中间件的顺序很重要，因为它们会...
Gin 使用 validator 实现参数校验
Dablelv 的博客专栏。
07-15 1689
大咖好呀，我是恋喵大鲤鱼。编写接口时，你还在为接口入参编写类似如下繁琐的校验逻辑吗？= "baz" {实现接口时，一个好的习惯是基于不信任原则，对入参进行合法性校验。第一时间，你想到的便是自己手写代码完成接口入参校验。但是手写这些重复繁琐的校验代码，不仅低效，而且还使代码变得臃肿难看，不够美观。这种所有开发人员都要做的事情应该被收敛到一个地方完成，避免重复开发。这便是参数验证器要做的事情。
参数校验---gin框架内置使用validator
zhaozuoyou的博客
11-11 2267
go参数校验
gin binding方法参数校验
General_zy的博客
11-19 2472
上面的错误提示看起来是可以了，但是还是差点意思，首先是错误提示中的字段并不是请求中使用的字段，例如：RePassword是我们后端定义的结构体中的字段名，而请求中使用的是re_password字段。只需要在初始化翻译器的时候像下面一样添加一个获取json tag的自定义方法即可。// InitTrans 初始化翻译器 func InitTrans(locale string)(err error) {
【Go实战基础】gin 如何验证请求参数
菜鸟实战的博客
06-20 1211
gin 路由 结构体 结构体参数绑定 参数验证 http 状态码
gin参数绑定
05-24
在Gin框架中，参数绑定是将HTTP请求中的数据绑定到Go结构体中的过程。Gin框架支持多种参数绑定方式，包括将查询字符串参数绑定到结构体字段、将POST表单数据绑定到结构体字段、将JSON数据绑定到结构体字段等。 以下是一个示例，展示如何在Gin框架中使用参数绑定： ```go type User struct { Name string `form:"name"` Password string `form:"password"` } func main() { r := gin.Default() r.POST("/login", func(c *gin.Context) { var user User if err := c.ShouldBind(&user); err != nil { c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()}) return } // TODO: 验证用户名和密码 c.JSON(http.StatusOK, gin.H{"message": "登录成功"}) }) r.Run() // 启动服务 } ``` 在上面的示例中，我们定义了一个`User`结构体，并使用`form`标签指定了每个字段对应的查询字符串参数名。在处理`/login`路由时，我们使用`ShouldBind`方法将HTTP请求中的数据绑定到`User`结构体中，如果绑定失败，则返回一个错误响应。如果绑定成功，则可以使用`User`结构体中的字段进行用户名和密码验证，并返回成功响应。 需要注意的是，Gin框架使用了`ShouldBind`方法来实现参数绑定，这个方法会自动根据HTTP请求的Content-Type字段来选择绑定方式。如果Content-Type为application/json，则会将JSON数据绑定到结构体中；如果Content-Type为application/x-www-form-urlencoded，则会将POST表单数据绑定到结构体中，以此类推。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

流光影下

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值