fiber/middleware/cache
Muhammed Efe Çetin ca6f25a890
v3 (deps): move `utils` to `https://github.com/gofiber/utils`
2022-09-23 21:19:44 +03:00
..
README.md Merge remote-tracking branch 'origin/master' into v3-beta 2022-08-19 14:33:31 +03:00
cache.go v3 (deps): move `utils` to `https://github.com/gofiber/utils` 2022-09-23 21:19:44 +03:00
cache_test.go v3 (deps): move `utils` to `https://github.com/gofiber/utils` 2022-09-23 21:19:44 +03:00
config.go v3 (deps): move `utils` to `https://github.com/gofiber/utils` 2022-09-23 21:19:44 +03:00
heap.go v3: replace interface{}s by any 2022-05-31 17:41:38 +03:00
manager.go v3: remove internal/template/html, replace internal/memory by internal/storage/memory 2022-06-04 14:19:59 +03:00
manager_msgp.go 📝 docs: gofmt & add missing copyright texts (#2013) 2022-08-15 20:25:26 +02:00

README.md

Cache Middleware

Cache middleware for Fiber designed to intercept responses and cache them. This middleware will cache the Body, Content-Type and StatusCode using the c.Path() (or a string returned by the Key function) as unique identifier. Special thanks to @codemicro for creating this middleware for Fiber core!

Table of Contents

Signatures

func New(config ...Config) fiber.Handler

Examples

First import the middleware from Fiber,

import (
  "github.com/gofiber/fiber/v3"
  "github.com/gofiber/fiber/v3/middleware/cache"
)

Then create a Fiber app with app := fiber.New().

Default Config

app.Use(cache.New())

Custom Config

app.Use(cache.New(cache.Config{
	Next: func(c fiber.Ctx) bool {
		return c.Query("refresh") == "true"
	},
	Expiration: 30 * time.Minute,
	CacheControl: true,
}))

Custom Cache Key Or Expiration

app.Use(New(Config{
	ExpirationGenerator: func(c fiber.Ctx, cfg *Config) time.Duration {
		newCacheTime, _ := strconv.Atoi(c.GetRespHeader("Cache-Time", "600"))
		return time.Second * time.Duration(newCacheTime)
	},
	KeyGenerator: func(c fiber.Ctx) string {
		return utils.CopyString(c.Path())
	}
}))

app.Get("/", func(c fiber.Ctx) error {
	c.Response().Header.Add("Cache-Time", "6000")
	return c.SendString("hi")
})

Config

// Config defines the config for middleware.
type Config struct {
	// Next defines a function to skip this middleware when returned true.
	//
	// Optional. Default: nil
	Next func(c fiber.Ctx) bool

	// Expiration is the time that an cached response will live
	//
	// Optional. Default: 1 * time.Minute
	Expiration time.Duration

	// CacheHeader header on response header, indicate cache status, with the following possible return value
	//
	// hit, miss, unreachable
	//
	// Optional. Default: X-Cache
	CacheHeader string

	// CacheControl enables client side caching if set to true
	//
	// Optional. Default: false
	CacheControl bool

	// Key allows you to generate custom keys, by default c.Path() is used
	//
	// Default: func(c fiber.Ctx) string {
	//   return utils.CopyString(c.Path())
	// }
	KeyGenerator func(fiber.Ctx) string

	// allows you to generate custom Expiration Key By Key, default is Expiration (Optional)
	//
	// Default: nil
	ExpirationGenerator func(fiber.Ctx, *Config) time.Duration

	// Store is used to store the state of the middleware
	//
	// Default: an in memory store for this process only
	Storage fiber.Storage

	// allows you to store additional headers generated by next middlewares & handler
	//
	// Default: false
	StoreResponseHeaders bool

	// Max number of bytes of response bodies simultaneously stored in cache. When limit is reached,
	// entries with the nearest expiration are deleted to make room for new.
	// 0 means no limit
	//
	// Default: 0
	MaxBytes uint
}

Default Config

// ConfigDefault is the default config
var ConfigDefault = Config{
	Next:         nil,
	Expiration:   1 * time.Minute,
	CacheHeader:  "X-Cache",
	CacheControl: false,
	KeyGenerator: func(c fiber.Ctx) string {
		return utils.CopyString(c.Path())
	},
	ExpirationGenerator:  nil,
	StoreResponseHeaders: false,
	Storage:              nil,
	MaxBytes:             0,
}