news 2026/4/16 12:06:54

Gin笔记二之gin.Engine和路由设置

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
Gin笔记二之gin.Engine和路由设置

这一篇笔记主要介绍 gin.Engine,设置路由等操作,以下是本篇笔记目录:

gin.Default() 和 gin.New()

HTTP 方法

路由分组与中间件

1、gin.Default() 和 gin.New()

前面第一篇笔记介绍,创建一个 gin 的路由引擎使用的函数是 gin.Default(),返回的类型是 *gin.Engine,我们可以使用其创建路由和路由组。

除了这个函数外,还有一个 gin.New(),其返回的也是 *gin.Engine,但是不一样的是 gin.Default() 会对 gin.Engine 添加默认的 Logger() 和 Recovery() 中间件。

这两个函数大致内容如下:

func New(opts ...OptionFunc) *Engine {

...

}

func Default(opts ...OptionFunc) *Engine {

...

engine := New()

engine.Use(Logger(), Recovery())

...

}

我们使用第一篇笔记中使用 debug 模式运行系统后输出的信息可以再看一下:

[GIN-debug] [WARNING] Creating an Engine instance with the Logger and Recovery middleware already attached.

[GIN-debug] [WARNING] Running in "debug" mode. Switch to "release" mode in production.

- using env: export GIN_MODE=release

- using code: gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET /test --> main.main.func1 (3 handlers)

[GIN-debug] [WARNING] You trusted all proxies, this is NOT safe. We recommend you to set a value.

Please check https://pkg.go.dev/github.com/gin-gonic/gin#readme-don-t-trust-all-proxies for details.

[GIN-debug] Listening and serving HTTP on :9898

我们使用的是 gin.Default() 运行的系统,所以在第一行告诉我们创建了一个带有 Logger and Recovery 中间件的 Engine。

同时第三行输出路由信息的地方,标明了这个路由指向的处理函数,后面的括号里是 3 handlers,这个意思是除了我们处理路由的 handler,还有两个默认的中间件 handler,也就是这里的 Logger() 和 Recovery() 中间件。

下面介绍一下 Logger() 和 Recovery() 这两个 handler 的作用。

1. Logger()

默认的 Logger() 会输出接口调用的信息,比如第一篇中我们定义了一个 /test 接口,当我们调用这个接口的时候,控制台会输出下面这条信息:

[GIN] 2025/08/19 - 23:15:26 | 200 | 36.666µs | 127.0.0.1 | GET "/test"

可以看到日志中会包含请求时间、返回的 HTTP 状态码、请求耗时、调用方 ip、请求方式和接口名称等。

这条日志信息的输出就是 Logger() 这个中间件起的作用。

在其内部,会调用一个 LoggerWithConfig() 函数,获取到请求的 ip、记录调用时间、调用方式等信息,然后进行输出,下面是部分源码信息:

param.TimeStamp = time.Now()

param.Latency = param.TimeStamp.Sub(start)

param.ClientIP = c.ClientIP()

param.Method = c.Request.Method

param.StatusCode = c.Writer.Status()

param.ErrorMessage = c.Errors.ByType(ErrorTypePrivate).String()

2. Recovery()

Recovery() 中间件则可以为我们捕获程序中未处理的 panic,记录错误信息并返回 500 状态码信息,比如我们在第一篇笔记中使用的 TestHandler 函数,我们在其中加一个除数为 0 的错误:

func TestHandler(c *gin.Context) {

response := TestResponse{

Code: 0,

Message: "success",

}

a := 0

fmt.Println(1 / a)

c.JSON(http.StatusOK, response)

}

在接口调用的时候,如果我们使用的是 gin.Default(),那么客户端不会报错,而是会收到一个 HTTP 状态码为 500 的报错信息,而如果使用的是 gin.New(),客户端则会直接发生错误。

总的来说,Logger() 和 Recovery() 这两个的中间件是 gin 框架为我们默认添加的对于开发者来说较为友好的两个操作,在后面介绍中间件的时候,我们也可以手动实现这两个功能。

2、HTTP 方法

gin.Engine 支持配置 HTTP 多个方法,比如 GET、POST、PUT、DELETE 等。

以第一篇笔记中的代码为例,其设置方法如下:

r.GET("/test", TestHandler)

r.POST("/test", TestHandler)

