README
¶
wcache
A high performance gin middleware to cache http response. Compared to gin cache. It has a huge performance improvement.
Feature
- Has a huge performance improvement compared to gin-contrib/cache.
- Cache http response in local memory or Redis.
- Offer a way to custom the cache strategy by per request.
- Use singleflight to avoid cache breakdown problem.
How To Use
Install
go get -u github.com/wyy-go/wcache
Example
Cache In Local Memory
package main
import (
"github.com/wyy-go/wcache/persist/memory"
"time"
"github.com/gin-gonic/gin"
"github.com/wyy-go/wcache"
)
func main() {
app := gin.New()
memoryStore := memory.NewMemoryStore(1 * time.Minute)
app.GET("/hello",
wcache.CacheByRequestURI(
wcache.WithCacheStore(memoryStore),
wcache.WithExpire(2*time.Second),
wcache.WithHandle(func(c *gin.Context) {
c.String(200, "hello world")
})),
)
if err := app.Run(":8080"); err != nil {
panic(err)
}
}
Cache In Redis
package main
import (
redisStore "github.com/wyy-go/wcache/persist/redis"
"time"
"github.com/gin-gonic/gin"
"github.com/go-redis/redis/v8"
"github.com/wyy-go/wcache"
)
func main() {
app := gin.New()
store := redisStore.NewRedisStore(redis.NewClient(&redis.Options{
Network: "tcp",
Addr: "127.0.0.1:6379",
DB: 0,
}))
app.GET("/hello",
wcache.CacheByRequestURI(
wcache.WithCacheStore(store),
wcache.WithExpire(2*time.Second),
wcache.WithHandle(func(c *gin.Context) {
c.String(200, "hello world")
})),
)
if err := app.Run(":8080"); err != nil {
panic(err)
}
}
Benchmark
wrk -c 500 -d 1m -t 5 http://127.0.0.1:8080/hello
MemoryStore
RedisStore
Documentation
¶
Index ¶
- Variables
- func Cache(opts ...Option) gin.HandlerFunc
- func CacheByRequestPath(opts ...Option) gin.HandlerFunc
- func CacheByRequestURI(opts ...Option) gin.HandlerFunc
- func CacheKeyWithPrefix(prefix, key string) string
- func GenerateCacheKeyByPath(c *gin.Context) (string, bool)
- func GenerateCacheKeyByURI(c *gin.Context) (string, bool)
- type Discard
- type Encoding
- type GenerateCacheKey
- type JSONEncoding
- type JSONGzipEncoding
- type Logger
- type OnHitCacheCallback
- type OnShareSingleFlightCallback
- type Option
- func WithCacheStore(store persist.CacheStore) Option
- func WithEncoding(encode Encoding) Option
- func WithExpire(expire time.Duration) Option
- func WithGenerateCacheKey(f GenerateCacheKey) Option
- func WithHandle(handle gin.HandlerFunc) Option
- func WithLogger(l Logger) Option
- func WithOnHitCache(cb OnHitCacheCallback) Option
- func WithOnShareSingleFlight(cb OnShareSingleFlightCallback) Option
- func WithPool(pool Pool) Option
- func WithRand(rand Rand) Option
- func WithSingleFlightForgetTimeout(forgetTimeout time.Duration) Option
- func WithSingleflight(group *singleflight.Group) Option
- type Options
- type Pool
- type Rand
- type ResponseCache
Constants ¶
This section is empty.
Variables ¶
View Source
var PageCachePrefix = "wcache.page.cache:"
PageCachePrefix default page cache key prefix
Functions ¶
func Cache ¶
func Cache(opts ...Option) gin.HandlerFunc
Cache user must pass getCacheKey to describe the way to generate cache key
func CacheByRequestPath ¶
func CacheByRequestPath(opts ...Option) gin.HandlerFunc
CacheByRequestPath a shortcut function for caching response by url path, means will discard the query params
func CacheByRequestURI ¶
func CacheByRequestURI(opts ...Option) gin.HandlerFunc
CacheByRequestURI a shortcut function for caching response by uri
func CacheKeyWithPrefix ¶
func GenerateCacheKeyByPath ¶
GenerateCacheKeyByPath generate key with PageCachePrefix and request Path
Types ¶
type Discard ¶
type Discard struct {
}
Discard the default logger that will discard all logs of gin-cache
func NewDiscard ¶
func NewDiscard() Discard
NewDiscard a discard logger on which always succeed without doing anything
type Encoding ¶
type Encoding interface {
Marshal(v interface{}) ([]byte, error)
Unmarshal(data []byte, v interface{}) error
}
Encoding interface
type JSONEncoding ¶
type JSONEncoding struct{}
func (JSONEncoding) Marshal ¶
func (JSONEncoding) Marshal(v interface{}) ([]byte, error)
func (JSONEncoding) Unmarshal ¶
func (JSONEncoding) Unmarshal(data []byte, v interface{}) error
type JSONGzipEncoding ¶
type JSONGzipEncoding struct{}
func (JSONGzipEncoding) Marshal ¶
func (JSONGzipEncoding) Marshal(v interface{}) ([]byte, error)
func (JSONGzipEncoding) Unmarshal ¶
func (JSONGzipEncoding) Unmarshal(data []byte, v interface{}) error
type Logger ¶
type Logger interface {
Errorf(string, ...interface{})
}
Logger define the logger interface
type OnHitCacheCallback ¶
OnHitCacheCallback define the callback when use cache
type OnShareSingleFlightCallback ¶
OnShareSingleFlightCallback define the callback when share the singleflight result
type Option ¶
type Option func(c *Options)
Option represents the optional function.
func WithCacheStore ¶
func WithCacheStore(store persist.CacheStore) Option
func WithEncoding ¶
func WithExpire ¶
func WithGenerateCacheKey ¶
func WithGenerateCacheKey(f GenerateCacheKey) Option
func WithHandle ¶
func WithHandle(handle gin.HandlerFunc) Option
func WithOnHitCache ¶
func WithOnHitCache(cb OnHitCacheCallback) Option
WithOnHitCache will be called when cache hit.
func WithOnShareSingleFlight ¶
func WithOnShareSingleFlight(cb OnShareSingleFlightCallback) Option
WithOnShareSingleFlight will be called when share the singleflight result
func WithSingleFlightForgetTimeout ¶
WithSingleFlightForgetTimeout to reduce the impact of long tail requests. when request in the singleflight, after the forget timeout, singleflight.Forget will be called
func WithSingleflight ¶
func WithSingleflight(group *singleflight.Group) Option
type Options ¶
type Options struct {
// contains filtered or unexported fields
}
Options contains all options
type Pool ¶
type Pool interface {
Get() *ResponseCache
Put(*ResponseCache)
}
type ResponseCache ¶
type ResponseCache struct {
Status int
Header http.Header
Data []byte
// contains filtered or unexported fields
}
func (*ResponseCache) MarshalBinary ¶
func (c *ResponseCache) MarshalBinary() ([]byte, error)
func (*ResponseCache) UnmarshalBinary ¶
func (c *ResponseCache) UnmarshalBinary(data []byte) error
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.