Gin Gzip 中间件使用教程

目录结构及介绍

Gin Gzip 中间件的目录结构相对简单，主要包含以下几个文件和目录：

gin-contrib/gzip/
├── LICENSE
├── README.md
├── gzip.go
├── gzip_example_test.go
└── gzip_test.go

• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档，包含基本介绍和使用方法。
• gzip.go: 核心文件，包含了 Gzip 中间件的实现。
• gzip_example_test.go: 示例文件，展示了如何在 Gin 框架中使用 Gzip 中间件。
• gzip_test.go: 测试文件，包含了 Gzip 中间件的单元测试。

项目的启动文件介绍

Gin Gzip 中间件的启动文件是 gzip.go，该文件定义了 Gzip 中间件的实现。以下是 gzip.go 文件的主要内容：

package gzip

import (
	"compress/gzip"
	"net/http"
	"strings"

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

const (
	encodingGzip = "gzip"
)

type gzipResponseWriter struct {
	gin.ResponseWriter
	writer *gzip.Writer
}

func newGzipResponseWriter(w gin.ResponseWriter) *gzipResponseWriter {
	return &gzipResponseWriter{ResponseWriter: w, writer: gzip.NewWriter(w)}
}

func (g *gzipResponseWriter) Write(data []byte) (int, error) {
	return g.writer.Write(data)
}

func Gzip(level int) gin.HandlerFunc {
	return func(c *gin.Context) {
		if !shouldCompress(c.Request) {
			return
		}

		w := newGzipResponseWriter(c.Writer)
		c.Writer = w

		c.Header("Content-Encoding", encodingGzip)
		c.Header("Vary", "Accept-Encoding")

		defer w.writer.Close()
		c.Next()
	}
}

func shouldCompress(req *http.Request) bool {
	if !strings.Contains(req.Header.Get("Accept-Encoding"), encodingGzip) {
		return false
	}
	if req.Method != "GET" && req.Method != "HEAD" {
		return false
	}
	return true
}

该文件定义了 Gzip 中间件的核心逻辑，包括 Gzip 响应写入器的实现和 Gzip 中间件的注册方法。

项目的配置文件介绍

Gin Gzip 中间件本身没有独立的配置文件，其配置主要通过代码进行设置。在 gzip.go 文件中，可以通过 Gzip(level int) 函数来设置 Gzip 压缩的级别。以下是一个简单的示例：

package main

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

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

	// 使用 Gzip 中间件，设置压缩级别为 5
	r.Use(gzip.Gzip(5))

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

	r.Run(":8080")
}

在这个示例中，通过 gzip.Gzip(5) 设置了 Gzip 压缩的级别为 5，并将其应用到 Gin 的路由中。