[系列] Gin框架 - 資料繫結和驗證

概述

上篇文章分享了 Gin 框架使用 Logrus 進行日誌記錄，這篇文章分享 Gin 框架的資料繫結與驗證。

有讀者諮詢我一個問題，如何讓框架的執行日誌不輸出控制檯？

解決方案：

engine := gin.Default() //修改成如下
engine := gin.New()

我是怎麼知道的？看框架程式碼。

Default()：

func Default() *Engine {
    debugPrintWARNINGDefault()
    engine := New()
    engine.Use(Logger(), Recovery())
    return engine
}

New() 程式碼我就不貼了。

我們看到 Default() 使用了兩個中介軟體 Logger(), Recovery()，如果不想使用，那就直接使用 New() 就可以了。

開始今天的文章。

比如，請求 v1/member/add 新增會員方法，name、age 為必填，同時 name 不能等於 admin 字串，10 <= age <= 120。

直接看程式碼吧。

首先，先定義一個結構體。

entity/member.go

package entity

// 定義 Member 結構體
type Member struct {
    Name string `form:"name" json:"name" binding:"required,NameValid"`
    Age  int    `form:"age"  json:"age"  binding:"required,gt=10,lt=120"`
}

binding 中 required，這個是框架自帶的，NameValid，這個是自己定義的。

問題一：框架自帶的 binding 引數還有哪些？

問題二：自定義驗證方法，怎麼寫？

接下來要說的就是問題二，寫一個驗證方法。

validator/member/member.go

package member

import (
    "gopkg.in/go-playground/validator.v8"
    "reflect"
)

func NameValid(
    v *validator.Validate, topStruct reflect.Value, currentStructOrField reflect.Value,
    field reflect.Value, fieldType reflect.Type, fieldKind reflect.Kind, param string,
) bool {
    if s, ok := field.Interface().(string); ok {
        if s == "admin" {
            return false
        }
    }
    return true
}

接下來，在路由中繫結：

router/router.go

package router

import (
    "ginDemo/middleware/logger"
    "ginDemo/middleware/sign"
    "ginDemo/router/v1"
    "ginDemo/router/v2"
    "ginDemo/validator/member"
    "github.com/gin-gonic/gin"
    "github.com/gin-gonic/gin/binding"
    "gopkg.in/go-playground/validator.v8"
)

func InitRouter(r *gin.Engine)  {

    r.Use(logger.LoggerToFile())

    // v1 版本
    GroupV1 := r.Group("/v1")
    {
        GroupV1.Any("/product/add", v1.AddProduct)
        GroupV1.Any("/member/add", v1.AddMember)
    }

    // v2 版本
    GroupV2 := r.Group("/v2").Use(sign.Sign())
    {
        GroupV2.Any("/product/add", v2.AddProduct)
        GroupV2.Any("/member/add", v2.AddMember)
    }

    // 繫結驗證器
    if v, ok := binding.Validator.Engine().(*validator.Validate); ok {
        v.RegisterValidation("NameValid", member.NameValid)
    }
}

最後，看一下呼叫的程式碼。

router/v1/member.go

package v1

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

func AddMember(c *gin.Context) {

    res := entity.Result{}
    mem := entity.Member{}

    if err := c.ShouldBind(&mem); err != nil {
        res.SetCode(entity.CODE_ERROR)
        res.SetMessage(err.Error())
        c.JSON(http.StatusForbidden, res)
        c.Abort()
        return
    }

    // 處理業務(下次再分享)

    data := map[string]interface{}{
        "name" : mem.Name,
        "age"  : mem.Age,
    }
    res.SetCode(entity.CODE_ERROR)
    res.SetData(data)
    c.JSON(http.StatusOK, res)
}

訪問看看效果吧。

訪問：http://localhost:8080/v1/member/add

{
    "code": -1,
    "msg": "Key: 'Member.Name' Error:Field validation for 'Name' failed on the 'required' tag\nKey: 'Member.Age' Error:Field validation for 'Age' failed on the 'required' tag",
    "data": null
}

訪問：http://localhost:8080/v1/member/add?name=1

{
    "code": -1,
    "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'required' tag",
    "data": null
}

訪問：http://localhost:8080/v1/member/add?age=1

{
    "code": -1,
    "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'required' tag",
    "data": null
}

訪問：http://localhost:8080/v1/member/add?name=admin&age=1

{
    "code": -1,
    "msg": "Key: 'Member.Name' Error:Field validation for 'Name' failed on the 'NameValid' tag",
    "data": null
}

訪問：http://localhost:8080/v1/member/add?name=1&age=1

{
    "code": -1,
    "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'gt' tag",
    "data": null
}

訪問：http://localhost:8080/v1/member/add?name=1&age=121

{
    "code": -1,
    "msg": "Key: 'Member.Age' Error:Field validation for 'Age' failed on the 'lt' tag",
    "data": null
}

訪問：http://localhost:8080/v1/member/add?name=Tom&age=30

{
    "code": 1,
    "msg": "",
    "data": {
        "age": 30,
        "name": "Tom"
    }
}

未避免返回資訊過多，錯誤提示我們們也可以統一。

if err := c.ShouldBind(&mem); err != nil {
    res.SetCode(entity.CODE_ERROR)
    res.SetMessage("引數驗證錯誤")
    c.JSON(http.StatusForbidden, res)
    c.Abort()
    return
}

這一次目錄結構調整了一些，在這裡說一下：

├─ ginDemo
│  ├─ common        //公共方法
│     ├── common.go
│  ├─ config        //配置檔案
│     ├── config.go
│  ├─ entity        //實體
│     ├── ...
│  ├─ middleware    //中介軟體
│     ├── logger
│         ├── ...
│     ├── sign
│         ├── ...
│  ├─ router        //路由
│     ├── ...
│  ├─ validator     //驗證器
│     ├── ...
│  ├─ vendor        //擴充套件包
│     ├── github.com
│         ├── ...
│     ├── golang.org
│         ├── ...
│     ├── gopkg.in
│         ├── ...
│  ├─ Gopkg.toml
│  ├─ Gopkg.lock
│  ├─ main.go

將 sign 和 logger 調整為中介軟體，並放到 middleware 中介軟體目錄。

新增了 common 公共方法目錄。

新增了 validator 驗證器目錄。

新增了 entity 實體目錄。

具體程式碼我會放到 GitHub，有感興趣的可以去看：https://github.com/xinliangnote/Go。

上面還遺漏了問題一沒解決，框架自帶的 binding 引數還有哪些？

從框架原始碼瞭解到驗證使用的是：

gopkg.in/go-playground/validator.v8

文件地址為：

https://godoc.org/gopkg.in/go-playground/validator.v8

去探索文件吧，裡面有很多驗證規則。

[系列] Gin框架 - 資料繫結和驗證

概述

推薦閱讀

相關文章