README
¶
elton-compress
Compress middleware for elton, it support gzip and br compress function by default.
BrCompressorBrotli compression algorithm is better for http, most modern browser support it. Compress level is 1-11，default 0(6).GzipComperssorGzip compression algorithm is most commonly used for http, all modern browser support it. Compress level is 1-9, default 0(6).SnappyCompressorSnappy compression algorithm is fast, but not aim for maximum compression. It's useful for Intranet. Not support compress level.ZstdCompressorZstandard is a real-time compression algorithm, providing high compression ratios. Compress level is 1-2, default 0(2).S2CompressorS2 is a high performance replacement for Snappy. Compress level is 1-2, default 0(2).Lz4CompressorLZ4 is lossless compression algorithm, providing compression speed > 500 MB/s per core, scalable with multi-cores CPU. Compress level higher is better, use 0 for fastest compression.
package main
import (
"bytes"
"github.com/vicanso/elton"
compress "github.com/vicanso/elton-compress"
)
func main() {
e := elton.New()
e.Use(compress.NewDefault())
e.GET("/", func(c *elton.Context) (err error) {
b := new(bytes.Buffer)
for i := 0; i < 1000; i++ {
b.WriteString("hello world\n")
}
c.SetHeader(elton.HeaderContentType, "text/plain; charset=utf-8")
c.BodyBuffer = b
return
})
err := e.ListenAndServe(":3000")
if err != nil {
panic(err)
}
}
Example
jquery-3.4.1.min.js(88145 bytes)
| compression | size | ratio | level |
|---|---|---|---|
| gzip | 30827 | 2.859 | 6 |
| br | 29897 | 2.948 | 6 |
| snappy | 47709 | 1.847 | - |
| zstd | 32816 | 2.686 | 2 |
| s2 | 42750 | 2.061 | 2 |
| lz4 | 39434 | 2.235 | 6 |
brotli
I use Pure Go Brotli instead of cbrotli, it is a little bit slow.
Test for encode html(113K) to br:
BenchmarkCBrotli-8 200 9555795 ns/op
BenchmarkGoBrotli-8 100 10703582 ns/op
Documentation
¶
Index ¶
- Constants
- func AcceptEncoding(c *elton.Context, encoding string) (bool, string)
- func New(config Config) elton.Handler
- func NewDefault() elton.Handler
- func NewWithDefaultCompressor(config Config) elton.Handler
- type BrCompressor
- type Compressor
- type Config
- type GzipCompressor
- type Lz4Compressor
- type S2Compressor
- type SnappyCompressor
- type ZstdCompressor
Constants ¶
View Source
const (
// BrEncoding br encoding
BrEncoding = "br"
)
View Source
const (
// GzipEncoding gzip encoding
GzipEncoding = "gzip"
)
View Source
const (
// Lz4Encoding lz4 encoding
Lz4Encoding = "lz4"
)
View Source
const (
// S2Encoding s2 encoding
S2Encoding = "s2"
)
View Source
const (
// SnappyEncoding snappy encoding
SnappyEncoding = "snz"
)
View Source
const (
// ZstdEncoding zstd encoding
ZstdEncoding = "zst"
)
Variables ¶
This section is empty.
Functions ¶
func AcceptEncoding ¶
AcceptEncoding check request accept encoding
func NewDefault ¶
NewDefault create a default compress middleware, support gzip
func NewWithDefaultCompressor ¶
NewWithDefaultCompressor create compress middleware with default compressor
Types ¶
type BrCompressor ¶
type BrCompressor struct {
Level int
}
BrCompressor brotli compress
func (*BrCompressor) Accept ¶
func (b *BrCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
Accept check accept econding
type Compressor ¶
type Compressor interface {
// Accept accept check function
Accept(c *elton.Context) (acceptable bool, encoding string)
// Compress compress function
Compress([]byte) (*bytes.Buffer, error)
// Pipe pipe function
Pipe(*elton.Context) error
}
Compressor compressor interface
type Config ¶
type Config struct {
// MinLength min compress length
MinLength int
// Checker check the data is compressable
Checker *regexp.Regexp
// Compressors compressor list
Compressors []Compressor
// Skipper skipper function
Skipper elton.Skipper
}
Config compress config
func (*Config) AddCompressor ¶ added in v0.1.1
func (conf *Config) AddCompressor(compressor Compressor)
AddCompressor add compressor
type GzipCompressor ¶
type GzipCompressor struct {
Level int
}
GzipCompressor gzip compress
func (*GzipCompressor) Accept ¶
func (g *GzipCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
Accept accept gzip encoding
type Lz4Compressor ¶ added in v0.1.4
type Lz4Compressor struct {
Level int
}
Lz4Compressor lz4 compress
func (*Lz4Compressor) Accept ¶ added in v0.1.4
func (*Lz4Compressor) Accept(c *elton.Context) (acceptable bool, encoding string)
Accept check accept encoding
type S2Compressor ¶ added in v0.1.4
type S2Compressor struct {
Level int
}
S2Compressor s2 compressor
func (*S2Compressor) Accept ¶ added in v0.1.4
func (*S2Compressor) Accept(c *elton.Context) (acceptable bool, encoding string)
Accept check accept encoding
type SnappyCompressor ¶
type SnappyCompressor struct {
}
SnappyCompressor snappy compress
func (*SnappyCompressor) Accept ¶
func (s *SnappyCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
Accept check accept encoding
type ZstdCompressor ¶ added in v0.1.4
type ZstdCompressor struct {
Level int
}
ZstdCompressor zstd compress
func (*ZstdCompressor) Accept ¶ added in v0.1.4
func (*ZstdCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
Accept check accept encoding
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.