mirror of https://github.com/gofiber/fiber.git
100 lines
6.2 KiB
Markdown
100 lines
6.2 KiB
Markdown
---
|
|
id: cache
|
|
---
|
|
|
|
# Cache
|
|
|
|
Cache middleware for [Fiber](https://github.com/gofiber/fiber) designed to intercept responses and cache them. This middleware will cache the `Body`, `Content-Type` and `StatusCode` using the `c.Path()` as unique identifier. Special thanks to [@codemicro](https://github.com/codemicro/fiber-cache) for creating this middleware for Fiber core!
|
|
|
|
Request Directives<br />
|
|
`Cache-Control: no-cache` will return the up-to-date response but still caches it. You will always get a `miss` cache status.<br />
|
|
`Cache-Control: no-store` will refrain from caching. You will always get the up-to-date response.
|
|
|
|
## Signatures
|
|
|
|
```go
|
|
func New(config ...Config) fiber.Handler
|
|
```
|
|
|
|
## Examples
|
|
|
|
Import the middleware package that is part of the Fiber web framework
|
|
|
|
```go
|
|
import (
|
|
"github.com/gofiber/fiber/v2"
|
|
"github.com/gofiber/fiber/v2/middleware/cache"
|
|
)
|
|
```
|
|
|
|
After you initiate your Fiber app, you can use the following possibilities:
|
|
|
|
```go
|
|
// Initialize default config
|
|
app.Use(cache.New())
|
|
|
|
// Or extend your config for customization
|
|
app.Use(cache.New(cache.Config{
|
|
Next: func(c *fiber.Ctx) bool {
|
|
return c.Query("refresh") == "true"
|
|
},
|
|
Expiration: 30 * time.Minute,
|
|
CacheControl: true,
|
|
}))
|
|
```
|
|
|
|
Or you can custom key and expire time like this:
|
|
|
|
```go
|
|
app.Use(cache.New(cache.Config{
|
|
ExpirationGenerator: func(c *fiber.Ctx, cfg *cache.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
|
|
|
|
| Property | Type | Description | Default |
|
|
|:---------------------|:------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------|
|
|
| Next | `func(*fiber.Ctx) bool` | Next defines a function to skip this middleware when returned true. | `nil` |
|
|
| Expiration | `time.Duration` | Expiration is the time that a cached response will live. | `1 * time.Minute` |
|
|
| CacheHeader | `string` | CacheHeader is the header on the response header that indicates the cache status, with the possible return values "hit," "miss," or "unreachable." | `X-Cache` |
|
|
| CacheControl | `bool` | CacheControl enables client-side caching if set to true. | `false` |
|
|
| KeyGenerator | `func(*fiber.Ctx) string` | Key allows you to generate custom keys. | `func(c *fiber.Ctx) string { return utils.CopyString(c.Path()) }` |
|
|
| ExpirationGenerator | `func(*fiber.Ctx, *cache.Config) time.Duration` | ExpirationGenerator allows you to generate custom expiration keys based on the request. | `nil` |
|
|
| Storage | `fiber.Storage` | Store is used to store the state of the middleware. | In-memory store |
|
|
| Store (Deprecated) | `fiber.Storage` | Deprecated: Use Storage instead. | In-memory store |
|
|
| Key (Deprecated) | `func(*fiber.Ctx) string` | Deprecated: Use KeyGenerator instead. | `nil` |
|
|
| StoreResponseHeaders | `bool` | StoreResponseHeaders allows you to store additional headers generated by next middlewares & handler. | `false` |
|
|
| MaxBytes | `uint` | MaxBytes is the maximum number of bytes of response bodies simultaneously stored in cache. | `0` (No limit) |
|
|
| Methods | `[]string` | Methods specifies the HTTP methods to cache. | `[]string{fiber.MethodGet, fiber.MethodHead}` |
|
|
|
|
## Default Config
|
|
|
|
```go
|
|
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},
|
|
}
|
|
```
|