gin context和官方context_Gin 框架系列 安装和路由配置

最新推荐文章于 2024-03-26 10:24:51 发布
最新推荐文章于 2024-03-26 10:24:51 发布
阅读量157 收藏
点赞数
文章标签： gin context和官方context
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_39638623/article/details/112100948
版权

概述

看下 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 是啥 ？(推荐使用 go module)

它是 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

5512e7f17ed04b4264aeb5be2b5cc414.png

大功告成！

路由配置

比如，我们的接口地址是这样的：

  • /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{

"v2" : "AddProduct",

"name" : name,

"price" : price,

})

}

接下来，直接看效果吧。

访问 v1 接口：

f5ed219bf7252f19af9d1ad2d6ab4f94.png

访问后，直接返回数据，不走签名验证。

访问 v2 接口：

5cb193503f5570ea9afa74311e9e28af.png

进入了这段验证：

// 验证过期时间

if ts > GetTimeUnix() || GetTimeUnix() - ts >= exp {

RetJson("500", "Ts Error", "", c)

return

}

修改为合法的时间戳后：

f42e8dd53f0463024cf0b4530540d291.png

进入了这段验证：

// 验证签名

if sn == "" || sn != CreateSign(req) {

RetJson("500", "Sn Error", "", c)

return

}

修改为合法的签名后：

f66aaee1b0e54ec334f3f85684507f95.png

至此，简单的路由配置已经实现了。

对了，还有一个点没说，就是如何读取配置文件中的配置，我是这样做的：

package config

const (

PORT = ":8080"

APP_NAME = "ginDemo"

APP_SECRET = "6YJSuc50uJ18zj45"

API_EXPIRY = "120"

)

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

本文欢迎转发，转发请注明作者和出处，谢谢！

喜欢本文的朋友，欢迎关注“Go语言中文网”：

cd83ca2b8e6edb0cb8ad8d6e62b06428.png

