37.用Gin完成一个简易待办事项管理后端代码(三）gin路由分组与中间件

代码地址：https://gitee.com/lymgoforIT/golang-trick/tree/master/24-gin-learning

• 中间件：是一种在请求过程中拦截和处理请求的机制，它可以在请求到达处理器之前或者之后 执行一些操作，比如：记录，缓存，验证等等。
• 路由分组：是将相关的路由分组放在一起，便于管理和维护的机制。

一：一级路由分组

package main

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

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

	// 创建路由分组
	api := r.Group("/api")

	// 定义路由分组里面的路由
	// Get /users
	api.GET("/users", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "get all users"})
	})

	// Post /users
	api.POST("/users", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "Create user"})
	})

	// Put /users
	api.PUT("/users/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Update user " + id})
	})

	// Delete /users
	api.DELETE("/users/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Delete user " + id})
	})
	r.Run(":8080")
}

启动后可以在终端看到注册的路由，注意有/api开头
以get请求为例

二：中间件

假如有一个诉求，想要记录每个请求的完成时间，那么思路很明显，记录请求到达时间，以及请求完成时间，求差即可。但是如果在每个处理方法中都加这样的代码显然是非常冗余、难以维护、侵入业务代码的，此时中间件就派上用场了。

package main

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

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

	// 创建路由分组
	api := r.Group("/api")

	// 对/api路由分组使用中间件
	api.Use(Logger())
	
	// 定义路由分组里面的路由
	// Get /users
	api.GET("/users", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "get all users"})
	})

	// Post /users
	api.POST("/users", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "Create user"})
	})

	// Put /users
	api.PUT("/users/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Update user " + id})
	})

	// Delete /users
	api.DELETE("/users/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Delete user " + id})
	})
	r.Run(":8080")
}

func Logger() gin.HandlerFunc {
	return func(c *gin.Context) {
		t := time.Now()

		// 请求前的日志
		log.Printf("[%s] %s %s \n", t.Format("2006-01-02 15:04:05"), c.Request.Method, c.Request.URL.Path)

		// 处理请求
		c.Next()

		// 请求处理完打印日志
		log.Printf("[%s] %s %s %d\n", t.Format("2006-01-02 15:04:05"), c.Request.Method, c.Request.URL.Path, time.Since(t))
	}
}

注：

• gin中间件是gin.HandlerFunc类型，实际就是func(c *gin.Context) {}类型
• 使用时，用Use方法即可

测试get和post方法，查看终端日志

三：二级路由分组

二级路由分组即在一级分组下可以继续使用Group方法进行分组，比如下面在v1分组下有两个二级分组users和posts

package main

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

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

	// 创建一级路由分组
	v1 := r.Group("/v1")

	// 创建二级路由分组
	users := v1.Group("/users")

	// 定义二级路由分组里面的路由
	// Get /users
	users.GET("/", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "get all users"})
	})

	// Post /users
	users.POST("/", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "Create user"})
	})

	// Put /users
	users.PUT("/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Update user " + id})
	})

	// Delete /users
	users.DELETE("/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Delete user " + id})
	})

	// 创建二级路由分组
	posts := v1.Group("/posts")

	// Get /posts
	posts.GET("/", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "get all posts"})
	})

	// Post /posts
	posts.POST("/", func(c *gin.Context) {
		c.JSON(http.StatusOK, gin.H{"data": "Create post"})
	})

	// Put /posts
	posts.PUT("/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Update post " + id})
	})

	// Delete /posts
	posts.DELETE("/:id", func(c *gin.Context) {
		id := c.Param("id")
		c.JSON(http.StatusOK, gin.H{"data": "Delete post " + id})
	})

	r.Run(":8080")
}

启动后可以在终端看到注册的路由

测试：以get请求为例