github.com/gin-gonic/gin 中间件

最新推荐文章于 2023-05-31 17:05:34 发布
最新推荐文章于 2023-05-31 17:05:34 发布
阅读量2k 收藏 6
点赞数 1
分类专栏： Go-Package
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/ayqy42602/article/details/108669292
版权

https://www.jianshu.com/p/98965b3ff638/

github.com/gin-gonic/gin是一个轻量级的 WEB 框架，支持 RestFull 风格 API，支持 GET，POST，PUT，PATCH，DELETE，OPTIONS 等 http 方法，支持文件上传，分组路由，Multipart/Urlencoded FORM，以及支持 JsonP，参数处理等等功能，这些都和 WEB 紧密相关，通过提供这些功能，使开发人员更方便地处理 WEB 业务。

使用 GET, POST, PUT, PATCH, DELETE, OPTIONS

func main() {
    // Disable Console Color
    // gin.DisableConsoleColor()

    // 使用默认中间件创建一个gin路由器
    // logger and recovery (crash-free) 中间件
    router := gin.Default()

    router.GET("/someGet", getting)
    router.POST("/somePost", posting)
    router.PUT("/somePut", putting)
    router.DELETE("/someDelete", deleting)
    router.PATCH("/somePatch", patching)
    router.HEAD("/someHead", head)
    router.OPTIONS("/someOptions", options)

    // 默认启动的是 8080端口，也可以自己定义启动端口
    router.Run()
    // router.Run(":3000") for a hard coded port
}

项目中导入

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

导入NET/HTTP（可选）。例如，如果使用诸如HTTP.StasuCK之类的常数，则需要这样做。

import "net/http"

A 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()
}

启动后，在浏览器输入：浏览其会渲染输出：

http://127.0.0.1:8080/ping

在这里插入图片描述
还可以用如下的方式，渲染浏览器页面输出字符串：

package main

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

func main() {
	router := gin.Default()

	router.GET("/someGet",getting)
	router.Run()
}

func getting(c *gin.Context) {
	c.String(http.StatusOK,"Hello gin")
}


http://127.0.0.1:8080/someGet

在这里插入图片描述

我们点开源码发现，不管是渲染输出json格式、还是简单的字符串都是调用了c.Render方法，以下只是列出了2种，还有其他的诸如HTML、IndentedJSON、SecureJSON、JSONP、AsciiJSON、XML、YAML、ProtoBuf等。

func (c *Context) String(code int, format string, values ...interface{}) {
	c.Render(code, render.String{Format: format, Data: values})
}

func (c *Context) JSON(code int, obj interface{}) {
	c.Render(code, render.JSON{Data: obj})
}

获取路径中的参数：

package main

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

func main() {
	router := gin.Default()

	// 此规则能够匹配/someGet/aaa这种格式，但不能匹配/usomeGet/ 或 /someGet这种格式
	router.GET("/someGet/:name",getting)

	// 但是，这个规则既能匹配/someGet/aaa/格式也能匹配/someGet/aaa/send这种格式
	// 如果没有其他路由器匹配/someGet/aaa，它将重定向到/someGet/aaa/
	router.GET("/someGet/:name/*action", func(c *gin.Context) {
		name := c.Param("name")
		action := c.Param("action")
		message := name + "is" + action
		c.String(http.StatusOK,message)
	})
	router.Run()
}

func getting(c *gin.Context) {
	name := c.Param("name")
	c.String(http.StatusOK,"Hello %s",name)
}

所以我们浏览器输入http://0.0.0.0:8080/someGet/aaaa可以
http://0.0.0.0:8080/someGet/或者http://0.0.0.0:8080/someGet都报错误

以上是一个参数，我们还可以定义多级参数。

http://127.0.0.1:8080/someGet/bbb

在这里插入图片描述
获取Get参数：

package main

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

func main() {
	router := gin.Default()
	// 匹配的url格式:  /someGet?firstname=Jane&lastname=Doe
	router.GET("/someGet",getting)
	router.Run()
}

