设为首页 加入收藏

TOP

[系列] Gin 框架 - 安装和路由配置(一)
2019-07-25 14:17:30 】 浏览:114
Tags:系列 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(  
		
编程开发网
首页 上一页 1 2 下一页 尾页 1/2/2
】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
上一篇go 语言学习笔记 下一篇[系列] Gin 框架 - 使用 logrus ..