compress

README

elton-compress

Compress middleware for elton, it support gzip and br compress function by default.

• BrCompressor Brotli compression algorithm is better for http, most modern browser support it. Compress level is 1-11，default 0(6).
• GzipComperssor Gzip compression algorithm is most commonly used for http, all modern browser support it. Compress level is 1-9, default 0(6).
• SnappyCompressor Snappy compression algorithm is fast, but not aim for maximum compression. It's useful for Intranet. Not support compress level.
• ZstdCompressor Zstandard is a real-time compression algorithm, providing high compression ratios. Compress level is 1-2, default 0(2).
• S2Compressor S2 is a high performance replacement for Snappy. Compress level is 1-2, default 0(2).
• Lz4Compressor LZ4 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() {
	d := elton.New()

	d.Use(compress.NewDefault())

	d.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
	})

	d.ListenAndServe(":7001")
}

Example

middleware 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
  • func (b *BrCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
  • func (b *BrCompressor) Compress(buf []byte, level int) ([]byte, error)
  • func (b *BrCompressor) Pipe(c *elton.Context, level int) (err error)
• type Compressor
• type Config
  • func (conf *Config) AddCompressor(compressor Compressor)
• type GzipCompressor
  • func (g *GzipCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
  • func (g *GzipCompressor) Compress(buf []byte, level int) ([]byte, error)
  • func (g *GzipCompressor) Pipe(c *elton.Context, level int) (err error)
• type Lz4Compressor
  • func (*Lz4Compressor) Accept(c *elton.Context) (acceptable bool, encoding string)
  • func (*Lz4Compressor) Compress(buf []byte, level int) ([]byte, error)
  • func (*Lz4Compressor) Pipe(c *elton.Context, level int) (err error)
• type S2Compressor
  • func (*S2Compressor) Accept(c *elton.Context) (acceptable bool, encoding string)
  • func (*S2Compressor) Compress(buf []byte, level int) ([]byte, error)
  • func (*S2Compressor) Pipe(c *elton.Context, level int) (err error)
• type SnappyCompressor
  • func (s *SnappyCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
  • func (s *SnappyCompressor) Compress(buf []byte, level int) ([]byte, error)
  • func (s *SnappyCompressor) Pipe(c *elton.Context, level int) (err error)
• type ZstdCompressor
  • func (*ZstdCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)
  • func (*ZstdCompressor) Compress(buf []byte, level int) ([]byte, error)
  • func (*ZstdCompressor) Pipe(c *elton.Context, level int) (err error)

Constants

const (
	// BrEncoding br encoding
	BrEncoding = "br"
)

const (
	// GzipEncoding gzip encoding
	GzipEncoding = "gzip"
)

const (
	// Lz4Encoding lz4 encoding
	Lz4Encoding = "lz4"
)

const (
	// S2Encoding s2 encoding
	S2Encoding = "s2"
)

const (
	// SnappyEncoding snappy encoding
	SnappyEncoding = "snz"
)

const (
	// ZstdEncoding zstd encoding
	ZstdEncoding = "zst"
)

Functions

func AcceptEncoding

func AcceptEncoding(c *elton.Context, encoding string) (bool, string)

AcceptEncoding check request accept encoding

func New

func New(config Config) elton.Handler

New create a new compress middleware

func NewDefault

func NewDefault() elton.Handler

NewDefault create a default compress middleware, support gzip

func NewWithDefaultCompressor

func NewWithDefaultCompressor(config Config) elton.Handler

NewWithDefaultCompressor create compress middleware with default compressor

Types

type BrCompressor

type BrCompressor struct{}

BrCompressor brotli compress

func (*BrCompressor) Accept

func (b *BrCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)

Accept check accept econding

func (*BrCompressor) Compress

func (b *BrCompressor) Compress(buf []byte, level int) ([]byte, error)

Compress brotli compress

func (*BrCompressor) Pipe

func (b *BrCompressor) Pipe(c *elton.Context, level int) (err error)

Pipe brotli pipe

type Compressor

type Compressor interface {
	// Accept accept check function
	Accept(c *elton.Context) (acceptable bool, encoding string)
	// Compress compress function
	Compress([]byte, int) ([]byte, error)
	// Pipe pipe function
	Pipe(*elton.Context, int) error
}

Compressor compressor interface

type Config

type Config struct {
	// Levels compress levels, if not set the level for encoding,
	// it will use level config
	Levels map[string]int
	// Level compress level
	Level int
	// 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

func (conf *Config) AddCompressor(compressor Compressor)

AddCompressor add compressor

type GzipCompressor

type GzipCompressor struct{}

GzipCompressor gzip compress

func (*GzipCompressor) Accept

func (g *GzipCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)

Accept accept gzip encoding

func (*GzipCompressor) Compress

func (g *GzipCompressor) Compress(buf []byte, level int) ([]byte, error)

Compress compress data by gzip

func (*GzipCompressor) Pipe

func (g *GzipCompressor) Pipe(c *elton.Context, level int) (err error)

Pipe compress by pipe

type Lz4Compressor

type Lz4Compressor struct{}

Lz4Compressor lz4 compress

func (*Lz4Compressor) Accept

func (*Lz4Compressor) Accept(c *elton.Context) (acceptable bool, encoding string)

Accept check accept encoding

func (*Lz4Compressor) Compress

func (*Lz4Compressor) Compress(buf []byte, level int) ([]byte, error)

Compress lz4 compress

func (*Lz4Compressor) Pipe

func (*Lz4Compressor) Pipe(c *elton.Context, level int) (err error)

Pipe lz4 pipe compress

type S2Compressor

type S2Compressor struct{}

S2Compressor s2 compressor

func (*S2Compressor) Accept

func (*S2Compressor) Accept(c *elton.Context) (acceptable bool, encoding string)

Accept check accept encoding

func (*S2Compressor) Compress

func (*S2Compressor) Compress(buf []byte, level int) ([]byte, error)

Compress s2 compress

func (*S2Compressor) Pipe

func (*S2Compressor) Pipe(c *elton.Context, level int) (err error)

Pipe s2 pipe

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

func (*SnappyCompressor) Compress

func (s *SnappyCompressor) Compress(buf []byte, level int) ([]byte, error)

Compress snappy compress

func (*SnappyCompressor) Pipe

func (s *SnappyCompressor) Pipe(c *elton.Context, level int) (err error)

Pipe snappy pipe

type ZstdCompressor

type ZstdCompressor struct{}

ZstdCompressor zstd compress

func (*ZstdCompressor) Accept

func (*ZstdCompressor) Accept(c *elton.Context) (acceptable bool, encoding string)

Accept check accept encoding

func (*ZstdCompressor) Compress

func (*ZstdCompressor) Compress(buf []byte, level int) ([]byte, error)

Compress zstd compress

func (*ZstdCompressor) Pipe

func (*ZstdCompressor) Pipe(c *elton.Context, level int) (err error)

Pipe zstd pike