func getting(c *gin.Context) {
	firstname := c.DefaultQuery("firstname","Guest")
	lastname := c.Query("lastname")
	c.String(http.StatusOK,"Hello: %s,%s",firstname,lastname)
}

浏览器输入http://127.0.0.1:8080/someGet?firstname=wyf&lastname=123
渲染页面输出为Hello wyf 123

浏览器输入http://127.0.0.1:8080/someGet?lastname=123，渲染页面输出为Hello Guest 123

http://127.0.0.1:8080/someGet?firstname=aaa&lastname=bbb

在这里插入图片描述

http://127.0.0.1:8080/someGet?lastname=123

在这里插入图片描述
获取Post 参数

package main

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

func main() {
	router := gin.Default()

	router.POST("/someGet",getting)
	router.Run()
}

func getting(c *gin.Context) {
	message := c.PostForm("message")
	nick := c.DefaultPostForm("nick","anonymous") // 此方法可以设置默认值

	c.JSON(200,gin.H{
		"status":"posted",
		"message":message,
		"nick":nick,
	})
}

在这里插入图片描述
Get+Post 混合形式：

package main

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

func main() {
	router := gin.Default()

	router.POST("/someGet",getting)
	router.Run()
}

func getting(c *gin.Context) {
	id := c.Query("id")
	page := c.DefaultQuery("page","0")
	name := c.PostForm("name")
	message := c.PostForm("message")

	c.String(http.StatusOK,"id: %s; page: %s; name: %s; message: %s",id,page,name,message)
}

在这里插入图片描述
构造Map格式：

package main

import (
	"fmt"
	"github.com/gin-gonic/gin"
	"net/http"
)

func main() {
	router := gin.Default()

	router.POST("/someGet",getting)
	router.Run()
}

func getting(c *gin.Context) {
	ids := c.QueryMap("ids")
	names := c.PostFormMap("names")

	fmt.Printf("ids:%v; names:%v\n",ids,names)
	c.JSON(200,gin.H{
		"ids":ids,
		"names":names,
	})
	c.String(http.StatusOK,"ids:%v; names:%v",ids,names)
}

在这里插入图片描述
路由分组：

func main() {
    router := gin.Default()

    // Simple group: v1
    v1 := router.Group("/v1")
    {
        v1.POST("/login", loginEndpoint)
        v1.POST("/submit", submitEndpoint)
        v1.POST("/read", readEndpoint)
    }

    // Simple group: v2
    v2 := router.Group("/v2")
    {
        v2.POST("/login", loginEndpoint)
        v2.POST("/submit", submitEndpoint)
        v2.POST("/read", readEndpoint)
    }

    router.Run(":8080")
}

package main

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

func main() {
	router := gin.Default()

	v1 := router.Group("/v1")
	{
		v1.GET("/read",readEndpoint)
	}

	v2 := router.Group("/v2")
	{
		v2.GET("/login",loginEndpoint)
	}

	router.Run(":8080")
}

func readEndpoint(c *gin.Context) {
	fmt.Println("read")
}

func loginEndpoint(c *gin.Context) {
	fmt.Println("login")
}

浏览器输入http://127.0.0.1:8080/v1/read
后台log输出read

浏览器输入http://127.0.0.1:8080/v2/login
后台log输出login
在这里插入图片描述
上传文件
上传文件的文件名可以由用户自定义，所以可能包含非法字符串，为了安全起见，应该由服务端统一文件名规则。

单文件上传：

func main() {
    router := gin.Default()
    // 给表单限制上传大小 (默认 32 MiB)
    // router.MaxMultipartMemory = 8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // 单文件
        file, _ := c.FormFile("file")
        log.Println(file.Filename)

        // 上传文件到指定的路径
        // c.SaveUploadedFile(file, dst)

        c.String(http.StatusOK, fmt.Sprintf("'%s' uploaded!", file.Filename))
    })
    router.Run(":8080")
}

curl 测试：

curl -X POST http://localhost:8080/upload \
  -F "file=@/Users/appleboy/test.zip" \
  -H "Content-Type: multipart/form-data"

多文件上传：