r.PUT("/test", TestHandler)

r.DELETE("/test", TestHandler)

3、路由分组与中间件

除了设置单个路由,我们还可以对路由进行分组设置,比如需要控制版本,或者模块设置需要统一的前缀,又或者是需要统一设置中间件功能的时候。

其整体代码示例如下:

package main

import (

"fmt"

"net/http"

"github.com/gin-gonic/gin"

)

type TestResponse struct {

Code int `json:"code"`

Message string `json:"message"`

}

func TestHandler(c *gin.Context) {

response := TestResponse{

Code: 0,

Message: "success",

}

c.JSON(http.StatusOK, response)

}

func main() {

r := gin.Default()

v1 := r.Group("/v1")

{

v1.GET("/test", TestHandler)

}

err := r.Run(":9898")

if err != nil {

fmt.Println("gin run in 9898 error:", err)

}

}

这里,我们设置了一个路由名称以 v1 为前缀的路由组,其下每个路由的访问都需要带有 /v1,这样就实现了统一设置路由前缀的功能。

而如果我们需要向其中添加中间件的时候,也可以不用挨个路由进行设置,而是在 v1 路由组的设置中就可以实现,比如:

v1 := r.Group("/v1", Middleware1, Middleware2)

这样,其下每个路由的 handler 函数在调用前就都会先调用 Middleware1 和 Middleware2 这两个中间件。

以上就是本篇笔记关于 gin.Engine 的全部内容,其实中间件的相关操作也应该属于 gin.Engine 的内容,但是那部分需要介绍的知识点和想要用于介绍的代码示例略多,所以就单独开一篇笔记在后面再介绍。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/4/16 11:22:27

Excelize动态图表终极指南:快速上手页面切换与动画效果

Excelize动态图表终极指南:快速上手页面切换与动画效果 【免费下载链接】excelize 项目地址: https://gitcode.com/gh_mirrors/exc/excelize 还在为Excel图表不够生动而烦恼吗?Excelize作为Go语言中处理Excel文件的强大库,能够帮你轻…

作者头像 李华
网站建设 2026/4/12 21:15:50

Mastercam产品编程培训,Mastercam三四轴编程全天班

常年开设:CAD绘图班、3D绘图班 (UG/CREO)UG产品编程三轴/四轴/五轴、 UG模具设计班、UG产品设计班、 PROE产品设计班、CREO产品设计班、数控车床手工编程班、UG模具编程班、Mastercam产品编程班三轴/四轴、机器人编程班、PLC编程班、soliworks机械设计班、PowerMill模具编程、注…

作者头像 李华
网站建设 2026/4/15 12:24:52

GQRX终极指南:免费开源SDR软件带你探索无线电世界

GQRX终极指南:免费开源SDR软件带你探索无线电世界 【免费下载链接】gqrx 项目地址: https://gitcode.com/gh_mirrors/gqr/gqrx GQRX是一款基于Qt和GNU Radio的免费开源软件定义无线电(SDR)接收器,为业余无线电爱好者和专业用户提供强大的频谱分析…

作者头像 李华
网站建设 2026/4/1 22:43:36

Gitleaks配置终极指南:5分钟从零到精通的完整教程

Gitleaks配置终极指南:5分钟从零到精通的完整教程 【免费下载链接】gitleaks Protect and discover secrets using Gitleaks 🔑 项目地址: https://gitcode.com/GitHub_Trending/gi/gitleaks 还记得那个让整个团队紧张的下午吗?开发小…

作者头像 李华
网站建设 2026/4/16 11:00:10

Redis key 消失之谜

1分钟看图掌握核心观点👇图片一、问题描述1.1 报错信息应用服务报错,通过监控日志发现凌晨2点的时候,应用报错获取不到Redis key。1.2 告警与监控信息首先想到是否由于内存满导致的key淘汰,生产的所有Redis都有设置内存告警&#…

作者头像 李华
网站建设 2026/4/8 14:35:41

Linux内核设计与实现:第三版完整学习指南

Linux内核设计与实现:第三版完整学习指南 【免费下载链接】Linux内核设计与实现_第三版PDF下载分享 Linux内核设计与实现_第三版 PDF 下载 项目地址: https://gitcode.com/Open-source-documentation-tutorial/e0b03 资源亮点 本书作为Linux内核领域的经典权…

作者头像 李华