ジンフレーム - ルーティングの設定とインストール

アウトライン

公式の説明のジンフレームワークを探します。

ジンは、書かれた使用ゴー(Golang)Webフレームワークです。それはマティーニに似ていますが、APIフレームワークは、より良い性能、原因httprouter、約40倍の速さを持っています。あなたが求婚者のパフォーマンスと効率をされている場合は、ジンを好きになります。

はい、それはAPIインターフェイスを書き込むためのジンです。

この記事ジンジンのインストールとルーティング設定を共有します。

次のルーティング構成を備えた特徴点:

  • パケットルーティングバージョンV1、V2バージョン、達成。
  • なお、署名検証および妥当性確認を生成し、実現しました。
  • 達成し、コンフィギュレーションファイルに設定を読み込みます。

ジンのインストール

あなたは最初に行くをインストールする必要があり、インストールを行くを参照することができます行く-環境のインストール

取付フレームは、公式サイトを参照することができます:

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

私はあなたと共有するために、DEPインストールを使用して、インストールしました。

DEPは何ですか?

これは、公式の依存関係の管理ツールをGolang、それは作曲にPHPに似たと考えることができています。

これは冒頭で行うことはあまりありませんが、あなたが自分自身を知ることができ、インストールは比較的簡単です。

このマシンは私のMacで、単一のコマンドをインストールします。

brew install dep

ginDemo:次に、私たちは、新しいプロジェクトを作成します。

ginDemoカタログで実行:

dep init

終了すると、それは次の3つの文書が生成されます。

├─ 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 署名デモを生成する表現。

次に、いくつかのコードの断片が与えられます。

署名検証方法:

// 验证签名
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.xxします。

推奨読書

この記事へようこそ転送は、ソースと作者を明記してください、ありがとうございました!

おすすめ

転載: www.cnblogs.com/xinliangcoder/p/11200332.html