func main() {
    router := gin.Default()
    // 给表单限制上传大小 (默认 32 MiB)
    // router.MaxMultipartMemory = 8 << 20  // 8 MiB
    router.POST("/upload", func(c *gin.Context) {
        // 多文件
        form, _ := c.MultipartForm()
        files := form.File["upload[]"]

        for _, file := range files {
            log.Println(file.Filename)

            // 上传文件到指定的路径
            // c.SaveUploadedFile(file, dst)
        }
        c.String(http.StatusOK, fmt.Sprintf("%d files uploaded!", len(files)))
    })
    router.Run(":8080")
}

curl 测试：

curl -X POST http://localhost:8080/upload \
  -F "upload[]=@/Users/appleboy/test1.zip" \
  -F "upload[]=@/Users/appleboy/test2.zip" \
  -H "Content-Type: multipart/form-data"

中间件使用详解

无中间件启动：
使用r := gin.New() 代替r := gin.Default() // 默认启动方式，包含 Logger、Recovery 中间件

使用中间件：

func main() {
    // 创建一个不包含中间件的路由器
    r := gin.New()

    // 全局中间件
    // 使用 Logger 中间件
    r.Use(gin.Logger())

    // 使用 Recovery 中间件
    r.Use(gin.Recovery())

    // 路由添加中间件，可以添加任意多个
    r.GET("/benchmark", MyBenchLogger(), benchEndpoint)

    // 路由组中添加中间件
    // authorized := r.Group("/", AuthRequired())
    // exactly the same as:
    authorized := r.Group("/")
    // per group middleware! in this case we use the custom created
    // AuthRequired() middleware just in the "authorized" group.
    authorized.Use(AuthRequired())
    {
        authorized.POST("/login", loginEndpoint)
        authorized.POST("/submit", submitEndpoint)
        authorized.POST("/read", readEndpoint)

        // nested group
        testing := authorized.Group("testing")
        testing.GET("/analytics", analyticsEndpoint)
    }

    // Listen and serve on 0.0.0.0:8080
    r.Run(":8080")
}

写日志文件：

func main() {
    // 禁用控制台颜色
    gin.DisableConsoleColor()

    // 创建记录日志的文件
    f, _ := os.Create("gin.log")
    gin.DefaultWriter = io.MultiWriter(f)

    // 如果需要将日志同时写入文件和控制台，请使用以下代码
    // gin.DefaultWriter = io.MultiWriter(f, os.Stdout)

    router := gin.Default()
    router.GET("/ping", func(c *gin.Context) {
        c.String(200, "pong")
    })

    router.Run(":8080")
}

自定义日志格式

func main() {
    router := gin.New()

    // LoggerWithFormatter 中间件会将日志写入 gin.DefaultWriter
    // By default gin.DefaultWriter = os.Stdout
    router.Use(gin.LoggerWithFormatter(func(param gin.LogFormatterParams) string {

        // 你的自定义格式
        return fmt.Sprintf("%s - [%s] \"%s %s %s %d %s \"%s\" %s\"\n",
                param.ClientIP,
                param.TimeStamp.Format(time.RFC1123),
                param.Method,
                param.Path,
                param.Request.Proto,
                param.StatusCode,
                param.Latency,
                param.Request.UserAgent(),
                param.ErrorMessage,
        )
    }))
    router.Use(gin.Recovery())

    router.GET("/ping", func(c *gin.Context) {
        c.String(200, "pong")
    })

    router.Run(":8080")
}

输出示例：

