[系列] Gin 框架 - 安裝和路由配置

目錄

• 概述
• Gin 安裝
• 路由配置
• 推薦閱讀

概述

看下 Gin 框架的官方介紹：

Gin 是一個用 Go (Golang) 編寫的 web 框架。 它是一個相似於 martini 但擁有更好性能的 API 框架, 因爲 httprouter，速度提升了近 40 倍。 若是你是性能和高效的追求者, 你會愛上 Gin。

是的，就是用 Gin 來寫 API 接口。

這篇文章分享 Gin 的安裝和Gin 的路由配置。

路由配置包含的功能點以下：

• 實現了，路由分組 v1版本、v2版本。
• 實現了，生成簽名和驗證驗證。
• 實現了，在配置文件中讀取配置。

Gin 安裝

必需要先安裝 Go，Go 的安裝能夠參考：Go - 環境安裝。

框架安裝能夠參考官網：

https://gin-gonic.com/zh-cn/docs/quickstart/

我在安裝時，用的是 dep 安裝，給你們分享下。

dep 是啥 ？

它是 Golang 官方依賴管理工具，能夠認爲它與 PHP 中的 composer 相似。

在這就很少作介紹了，能夠本身去了解，安裝也比較簡單。

我本機是 Mac，安裝只需一個命令：

brew install dep

我們接下來建立一個新項目：ginDemo。

在 ginDemo 目錄下執行：

dep init

執行完畢，會生成以下三個文件：

├─ ginDemo
│  ├─ vendor
│  ├─ Gopkg.toml
│  ├─ Gopkg.lock

• 依賴包都會下載到 vendor 目錄。
• 須要的依賴配置寫在 Gopkg.toml 文件。
• Gopkg.lock 暫時能夠不用管。

在 Gopkg.toml 文件中增長依賴：

[[constraint]]
  name = "github.com/gin-gonic/gin"
  version = "1.4.0"

新增一個 main.go 文件：

// 官方 Demo
package main

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

func main() {
    r := gin.Default()
    r.GET("/ping", func(c *gin.Context) {
        c.JSON(200, gin.H{
            "message": "pong",
        })
    })
    r.Run() // listen and serve on 0.0.0.0:8080
}

ginDemo 目錄下執行：

dep ensure

執行完畢，vendor 目錄會存在安裝包，這時總體目錄結構以下：

├─ ginDemo
│  ├─ vendor
│     ├── github.com
│         ├── ...
│     ├── golang.org
│         ├── ...
│     ├── gopkg.in
│         ├── ...
│  ├─ Gopkg.toml
│  ├─ Gopkg.lock
│  ├─ main.go

ginDemo 目錄下執行：

go run main.go

瀏覽器訪問：http://localhost:8080/ping

大功告成！

路由配置

好比咱們的接口地址是這樣的：

• /v1/product/add
• /v1/member/add
• /v2/product/add
• /v2/member/add

假設需求是這樣的，接口支持多種請求方式，v1 不需簽名驗證，v2 須要簽名驗證，路由文件應該這樣寫：

package router

import (
    "ginDemo/common"
    "ginDemo/controller/v1"
    "ginDemo/controller/v2"
    "github.com/gin-gonic/gin"
    "net/url"
    "strconv"
)

