当前位置：首页 > news >正文

gin框架学习笔记

news 来源：原创 2025/4/27 8:40:52

Gin 是一个基于 Go 语言的高性能 Web 框架

gin下载

在已有的go项目直接终端输入

go get -u github.com/gin-gonic/gin

hello world快速上手

package mainimport ("github.com/gin-gonic/gin"
)func main() {router := gin.Default()router.GET("/", func(c *gin.Context) {c.JSON(200, gin.H{"message": "Hello world!",})})router.Run()
}

运行

go run main.go

浏览器输入http://localhost:8080/

可以看到浏览器显示

到这里简单的gin上手完成了

参数获取

路径参数获取

这里可以类比Java springboot 的@RequestParam

即获取路径url？后边的参数数据

func main() {r := gin.Default()r.GET("/user/phone", func(c *gin.Context) {//设置默认的数值 假设路径参数phone没有传值则给一个默认值phone := c.DefaultQuery("phone", "333")//直接获取路径参数username := c.Query("username")Json格式返回参数c.JSON(http.StatusOK, gin.H{"message":  "ok","username": username,"phone":    phone,})})r.Run()
}

浏览器输入user/phone?phone=333&username=用户

浏览器输入user/phone?username=用户

路径参数没有给phone的参数

这里给出了默认的返回333

这里的返回是由于gin程序里 phone := c.DefaultQuery("phone", "333")实现的

form参数获取

func main() {//Default返回一个默认的路由引擎r := gin.Default()r.POST("/user/phone", func(c *gin.Context) {// DefaultPostForm取不到值时会返回指定的默认值username := c.DefaultPostForm("username", "用户")// username := c.PostForm("username")phone := c.PostForm("phone")c.JSON(http.StatusOK, gin.H{"message":  "ok","username": username,"phone":    phone,})})r.Run(":8080")
}

postman调试（参数都有传值）

postman调试（username参数没有传值）

返回默认值 “用户”

这里实现和获取默认路径差不多 username := c.DefaultPostForm("username", "用户")

调用DefaultPostForm实现的

json参数获取

这里可以类比Java的@RequestBody

如下程序实现了把给定的json参数原样返回

func main() {r := gin.Default()r.POST("/json", func(c *gin.Context) {b, err := c.GetRawData() // 从c.Request.Body读取请求数据if err != nil {log.Fatal(err)}var m map[string]interface{}// 反序列化err1 := json.Unmarshal(b, &m)if err1 != nil {log.Fatal(err1)}c.JSON(http.StatusOK, m)})r.Run(":8080")
}

postman调用

path参数获取

可以类比成Java的@PathVariable

func main() {r := gin.Default()r.GET("/user/phone/:username/:phone", func(c *gin.Context) {username := c.Param("username")phone := c.Param("phone")//输出json结果给调用方c.JSON(http.StatusOK, gin.H{"message":  "ok","username": username,"phone":    phone,})})r.Run(":8080")
}

postman调用

传格式如下

/user/phone/测试用户参数/10190010933

参数绑定

即利用反射机制，通过请求的Content-Type以及ShouldBind函数自动判断请求的格式来解析出来再绑定到返回的数据中，这里就和springboot的@RequestParam等注解自动解析差不多

type Login struct {User     string `form:"user" json:"user" binding:"required"`Password string `form:"password" json:"password" binding:"required"`
}func main() {router := gin.Default()// 绑定JSON的示例 ({"user": "q1mi", "password": "123456"})router.POST("/loginJSON", func(c *gin.Context) {var login Loginif err := c.ShouldBind(&login); err == nil {fmt.Printf("login info:%#v\n", login)c.JSON(http.StatusOK, gin.H{"user":     login.User,"password": login.Password,})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}})// 绑定form表单示例 (user=q1mi&password=123456)router.POST("/loginForm", func(c *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := c.ShouldBind(&login); err == nil {c.JSON(http.StatusOK, gin.H{"user":     login.User,"password": login.Password,})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}})// 绑定QueryString示例 (/loginQuery?user=q1mi&password=123456)router.GET("/loginQuery", func(c *gin.Context) {var login Login// ShouldBind()会根据请求的Content-Type自行选择绑定器if err := c.ShouldBind(&login); err == nil {c.JSON(http.StatusOK, gin.H{"user":     login.User,"password": login.Password,})} else {c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})}})// Listen and serve on 0.0.0.0:8080router.Run(":8080")
}

json格式

form格式

query格式

单文件上传

func main() {router := gin.Default()// 处理multipart forms提交文件时默认的内存限制是32 MiB// 可以通过下面的方式修改// router.MaxMultipartMemory = 8 << 20  // 8 MiBrouter.POST("/upload", func(c *gin.Context) {// 单个文件file, err := c.FormFile("f1")if err != nil {c.JSON(http.StatusInternalServerError, gin.H{"message": err.Error(),})return}log.Println(file.Filename)dst := fmt.Sprintf("/Users/kanyu/Desktop/project/kanyu_server/ginlearn/templates/user/%s", file.Filename)// 上传文件到指定的目录c.SaveUploadedFile(file, dst)c.JSON(http.StatusOK, gin.H{"message": fmt.Sprintf("'%s' uploaded!", file.Filename),})})router.Run()
}

原项目结构

postman上传文件

结果

可以看到文件上传成功目录下多了个3.zip文件

多文件上传

func main() {router := gin.Default()// 处理multipart forms提交文件时默认的内存限制是32 MiB// 可以通过下面的方式修改// router.MaxMultipartMemory = 8 << 20  // 8 MiBrouter.POST("/upload", func(c *gin.Context) {// Multipart formform, _ := c.MultipartForm()//取key=file的参数文件files := form.File["file"]for index, file := range files {log.Println(file.Filename)dst := fmt.Sprintf("/Users/kanyu/Desktop/project/kanyu_server/ginlearn/templates/user/_%d_%s", index, file.Filename)// 上传文件到指定的目录c.SaveUploadedFile(file, dst)}c.JSON(http.StatusOK, gin.H{"message": fmt.Sprintf("%d files uploaded!", len(files)),})})router.Run()
}

原项目结构

postman调用多文件上传

项目结构

路由

常规路由

router.GET("/", func(c *gin.Context) {}router.POST("/", func(c *gin.Context) {}router.GET("/", func(c *gin.Context) {}

这些路由在之前参数获取的时候讲过了

和java中差不多根据请求类型和路径的不同获取请求的参数进行处理

Any

func main() {router := gin.Default()router.Any("/", func(c *gin.Context) {c.JSON(200, gin.H{"message": "Hello world!",})})router.Run()
}

get请求

post请求

可以看到无论请求类型如何都会返回程序中定义的"Hello world!"

NoRoute

即无路由请求传任何路径的返回处理

func main() {router := gin.Default()router.NoRoute(func(c *gin.Context) {c.JSON(200, gin.H{"message": "404 Not Found",})})router.Run()
}

给定任意路径

路由组

相当于Java springboot的如下结构利用@RestController和@RequestMapping("/chat")

都拥有共同的前缀/chat

所以拥有共同的前缀url划分为路由组

func main() {r := gin.Default()userGroup := r.Group("/user"){userGroup.GET("/index", func(c *gin.Context) {c.JSON(200, gin.H{"message": "user index",})})userGroup.GET("/login", func(c *gin.Context) {c.JSON(200, gin.H{"message": "user login GET",})})userGroup.POST("/login", func(c *gin.Context) {c.JSON(200, gin.H{"message": "user login POST",})})}shopGroup := r.Group("/shop"){shopGroup.GET("/index", func(c *gin.Context) {c.JSON(200, gin.H{"message": "shop login",})})shopGroup.GET("/cart", func(c *gin.Context) {c.JSON(200, gin.H{"message": "shop cart",})})shopGroup.POST("/checkout", func(c *gin.Context) {c.JSON(200, gin.H{"message": "shop checkout",})})// 嵌套路由组shouIndexGroup := shopGroup.Group("/index")shouIndexGroup.GET("/router", func(c *gin.Context) {c.JSON(200, gin.H{"message": "shop index router",})})}r.Run()
}

请求/user/index

请求GET /user/login

请求POST /user/login

请求/shop/index

请求/shop/cart

请求/shop/checkout

嵌套路由请求/shop/index/router

中间件

专注于HTTP请求处理流程的拦截与扩展，如日志记录、权限验证、异常恢复等。其核心是通过链式调用模式对单个请求生命周期进行功能增强，属于轻量级、高并发的Web开发组件，
比如Gin默认中间件gin.Logger()用于请求日志记录，gin.Recovery()用于panic恢复

gin框架的中间件类比Java

如Spring Interceptor的preHandle()和postHandle()方法，与Gin中间件的请求前后逻辑对应，适合权限检查、参数预处理等场景

如Java Servlet Filter均通过链式调用（Chain of Responsibility模式）拦截HTTP请求，可在请求处理前、后插入逻辑

定义中间件和注册

func StatCost() gin.HandlerFunc {return func(c *gin.Context) {start := time.Now()c.Set("name", "小王子") // 可以通过c.Set在请求上下文中设置值，后续的处理函数能够取到该值// 调用该请求的剩余处理程序c.Next()// 不调用该请求的剩余处理程序// c.Abort()// 计算耗时cost := time.Since(start)log.Println(cost)}
}// 全局注册路由
func main() {// 新建一个没有任何默认中间件的路由r := gin.New()// 注册一个全局中间件r.Use(StatCost())r.GET("/test", func(c *gin.Context) {name := c.MustGet("name").(string) // 从上下文取值log.Println(name)c.JSON(http.StatusOK, gin.H{"message": "Hello " + name,})})r.Run()
}

调用/test

可以看到返回了中间件前置处理塞进去的值 "小王子"

这里利用c.MustGet("name").(string)取到了上下文数值，底层利用了Context的能力，这个后续再记录下Context的核心实现和原理

单个路由注册中间件

func StatCost() gin.HandlerFunc {return func(c *gin.Context) {start := time.Now()c.Set("name", "小王子") // 可以通过c.Set在请求上下文中设置值，后续的处理函数能够取到该值// 调用该请求的剩余处理程序c.Next()// 不调用该请求的剩余处理程序// c.Abort()// 计算耗时cost := time.Since(start)log.Println(cost)}
}//记录响应体中间件type bodyLogWriter struct {gin.ResponseWriter               // 嵌入gin框架ResponseWriterbody               *bytes.Buffer // 我们记录用的response
}// Write 写入响应体数据
func (w bodyLogWriter) Write(b []byte) (int, error) {w.body.Write(b)                  // 我们记录一份return w.ResponseWriter.Write(b) // 真正写入响应
}// ginBodyLogMiddleware 一个记录返回给客户端响应体的中间件
// https://stackoverflow.com/questions/38501325/how-to-log-response-body-in-gin
func ginBodyLogMiddleware() gin.HandlerFunc {return func(c *gin.Context) {blw := &bodyLogWriter{body: bytes.NewBuffer([]byte{}), ResponseWriter: c.Writer}c.Writer = blw // 使用我们自定义的类型替换默认的c.Next() // 执行业务逻辑fmt.Println("Response body: " + blw.body.String()) // 事后按需记录返回的响应}
}func main() {// 新建一个没有任何默认中间件的路由r := gin.New()// 注册两个中间件 一个记录耗时 一个记录响应体 这里可以注册多个中间件r.GET("/test", StatCost(), ginBodyLogMiddleware(), func(c *gin.Context) {name := c.MustGet("name").(string) // 从上下文取值log.Println(name)c.JSON(http.StatusOK, gin.H{"message": "Hello " + name,})})r.Run()
}

请求