::1 - [Fri, 07 Dec 2018 17:04:38 JST] "GET /ping HTTP/1.1 200 122.767µs "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.80 Safari/537.36" "
y果子
关注
  • 1
    点赞
  • 踩
  • 6
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
gin-gonic/gin使用详解
qq_36305027的博客
08-09 1476
​ Gin 是一个用 Go (Golang) 编写的 HTTP web 框架。它是一个类似于 martini 但拥有更好性能的 API 框架, 由于 httprouter，速度提高了近 40 倍。如果你需要极好的性能，使用 Gin 吧。​ gin的github地址：https://github.com/gin-gonic/gin​ 在项目中使用gin框架只需要下面三步：​ 第一步：运行下面指令安装gin（注意go的版本要在1.15以上）...
go-gin-mgo-demo：使用流行的gin-gonic框架在golang中演示的CRUD应用程序
02-02
使用流行的gin-gonic框架在golang中演示CRUD应用程序 发展历程 克隆（分叉）存储库。 然后跑 $ go get github.com/codegangsta/gin 用于在开发过程中自动编译文件 跑 $ go get && go install && PORT=7000 DEBUG=...
Go语言中的Gin框架的初步使用
ZN175623的博客
11-05 1533
2、这时候如果遇到问题资源加载不了，解决方法是使用代理（这块有个 go env 的命令，可以查看当前配置），在cmd中运行。设置后，重新运行 go get -u github.com/gin-gonic/gin 可以很快速的安装。1、框架文档介绍：go get -u github.com/gin-gonic/gin。Gin RestFul 非常简单。
Go实战--通过gin-gonic框架搭建restful api服务(github.com/gin-gonic/gin)
weixin_40592935的博客
06-28 1417
生命不止，继续 go go go !!!先插播一条广告，给你坚持学习golang的理由： 《2017 软件开发薪酬调查：Go 和 Scala 是最赚钱的语言》 言归正传！之前写过使用golang实现简单的restful api相关的博客： Go实战–实现简单的restful api(The way to go)其中，使用了github.com/gorilla/mux，今天要跟大家介绍的是gin-g...
golangWeb框架---github.com/gin-gonic/gin学习一(路由、多级路由、参数传递几种形式)
热门推荐
全干工程师
09-19 2万+
文章目录Gin介绍安装快速开始路径参数构造参数post传参get+post混合形式构造Map格式 Gin介绍 Gin是一个golang的微框架，封装比较优雅，API友好，源码注释比较明确，已经发布了1.0版本。具有快速灵活，容错方便等特点。其实对于golang而言，web框架的依赖要远比Python，Java之类的要小。自身的net/http足够简单，性能也非常不错。框架更像是一些常用函数或者工具...
github.com/gin-gonic/gin. Gin--EngineGroup
y果子
08-10 1083
https://juejin.im/post/6844903789300826125 轻量级 Web 框架 Gin 结构分析 Go 语言最流行了两个轻量级 Web 框架分别是 Gin 和 Echo，这两个框架大同小异，都是插件式轻量级框架，背后都有一个开源小生态来提供各式各样的小插件，这两个框架的性能也都非常好，裸测起来跑的飞快。本节我们只讲 Gin 的实现原理和使用方法，Gin 起步比 Echo 要早，市场占有率要高一些，生态也丰富一些。 go get -u github.com/gin-gonic/gi
import “github.com/gin-gonic/gin“ 爆红
Sai_BAN的博客
01-14 2577
4、代码 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:80
golangWeb框架---github.com/gin-gonic/gin学习四(模型绑定、自定义校验、ShouldBindXXX、BindXXX)
全干工程师
09-20 1万+
文章目录模型绑定、校验 模型绑定、校验 以下来自百度翻译： 若要将请求体绑定到类型，请使用模型绑定。我们目前支持JSON、XML和标准表单值的绑定（Foo= Bar和Bo.BAZ）。 GIN使用Go PooWorks/Valual.V8进行验证。在这里查看标签使用的完整文档。 注意，需要在所有要绑定的字段上设置相应的绑定标记。例如，当从JSON绑定时，设置JSON：“FieldNeX”。 类型——...
go github.com/gin-gonic/gin详解
爱死亡机器人
07-16 3173
gin介绍 github.com/gin-gonic/gin是一个轻量级的 WEB 框架，支持 RestFull 风格 API，支持 GET，POST，PUT，PATCH，DELETE，OPTIONS 等 http 方法，支持文件上传，分组路由，Multipart/Urlencoded FORM，以及支持 JsonP，参数处理等等功能，这些都和 WEB 紧密相关，通过提供这些功能，使开发人员更方便...
gin-gonic.examples.zip
03-28
Gin-Gonic是一个基于Go语言的高性能Web框架，它采用了MVC设计模式，使得开发Web应用变得更加简洁高效。这个"gin-gonic.examples.zip"压缩包包含了Gin-Gonic框架的一些示例代码，方便开发者学习和参考。由于从GitHub...
go-gin:gin-gonic的OpenTracing中间件
05-07
"github.com/gin-gonic/gin" "github.com/opentracing/opentracing-go" "github.com/opentracing-contrib/go-gin/gintracer" ) func main() { r := gin.Default() tracer, closer := opentracing.NewTracer(...
sessions:用于会话管理的Gin中间件
05-01
会话 用于会话管理的Gin中间件，具有多后端支持：用法开始使用它下载并安装： $ go get github.com/gin-contrib/sessions 将其导入您的代码中： import "github.com/gin-contrib/sessions"基本范例单节package main...
gin离线安装集合源码
11-15
如果你想在项目中使用Gin，还需要执行`go get -u github.com/gin-gonic/gin`命令，这会将Gin的导入路径添加到`GOPATH\pkg\$(GOOS)_$(GOARCH)\`目录下的`.a`文件中，从而完成Gin的安装。 离线安装过程中，需要注意的...
go: module github.com/gin-gonic/gin: Get “https://proxy.golang.org/github.com/gin-gonic/gin/@v/list“
最新发布
第⑦个前端
05-31 1423
报错：go: module github.com/gin-gonic/gin: Get “https://proxy.golang.org/github.com/gin-gonic/gin/@v/list”: dial tcp 142.251.42.241:443: i/o timeout。当使用命令：go get -u github.com/gin-gonic/gin。
Golang：gin-gonic/gin一个用 Go (Golang) 编写的 HTTP Web 框架
彭世瑜的博客
10-21 700
Gin 是一个用 Go (Golang) 编写的 HTTP Web 框架。它具有类似 Martini 的 API，但性能比 Martini 快 40 倍。代码示例 main.go。
Go语言web框架 gin
fwhezfwhez的博客
01-25 1万+
Go语言web框架 GIN gin是go语言环境下的一个web框架, 它类似于Martini, 官方声称它比Martini有更好的性能, 比Martini快40倍, Ohhhh….看着不错的样子, 所以就想记录一下gin的学习. gin的github代码在这里: gin源码. gin的效率获得如此突飞猛进, 得益于另一个开源项目httprouter, 项目地址: httprouter源码. 下面
安装gin失败，或者卡住，或者cannot find module providing package github.com/gin-gonic/gin: 安装gin后找不到gin包
Jeson的博客
08-25 2445
安装gin失败，或者卡住 在Go 1.11版本后，支持go mod和包下载解决方案，以下是解决方法 mac/linux系统： # 设置goproxy.io代理 export GOPROXY=https://goproxy.io # 设置GO111MOUDLE export GO111MODULE=on windows系统 # 注意需要加上引号 # 设置goproxy.io代理 go env -w GOPROXY="https://goproxy.io" # 设置GO111MOUDLE go en
github.com/prometheus/client_golang/prometheus/promhttp 使用golang编写Prometheus Exporter
y果子
10-14 3257
Exporter是基于Prometheus实施的监控系统中重要的组成部分，承担数据指标的采集工作，官方的exporter列表中已经包含了常见的绝大多数的系统指标监控，比如用于机器性能监控的node_exporter, 用于网络设备监控的snmp_exporter等等。这些已有的exporter对于监控来说，仅仅需要很少的配置工作就能提供完善的数据指标采集。 有时我们需要自己去写一些与业务逻辑比较相关的指标监控，这些指标无法通过常见的exporter获取到。比如我们需要提供对于DNS解析情况的整体监控，了解如
github.com/gin-gonic/gin
03-22
这是一个基于 Go 语言的 Web 框架，可以用来快速搭建 RESTful API。它提供了很多有用的功能，比如中间件、路由、参数绑定等等。如果你想要了解更多关于 gin 的信息，可以访问它的官方网站 gin-gonic.com。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值