142 lines
5.1 KiB
Markdown
142 lines
5.1 KiB
Markdown
[English](https://github.com/nanmu42/gzip/blob/master/README.md) | **中文**
|
||
|
||
# gzip
|
||
|
||
[](https://godoc.org/github.com/nanmu42/gzip)
|
||
[](https://github.com/nanmu42/gzip/actions)
|
||
[](https://codecov.io/gh/nanmu42/gzip)
|
||
[](https://github.com/nanmu42/gzip/actions)
|
||
[](https://goreportcard.com/report/github.com/nanmu42/gzip)
|
||
|
||
一个开箱即用，可定制，适用于[Gin](https://github.com/gin-gonic/gin)和[net/http](https://golang.org/pkg/net/http/)的gzip中间件。
|
||
|
||
|
||
|
||
# 使用示例
|
||
|
||
默认设置`DefaultHandler()`可以满足大部分场景。
|
||
|
||
## Gin
|
||
|
||
```go
|
||
import github.com/nanmu42/gzip
|
||
|
||
func main() {
|
||
g := gin.Default()
|
||
|
||
// 使用默认设定
|
||
g.Use(gzip.DefaultHandler().Gin)
|
||
|
||
g.GET("/", func(c *gin.Context) {
|
||
c.JSON(http.StatusOK, map[string]interface{}{
|
||
"code": 0,
|
||
"msg": "hello",
|
||
"data": fmt.Sprintf("l%sng!", strings.Repeat("o", 1000)),
|
||
})
|
||
})
|
||
|
||
log.Println(g.Run(fmt.Sprintf(":%d", 3000)))
|
||
}
|
||
```
|
||
|
||
## net/http
|
||
|
||
```go
|
||
import github.com/nanmu42/gzip
|
||
|
||
func main() {
|
||
mux := http.NewServeMux()
|
||
mux.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
|
||
writeString(w, fmt.Sprintf("This content is compressed: l%sng!", strings.Repeat("o", 1000)))
|
||
})
|
||
|
||
// 使用默认设定
|
||
log.Println(http.ListenAndServe(fmt.Sprintf(":%d", 3001), gzip.DefaultHandler().WrapHandler(mux)))
|
||
}
|
||
|
||
func writeString(w http.ResponseWriter, payload string) {
|
||
w.Header().Set("Content-Type", "text/plain; charset=utf8")
|
||
_, _ = io.WriteString(w, payload+"\n")
|
||
}
|
||
```
|
||
|
||
## 定制`Handler`
|
||
|
||
使用`NewHandler()`可以定制参数以满足你的特殊需要：
|
||
|
||
```go
|
||
import github.com/nanmu42/gzip
|
||
|
||
handler := gzip.NewHandler(gzip.Config{
|
||
// gzip压缩等级
|
||
CompressionLevel: 6,
|
||
// 触发gzip的最小body体积，单位：byte
|
||
MinContentLength: 1024,
|
||
// 请求过滤器基于请求来判断是否对这条请求的返回启用gzip，
|
||
// 过滤器按其定义顺序执行，下同。
|
||
RequestFilter: []RequestFilter{
|
||
NewCommonRequestFilter(),
|
||
DefaultExtensionFilter(),
|
||
},
|
||
// 返回header过滤器基于返回的header判断是否对这条请求的返回启用gzip
|
||
ResponseHeaderFilter: []ResponseHeaderFilter{
|
||
NewSkipCompressedFilter(),
|
||
DefaultContentTypeFilter(),
|
||
},
|
||
})
|
||
```
|
||
|
||
`RequestFilter` 和 `ResponseHeaderFilter` 是 interface.
|
||
你可以实现你自己的过滤器。
|
||
|
||
# 效率
|
||
|
||
* 当返回体积不大时，Handler会智能地跳过压缩，这个过程带来的代价可以忽略不记；
|
||
* 当返回体积足够大时，Handler会进行gzip压缩，这个过程有着合理的代价。
|
||
|
||
```
|
||
$ go test -benchmem -bench .
|
||
goos: linux
|
||
goarch: amd64
|
||
pkg: github.com/nanmu42/gzip
|
||
BenchmarkSoleGin_SmallPayload-4 4104684 276 ns/op 64 B/op 2 allocs/op
|
||
BenchmarkGinWithDefaultHandler_SmallPayload-4 1683307 707 ns/op 96 B/op 3 allocs/op
|
||
BenchmarkSoleGin_BigPayload-4 4198786 274 ns/op 64 B/op 2 allocs/op
|
||
BenchmarkGinWithDefaultHandler_BigPayload-4 44780 27636 ns/op 190 B/op 5 allocs/op
|
||
PASS
|
||
ok github.com/nanmu42/gzip 6.373s
|
||
```
|
||
|
||
注：由于[一个笨拙的人为错误](https://github.com/nanmu42/gzip/pull/3#issuecomment-735352715)，`v1.0.0`以及更早版本的评测指标是错误的，不具有参考意义。
|
||
|
||
# 局限性
|
||
|
||
* 你应该总是在返回中提供`Content-Type`。虽然Handler会在`Content-Type`缺失时使用`http.DetectContentType()`进行猜测，但是效果并没有那么好；
|
||
* 返回的`Content-Length` 缺失时，Handler可能会缓冲返回的报文数据以决定报文是否大到值得进行压缩，如果`MinContentLength`设置得太大，这个过程可能会带来内存压力。Handler针对这个情况做了一些优化，例如查看`http.ResponseWriter.Write(data []byte)`在首次调用时的 `len(data)`，以及资源复用。
|
||
|
||
# 项目状态：稳定
|
||
|
||
API已经稳定，`1.x`版本中的更新会向前兼容。
|
||
|
||
# 致谢
|
||
|
||
在本项目的开发中，作者参考了下列项目和资料：
|
||
|
||
* https://github.com/caddyserver/caddy/tree/master/caddyhttp/gzip (Apache License 2.0)
|
||
* https://github.com/gin-contrib/gzip (MIT License)
|
||
* https://blog.cloudflare.com/results-experimenting-brotli/
|
||
* https://support.cloudflare.com/hc/en-us/articles/200168396-What-will-Cloudflare-compress-
|
||
|
||
本项目使用[klauspost的compress库](https://github.com/klauspost/compress)中的gzip压缩实现。
|
||
|
||
Logo在[Gopherize.me](https://gopherize.me/)生成。
|
||
|
||
# License
|
||
|
||
```
|
||
MIT License
|
||
Copyright (c) 2019 LI Zhennan
|
||
|
||
Caddy is licensed under the Apache License
|
||
Copyright 2015 Light Code Labs, LLC
|
||
``` |