mirror of https://github.com/gofiber/fiber.git
129 lines
3.2 KiB
Go
129 lines
3.2 KiB
Go
package cache
|
|
|
|
import (
|
|
"log"
|
|
"time"
|
|
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/gofiber/fiber/v2/utils"
|
|
)
|
|
|
|
// 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
|
|
|
|
// Deprecated: Use Storage instead
|
|
Store fiber.Storage
|
|
|
|
// Deprecated: Use KeyGenerator instead
|
|
Key func(*fiber.Ctx) string
|
|
|
|
// 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
|
|
|
|
// You can specify HTTP methods to cache.
|
|
// The middleware just caches the routes of its methods in this slice.
|
|
//
|
|
// Default: []string{fiber.MethodGet, fiber.MethodHead}
|
|
Methods []string
|
|
}
|
|
|
|
// 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,
|
|
Methods: []string{fiber.MethodGet, fiber.MethodHead},
|
|
}
|
|
|
|
// Helper function to set default values
|
|
func configDefault(config ...Config) Config {
|
|
// Return default config if nothing provided
|
|
if len(config) < 1 {
|
|
return ConfigDefault
|
|
}
|
|
|
|
// Override default config
|
|
cfg := config[0]
|
|
|
|
// Set default values
|
|
if cfg.Store != nil {
|
|
log.Printf("[CACHE] Store is deprecated, please use Storage\n")
|
|
cfg.Storage = cfg.Store
|
|
}
|
|
if cfg.Key != nil {
|
|
log.Printf("[CACHE] Key is deprecated, please use KeyGenerator\n")
|
|
cfg.KeyGenerator = cfg.Key
|
|
}
|
|
if cfg.Next == nil {
|
|
cfg.Next = ConfigDefault.Next
|
|
}
|
|
if int(cfg.Expiration.Seconds()) == 0 {
|
|
cfg.Expiration = ConfigDefault.Expiration
|
|
}
|
|
if cfg.CacheHeader == "" {
|
|
cfg.CacheHeader = ConfigDefault.CacheHeader
|
|
}
|
|
if cfg.KeyGenerator == nil {
|
|
cfg.KeyGenerator = ConfigDefault.KeyGenerator
|
|
}
|
|
if len(cfg.Methods) == 0 {
|
|
cfg.Methods = ConfigDefault.Methods
|
|
}
|
|
return cfg
|
|
}
|