4.gin中间件

一、入门版

在日常工作中，经常会有一些计算接口耗时和限流的操作，如果每写一个接口都需要手动的去加上计算耗时和限流的代码，显然是很冗余且不好维护的，还很容易遗漏。这个时候我们一般会想到使用中间件的方式，将这些与业务无关的代码写到中间件去，然后安到每个接口中去就行了。

package main

import (
	"fmt"
	"net/http"
	"time"

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

func timeMiddleware() gin.HandlerFunc {
	return func(ctx *gin.Context) {
		begin := time.Now()
		defer func() {
			fmt.Printf("use time %d ms\n", time.Since(begin).Milliseconds())
		}()
		ctx.Next()
	}
}



func limitMiddleware() gin.HandlerFunc {
	// 限流最高并发为10,这里return的func通过闭包使用这个limitChan，即所有请求共用的是同一个limitChan，从而达到限流效果
	limitChan := make(chan struct{}, 10)  
	return func(ctx *gin.Context) {
		defer func() {
			<-limitChan
		}()
		limitChan <- struct{}{}
		
		ctx.Next()
	}
}

func bizHandler(ctx *gin.Context) {
	time.Sleep(100 * time.Millisecond)
	ctx.String(http.StatusOK, "gin 中间件")

}

func main() {
	engine := gin.Default()
	// Use方法就是将中间件放到了链条的首部，注意Use接收的是可变参数，可接收多个中间件
	// engine.Use(timeMiddleware(),limitMiddleware())
	// 如果是分别使用use，则要注意一下顺序，如这里将timeMiddleware后写，
	//是因为想把timeMiddleware放到链条首部，从而将限流中间件的耗时也统计到
	engine.Use(limitMiddleware())
	engine.Use(timeMiddleware())
	engine.GET("/v1", bizHandler)
	// engine.GET("/v2",timeMiddleware(), bizHandler)
	engine.Run("127.0.0.1:8080")
}

注意事项：

1. 中间件是gin.HandlerFunc类型，在使用limitMiddleware和timeMiddleware时，我们加了小括号，因为它们的返回值才是gin.HandlerFunc类型
2. engine.Get,engine.Post,engine.Use方法，接收的都是可变长参数，如示例中的v2路径，可以直接将中间件对指定的路径使用，或者用Use一次全局使用多个中间件
3. 使用多个Use时，注意使用顺序，后使用的Use，里面的中间件会放到链表首部
4. 如果中间件中没有使用ctx.Next,则是将当前中间件执行完后再去执行链表上的下一个handler，如果使用了ctx.Next则表示从此处开始，先将链表后面的handler都执行完，然后再回溯到这里的ctx.Next位置来，继续执行当前中间件函数中的后续代码。

二、进阶版

场景一：访问 ResponseWriter 和 Request

中间件的核心在于处理函数，因此它本身就是一个处理函数。它执行自己的逻辑，然后调用传入的处理函数，并将 ResponseWriter 和 Request 对象传递给它(装饰器模式）。下面是如何实现的：

func Middleware(handler http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        // 中间件逻辑
        handler(w, r)
    }
}

场景二：接受附加参数

为了使中间件能够接受额外的参数，我们可以创建一个封装函数，它返回一个新的中间件，这个中间件接受额外的依赖项。这样做可以避免函数签名的复杂性。下面是具体的实现方法：

func MiddlewareWithDependency(dep1 interface{}, dep2 int) Middleware {
    return func(handler http.HandlerFunc) http.HandlerFunc {
        // 使用依赖项 dep1 和 dep2 的中间件逻辑
        // ...
        return handler
    }
}

场景三：相继应用中间件

要在单个路由上应用多个中间件，我们可以定义一个中间件类型，并创建一个 MiddlewareChain 函数，它接受多个中间件，并返回一个新的中间件。这个函数会按顺序应用所有的中间件，实际上场景三的写法类似场景二，接收了额外参数，返回一个中间件，只是应用场景比较固定，即主要用于多层嵌套中间件：

type Middleware func(http.HandlerFunc) http.HandlerFunc

func MiddlewareChain(middlewares ...Middleware) Middleware {
    return func(handler http.HandlerFunc) http.HandlerFunc {
        for _, mw := range middlewares {
            handler = mw(handler)
        }
        return handler
    }
}

实战示例：在 Go 代码库中使用中间件

让我们通过一个简单的示例来展示如何在 Go 代码库中应用中间件。你可以根据需要实现更复杂的功能，并将它们应用到应用程序的不同部分。

package main

import (
    "fmt"
    "log"
    "net/http"
)

// LoggingMiddleware 记录传入的请求
func LoggingMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        log.Printf("请求 URI: %s\\n", r.RequestURI)
        next(w, r) // 调用下一个处理函数
    }
}

// AuthMiddleware 对用户进行认证
func AuthMiddleware(next http.HandlerFunc) http.HandlerFunc {
    return func(w http.ResponseWriter, r *http.Request) {
        // 执行认证逻辑
        isAuthenticated := true // 仅用于演示

        if isAuthenticated {
            next(w, r) // 如果认证通过，则调用下一个处理函数
        } else {
            http.Error(w, "Unauthorized", http.StatusUnauthorized)
        }
    }
}

// HelloHandler 是一个示例处理函数
func HelloHandler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "Hello, world!")
}

func main() {
    // 定义中间件链【这是场景三，但实际上类似场景二，接收了额外参数，返回一个中间件】
    middlewareChain := MiddlewareChain(LoggingMiddleware, AuthMiddleware)

    // 应用中间件到处理函数
    http.HandleFunc("/", middlewareChain(HelloHandler))

    // 启动 HTTP 服务器
    fmt.Println("服务器正在端口 8080 上运行...")
    if err := http.ListenAndServe(":8080", nil); err != nil {
        log.Fatal(err)
    }
}

三、结语

中间件本质上是处理函数的函数，它们处理请求，然后将响应传递给下一个处理函数。它们通常在出现错误或不满足特定条件时返回响应，或用于防止未验证的请求、未授权的操作或监控应用程序活动。通过封装条件逻辑，中间件避免了代码的重复，提供了一种灵活的方式来处理网络应用程序中的常见任务。利用中间件，我们可以确保代码的组织性、可重用性和可维护性。