func InitRouter(r *gin.Engine)  {

    r.GET("/sn", SignDemo)

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

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

func SignDemo(c *gin.Context) {
    ts := strconv.FormatInt(common.GetTimeUnix(), 10)
    res := map[string]interface{}{}
    params := url.Values{
        "name"  : []string{"a"},
        "price" : []string{"10"},
        "ts"    : []string{ts},
    }
    res["sn"] = common.CreateSign(params)
    res["ts"] = ts
    common.RetJson("200", "", res, c)
}

.Any 表示支持多種請求方式。

controller/v1 表示 v1 版本的文件。

controller/v2 表示 v2 版本的文件。

SignDemo 表示生成簽名的Demo。

接下來，給出一些代碼片斷：

驗證簽名方法：

// 驗證簽名
func VerifySign(c *gin.Context) {
    var method = c.Request.Method
    var ts int64
    var sn string
    var req url.Values

    if method == "GET" {
        req = c.Request.URL.Query()
        sn = c.Query("sn")
        ts, _  = strconv.ParseInt(c.Query("ts"), 10, 64)

    } else if method == "POST" {
        req = c.Request.PostForm
        sn = c.PostForm("sn")
        ts, _  = strconv.ParseInt(c.PostForm("ts"), 10, 64)
    } else {
        RetJson("500", "Illegal requests", "", c)
        return
    }

    exp, _ := strconv.ParseInt(config.API_EXPIRY, 10, 64)

    // 驗證過時時間
    if ts > GetTimeUnix() || GetTimeUnix() - ts >= exp {
        RetJson("500", "Ts Error", "", c)
        return
    }

    // 驗證簽名
    if sn == "" || sn != CreateSign(req) {
        RetJson("500", "Sn Error", "", c)
        return
    }
}

生成簽名的方法：

// 生成簽名
func CreateSign(params url.Values) string {
    var key []string
    var str = ""
    for k := range params {
        if k != "sn" {
            key = append(key, k)
        }
    }
    sort.Strings(key)
    for i := 0; i < len(key); i++ {
        if i == 0 {
            str = fmt.Sprintf("%v=%v", key[i], params.Get(key[i]))
        } else {
            str = str + fmt.Sprintf("&%v=%v", key[i], params.Get(key[i]))
        }
    }
    // 自定義簽名算法
    sign := MD5(MD5(str) + MD5(config.APP_NAME + config.APP_SECRET))
    return sign
}

獲取參數的方法：

// 獲取 Get 參數
name := c.Query("name")
price := c.DefaultQuery("price", "100")

// 獲取 Post 參數
name := c.PostForm("name")
price := c.DefaultPostForm("price", "100")

// 獲取 Get 全部參數
ReqGet = c.Request.URL.Query()

//獲取 Post 全部參數
ReqPost = c.Request.PostForm

v1 業務代碼：

package v1

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

func AddProduct(c *gin.Context)  {
    // 獲取 Get 參數
    name  := c.Query("name")
    price := c.DefaultQuery("price", "100")

    c.JSON(200, gin.H{
        "v1"    : "AddProduct",
        "name"  : name,
        "price" : price,
    })
}

v2 業務代碼：

package v2

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

func AddProduct(c *gin.Context)  {
    // 獲取 Get 參數
    name  := c.Query("name")
    price := c.DefaultQuery("price", "100")

    c.JSON(200, gin.H{
        "v1"    : "AddProduct",
        "name"  : name,
        "price" : price,
    })
}

接下來，直接看效果吧。

訪問 v1 接口：

訪問後，直接返回數據，不走簽名驗證。

訪問 v2 接口：

進入了這段驗證：

// 驗證過時時間
if ts > GetTimeUnix() || GetTimeUnix() - ts >= exp {
    RetJson("500", "Ts Error", "", c)
    return
}

修改成合法的時間戳後：

進入了這段驗證：

// 驗證簽名
if sn == "" || sn != CreateSign(req) {
    RetJson("500", "Sn Error", "", c)
    return
}

修改成合法的簽名後：

至此，簡單的路由配置已經實現了。

對了，還有一個點沒說，就是如何讀取配置文件中的配置，我是這樣作的：

package config

const (
    PORT       = ":8080"
    APP_NAME   = "ginDemo"
    APP_SECRET = "6YJSuc50uJ18zj45"
    API_EXPIRY = "120"
)

引入 config 包，直接 config.xx 便可。

推薦閱讀

Gin 框架

• Gin 框架 - 使用 Logrus 日誌記錄
• Gin 框架 - 安裝和路由配置

基礎篇

• Go - 函數
• Go - 循環
• Go - Map 集合
• Go - Struct 結構體
• Go - Slice 切片
• Go - 數組
• Go - 變量聲明
• Go - 環境安裝

本文歡迎轉發，轉發請註明做者和出處，謝謝！