This Laravel package can cache an entire response. By default it will cache all successful get-requests that return text based content (such as html and json) for a week. This could potentially speed up the response quite considerably.
So the first time a request comes in the package will save the response before sending it to the users. When the same request comes in again we're not going through the entire application but just respond with the saved response.
Spatie is a webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
You can install the package via composer:
composer require spatie/laravel-responsecache
The package will automatically register itself.
You can publish the config file with:
php artisan vendor:publish --provider="Spatie\ResponseCache\ResponseCacheServiceProvider"
This is the contents of the published config file:
// config/responsecache.php
return [
/*
* Determine if the response cache middleware should be enabled.
*/
'enabled' => env('RESPONSE_CACHE_ENABLED', true),
/*
* The given class will determinate if a request should be cached. The
* default class will cache all successful GET-requests.
*
* You can provide your own class given that it implements the
* CacheProfile interface.
*/
'cache_profile' => Spatie\ResponseCache\CacheProfiles\CacheAllSuccessfulGetRequests::class,
/*
* When using the default CacheRequestFilter this setting controls the
* default number of seconds responses must be cached.
*/
'cache_lifetime_in_seconds' => env('RESPONSE_CACHE_LIFETIME', 60 * 60 * 24 * 7),
/*
* This setting determines if a http header named "Laravel-responsecache"
* with the cache time should be added to a cached response. This
* can be handy when debugging.
*/
'add_cache_time_header' => env('APP_DEBUG', true),
/*
* Here you may define the cache store that should be used to store
* requests. This can be the name of any store that is
* configured in app/config/cache.php
*/
'cache_store' => env('RESPONSE_CACHE_DRIVER', 'file'),
/*
* Here you may define replacers that dynamically replace content from the response.
* Each replacer must implement the Replacer interface.
*/
'replacers' => [
\Spatie\ResponseCache\Replacers\CsrfTokenReplacer::class,
],
/*
* If the cache driver you configured supports tags, you may specify a tag name
* here. All responses will be tagged. When clearing the responsecache only
* items with that tag will be flushed.
*
* You may use a string or an array here.
*/
'cache_tag' => '',
/*
* This class is responsible for generating a hash for a request. This hash
* is used to look up an cached response.
*/
'hasher' => \Spatie\ResponseCache\Hasher\DefaultHasher::class,
];
And finally you should install the provided middlewares \Spatie\ResponseCache\Middlewares\CacheResponse::class
and \Spatie\ResponseCache\Middlewares\DoNotCacheResponse
in the http kernel.
// app/Http/Kernel.php
...
protected $middlewareGroups = [
'web' => [
...
\Spatie\ResponseCache\Middlewares\CacheResponse::class,
],
...
protected $routeMiddleware = [
...
'doNotCacheResponse' => \Spatie\ResponseCache\Middlewares\DoNotCacheResponse::class,
];
By default, the package will cache all successful get
-requests for a week.
Logged in users will each have their own separate cache. If this behaviour is what you
need, you're done: installing the ResponseCacheServerProvider
was enough.
The entire cache can be cleared with:
ResponseCache::clear();
This will clear everything from the cache store specified in the config-file.
The same can be accomplished by issuing this artisan command:
php artisan responsecache:clear
If you need to automate your cache clean up every time your model saves, you can create yourself a trait that hooks into the eloquent boot life cicle.
In this example the cache is cleaned whenever the eloquent events created
, updated
, or deleted
are called in this model.
<?php
namespace App\Traits;
use Spatie\ResponseCache\Facades\ResponseCache;
trait CacheAutoUpdater
{
public static function bootCacheAutoUpdater()
{
self::created(function ($model) {
ResponseCache::clear();
});
self::updated(function ($model) {
ResponseCache::clear();
});
self::deleted(function ($model) {
ResponseCache::clear();
});
}
}
// Then in your models
<?php
namespace App;
use App\Traits\CacheAutoUpdater;
use Illuminate\Database\Eloquent\Model;
class Page extends Model
{
use CacheAutoUpdater;
// ...
}
You can forget specific URIs with:
// Forget one URI
ResponseCache::forget('/some-uri');
// Forget several URIs
ResponseCache::forget(['/some-uri', '/other-uri']);
// Alternatively
ResponseCache::forget('/some-uri', '/other-uri');
The forget
method only works when you're not using a cacheNameSuffix
in your cache profile.
Requests can be ignored by using the doNotCacheResponse
-middleware.
This middleware can be assigned to routes and controllers.
Using the middleware are route could be exempt from being cached.
// app/Http/routes.php
Route::get('/auth/logout', ['middleware' => 'doNotCacheResponse', 'uses' => 'AuthController@getLogout']);
Alternatively, you can add the middleware to a controller:
class UserController extends Controller
{
public function __construct()
{
$this->middleware('doNotCacheResponse', ['only' => ['fooAction', 'barAction']]);
}
}
To determine which requests should be cached, and for how long, a cache profile class is used.
The default class that handles these questions is Spatie\ResponseCache\CacheProfiles\CacheAllSuccessfulGetRequests
.
You can create your own cache profile class by implementing the Spatie\ResponseCache\CacheProfiles\CacheProfile
-interface. Let's take a look at the interface:
interface CacheProfile
{
/*
* Determine if the response cache middleware should be enabled.
*/
public function enabled(Request $request): bool;
/*
* Determine if the given request should be cached.
*/
public function shouldCacheRequest(Request $request): bool;
/*
* Determine if the given response should be cached.
*/
public function shouldCacheResponse(Response $response): bool;
/*
* Return the time when the cache must be invalidated.
*/
public function cacheRequestUntil(Request $request): DateTime;
/**
* Return a string to differentiate this request from others.
*
* For example: if you want a different cache per user you could return the id of
* the logged in user.
*
* @param \Illuminate\Http\Request $request
*
* @return mixed
*/
public function useCacheNameSuffix(Request $request);
}
Instead of registering the cacheResponse
middleware globally, you can also register it as route middleware.
protected $routeMiddleware = [
...
'cacheResponse' => \Spatie\ResponseCache\Middlewares\CacheResponse::class,
];
When using the route middleware you can specify the number of seconds these routes should be cached:
// cache this route for 5 minutes
Route::get('/my-special-snowflake', 'SnowflakeController@index')->middleware('cacheResponse:300');
// cache all these routes for 10 minutes
Route::group(function() {
Route::get('/another-special-snowflake', 'AnotherSnowflakeController@index');
Route::get('/yet-another-special-snowflake', 'YetAnotherSnowflakeController@index');
})->middleware('cacheResponse:600');
There are several events you can use to monitor and debug response caching in your application.
Spatie\ResponseCache\Events\ResponseCacheHit
This event is fired when a request passes through the ResponseCache
middleware and a cached response was found and returned.
Spatie\ResponseCache\Events\CacheMissed
This event is fired when a request passes through the ResponseCache
middleware but no cached response was found or returned.
Spatie\ResponseCache\Events\ClearingResponseCache
Spatie\ResponseCache\Events\ClearedResponseCache
These events are fired respectively when the responsecache:clear
is started and finished.
To replace cached content by dynamic content, you can create a replacer.
By default we add a CsrfTokenReplacer
in the config file.
You can create your own replacers by implementing the Spatie\ResponseCache\Replacers\Replacer
-interface. Let's take a look at the interface:
interface Replacer
{
/*
* Transform the initial response before it gets cached.
*
* For example: replace a generated csrf_token by '<csrf-token-here>' that you can
* replace with its dynamic counterpart when the cached response is returned.
*/
public function transformInitialResponse(Response $response): void;
/*
* Replace any data you want in the cached response before it gets
* sent to the browser.
*
* For example: replace '<csrf-token-here>' by a call to csrf_token()
*/
public function replaceCachedResponse(Response $response): void;
}
Afterwards you can define your replacer in the responsecache.php
config file:
/*
* Here you may define replacers that dynamically replace content from the response.
* Each replacer must implement the Replacer interface.
*/
'replacers' => [
\Spatie\ResponseCache\Replacers\CsrfTokenReplacer::class,
],
Please see CHANGELOG for more information what has changed recently.
You can run the tests with:
composer test
- Barry Vd. Heuvel made a package that caches responses by leveraging HttpCache.
- Joseph Silber created Laravel Page Cache that can write it's cache to disk and let Nginx read them, so PHP doesn't even have to start up anymore.
Please see CONTRIBUTING for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.
Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.
We publish all received postcards on our company website.
Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.
Does your business depend on our contributions? Reach out and support us on Patreon. All pledges will be dedicated to allocating workforce on maintenance and new awesome stuff.
The MIT License (MIT). Please see License File for more information.