weixin_39638623
关注
gin post 数据参数_gin框架post路由
weixin_39836803的博客
12-24 825
由于本篇的内容需要涉及到一些静态资源的加载(get方法中打开的html页面)，所以我们先进行静态资源配置，这里主要使用LoadHTMLGlob 加载html模板文件，使用StaticFS方法css、js及上传的文件。具体如下：func setStaticFS(r *gin.Engine) {r.LoadHTMLGlob("views/*")r.StaticFS("/static", http.Di...
gin 框架中的 gin.Context
luyoung0001@gmail.com的博客
08-01 3706
Context 是 gin 中最重要的部分。例如，它允许我们在中间件之间传递变量、管理流程、验证请求的 JSON 并呈现 JSON 响应。Context 中封装了原生的 Go HTTP 请求和响应对象，同时还提供了一些方法，用于获取请求和响应的信息、设置响应头、设置响应状态码等操作。在 Gin 中，Context 是通过中间件来传递的。在处理 HTTP 请求时，Gin 会依次执行注册的中间件，每个中间件可以对 Context 进行一些操作，然后将 Context 传递给下一个中间件。
Gin框架参数c *gin.Context
weixin_46529397的博客
03-16 1196
在使用 Gin 框架编写路由处理函数的时候，处理函数通常会接受一个 c *gin.Context 参数。这个参数实际上是一个结构体类型的指针，代表了客户端的 HTTP 请求和服务器向客户端发送的 HTTP 响应。通过 Gin 框架提供的 c *gin.Context 对象，我们可以方便地获取请求参数、设置响应头和响应内容、执行重定向，以及抛出错误信息。c *gin.Context 参数包含了大量的关于请求和响应的信息，可以用于获取客户端传递过来的请求参数、设置响应头等操作。
gin post 数据参数_二 :gin web框架学习常用路由参数解析
weixin_30215717的博客
12-24 271
获取"/user/:name"的name参数router.GET("/user/:name", func(c *gin.Context) {name := c.Param("name")c.JSON(http.StatusOK,gin.H{"name":name})})curl http://127.0.0.1:9000/user/lcd返回结果: {"name":lcd}/params?fir...
gin之context设计
heshushun的博客
12-10 2951
Gin封装的最好的地方就是context和对response的处理 一、context Context的最佳运用场景就是对Http的处理 Context是Gin最重要的部分。它允许我们在中间件之间 传递变量，管理流程，验证请求的JSON 并 呈现JSON响应。 1、Metadata Management type Context struct { ... Keys map[string]interface{} ... } gin获取或设置Context的Key-Value（键值对）.
gin框架安装以及gin的请求路由
01-20
本文将介绍如何在Windows环境下安装Gin框架，并讲解如何使用Gin进行请求路由的设置。 首先，安装Gin框架前需要确保你已经安装了Git和Go语言环境。在Windows上，你可以访问官方网站下载并安装Git和Go。Go的安装路径...
golang 网络框架之gin的使用方法
09-18
本文将深入讲解Gin框架的使用方法，帮助你更好地理解和应用它。 首先，让我们从一个简单的“Hello, World”示例开始。在Gin中，我们可以通过以下方式创建一个基本的HTTP服务器： ```go package main import ...
Golang-Gin框架示例二十多个源码
最新发布
04-26
Golang-Gin框架是Go语言中一款非常流行的Web开发框架，以其高效、简洁和易用性受到广大开发者喜爱。Gin框架基于Martini框架设计，使用了 httprouter 库作为路由解析器，提供了高性能的路由处理能力。在这个“Golang-...
Go语言中的gin框架之GET/POST请求参数接收传值（五）
06-15
在Go语言中，Gin框架是一个...总结，Gin框架在处理GET和POST请求参数时提供了多种方法，包括从URL查询字符串、JSON请求体以及Form数据中获取参数。这使得Gin成为构建Web服务的强大工具，特别是在Go语言的生态系统中。
Gin源码之gin.Context结构体及其方法
weixin_52690231的博客
04-08 4710
Gin源码之gin.Context结构体及其方法
gin中的context上下文
猛犸象
06-03 1906
一、自定义 key / value c.Keys[key] = value func (c *Context) Set(key string, value interface{}) func (c *Context) Get(key string) (value interface{}, exists bool) func (c *Context) GetString(key string) (s string) func (c *Context) GetInt(key string) (i int) .
Gin框架系列01：极速上手
了不起的厂长
04-06 1095
Gin是什么？ Gin是Go语言编写的web框架，具备中间件、崩溃处理、JSON验证、内置渲染等多种功能。 准备工作 本系列演示所有代码都在Github中，感兴趣的同学可以自行查阅，欢迎大家一起完善。 https://github.com/pingyeaa/golang-examples/tree/master/gin 没有安装配置Go语言环境的同学请先自行安装，这里不再赘述。首先，我们来创建工作...
Golang Gin框架的请求参数处理
lxw1844912514的博客
11-02 540
如何在Gin中如何通过各种方法来获取请求中的数据。 Gin通过 c.Param() 方法获取路由参数，即在路由中定义的变量。例如：r.GET("/user/:id",func(c*gin.Context){ id:=c.Param("id") c.String(http.StatusOK,"id=%s",id) })但如果需要获取多个参数，可以使用 c.Params ...
gin定制自己的context
u010412301的博客
09-10 1970
gin定制自己的context 在使用gin时，如果想在context中保存一些变量，比如用户的id，通常的做法是放到context的Keys变量中，这样做的话，我们每次取的时候，都得进行类型转化。 我习惯的做法是，定义自己的context，再在context中定义自己想要保存的变量，就像下面这样。 type context struct { *gin.Context use...
Golang gin Context 详解
rubys_的专栏
12-15 1310
好了，到此为止吧，关于Context后续有空再写一篇，这里面的东西，如果对Context的一些 API 不太熟悉的话，可能会不太好懂。main 函数本身是一个协程，协程里面可以通过go关键字启动新的协程。协程本质上是一个函数调用。父子协程是可以并行执行的（前提是有多个 CPU 核）。在需要等待子协程执行完的时候，可以使用，当然除了这个，另外一个方法是使用chan。Context代表的是父子协程的一个上下文对象，主要作用是共享数据、以及对子协程做一些超时控制等。gin里面的Context除了。
gin context和官方context_Go语言gin框架从入门到精通(3)
weixin_42356284的博客
12-27 3369
gin的渲染1 各种数据格式的响应json、结构体、XML、YAML类似于java的properties、ProtoBuf分别对所有数据格式举个列子func main() { r := gin.Default() ​ //1. json响应 r.GET("/someJSON", func(c *gin.Context) { c.JSON(200,gin.H{...
gin context和官方context_Gin源码简要分析
weixin_29521249的博客
12-27 2202
概述通过日常对gin场景出发，深入源码，总结介绍gin的核心设计。包含：Engine / HandlerFunc / RouterGroup(Router) / Context。在日常使用中常见的就以上概念，汇总如下：从DEMO开始type barForm struct { Foo string `form:"foo" binding:"required"` Bar int ...
Gin中的gin.Context与Golang原生的context.Context区别与联系
zhoupenghui168的博客
03-26 2715
Gin中的gin.Context与Golang原生的context.Context区别与联系
context 转成gin_golang轻量级框架Gin入门
05-27
这个方法接受两个参数：原始的Golang context和Gin框架中的Context结构体指针。 具体的操作步骤如下： 1. 在Gin框架中定义一个中间件函数，用于将Golang的context转换成Gin框架中的Context： ```go func ...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值