Last active
April 7, 2025 10:51
-
-
Save CJEnright/bc2d8b8dc0c1389a9feeddb110f822d7 to your computer and use it in GitHub Desktop.
Idiomatic golang net/http gzip transparent compression, an updated version of https://gist.github.com/bryfry/09a650eb8aac0fb76c24
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package main | |
import ( | |
"net/http" | |
"compress/gzip" | |
"io/ioutil" | |
"strings" | |
"sync" | |
"io" | |
) | |
var gzPool = sync.Pool { | |
New: func() interface{} { | |
w := gzip.NewWriter(ioutil.Discard) | |
return w | |
}, | |
} | |
type gzipResponseWriter struct { | |
io.Writer | |
http.ResponseWriter | |
} | |
func (w *gzipResponseWriter) WriteHeader(status int) { | |
w.Header().Del("Content-Length") | |
w.ResponseWriter.WriteHeader(status) | |
} | |
func (w *gzipResponseWriter) Write(b []byte) (int, error) { | |
return w.Writer.Write(b) | |
} | |
func Gzip(next http.Handler) http.Handler { | |
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | |
if !strings.Contains(r.Header.Get("Accept-Encoding"), "gzip") { | |
next.ServeHTTP(w, r) | |
return | |
} | |
w.Header().Set("Content-Encoding", "gzip") | |
gz := gzPool.Get().(*gzip.Writer) | |
defer gzPool.Put(gz) | |
gz.Reset(w) | |
defer gz.Close() | |
next.ServeHTTP(&gzipResponseWriter{ResponseWriter: w, Writer: gz}, r) | |
}) | |
} |
See also github.com/NYTimes/gziphandler.
Created a package for this: https://github.com/TelephoneTan/GoHTTPGzipServer
this code doesn't work for me... instead of showing the content it transfers an empty file
I think the defer Close
line should be before the defer gzpool.Put
. To prevent any writes going to the writer before being put back on the pool.
I did a little benchmarking and I didn't see any improvement using sync pool. It was actually slower.
I did a little benchmarking and I didn't see any improvement using sync pool. It was actually slower.
Implementing a sync mechanism probably will make your code slower, but more memory efficient since you don't allocate a new gzip writer on every request.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Another issue - if applied to e.g. Prometheus HTTP handlers, it will lead to double-gzipping. To avoid it, strip
Accept-Encoding
from the request before passing it down the handler chain.