Gin 框架 - 安装和路由配置
目录
概述
看下 gin 框架的官方介绍:
gin 是一个用 go (golang) 编写的 web 框架。 它是一个类似于 martini 但拥有更好性能的 api 框架, 由于 httprouter,速度提高了近 40 倍。 如果你是性能和高效的追求者, 你会爱上 gin。
是的,就是用 gin 来写 api 接口。
这篇文章分享 gin 的安装和gin 的路由配置。
路由配置包含的功能点如下:
- 实现了,路由分组 v1版本、v2版本。
- 实现了,生成签名和验证验证。
- 实现了,在配置文件中读取配置。
gin 安装
必须要先安装 go,go 的安装可以参考:go - 环境安装。
框架安装可以参考官网:
我在安装时,用的是 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
即可。
推荐阅读
本文欢迎转发,转发请注明作者和出处,谢谢!