Unlocking Performance and Scalability: Exploring Laravel Cache in Depth with Examples

May 25, 2023, Tags - Laravel PHP

Caching plays a crucial role in improving the performance and scalability of web applications. Laravel, a popular PHP framework, provides a powerful caching system called Laravel Cache. It allows developers to store frequently accessed data in memory, reducing the need to query the database or perform expensive computations repeatedly.

Laravel Cache supports various drivers like in-memory, file-based, database, and more. By default, Laravel uses the file-based driver, but you can easily switch to other drivers according to your application requirements.

Configuring the Cache:

Before using Laravel Cache, you need to configure the cache settings. The configuration file is located at config/cache.php. Here, you can specify the default cache driver, cache stores, and other related options.

Let's take a look at an example of configuring the cache to use the Redis driver:

// config/cache.php

return [
    // ...

    'default' => env('CACHE_DRIVER', 'redis'),

    'stores' => [
        // ...

        'redis' => [
            'driver' => 'redis',
            'connection' => 'cache',
        ],
    ],

    // ...
];

In this example, we set the default cache driver to redis. Additionally, we define the Redis connection named 'cache'.

Using the Cache:

Once the cache is configured, you can start utilizing it throughout your application. Laravel provides a clean and expressive syntax to interact with the cache.

  1. Storing Values: To store a value in the cache, you can use the put method. The data will be stored with a specified key and an optional expiration time.
    use Illuminate\Support\Facades\Cache;
    
    // Store a value in the cache for 1 hour
    Cache::put('key', 'value', 60);​


    Alternatively, you can use the add method to store a value only if the given key does not exist in the cache.

    Cache::add('key', 'value', 60); // Store if not already present

     

  2. Retrieving Values: To retrieve a value from the cache, you can use the get method. If the specified key does not exist or has expired, null will be returned.
    $value = Cache::get('key');
    
    if ($value) {
        // Value exists in cache
    } else {
        // Value does not exist in cache
    }​

    You can also provide a default value that will be returned if the key does not exist:

    $value = Cache::get('key', 'default');

     

  3. Checking Existence: To check if a key exists in the cache, you can use the has method.
    if (Cache::has('key')) {
        // Key exists in cache
    } else {
        // Key does not exist in cache
    }​

     

  4. Removing Values: To remove a value from the cache, you can use the forget method.
    Cache::forget('key'); // Remove a specific key
    
    Cache::flush(); // Remove all keys from the cache​

Cache Tags:

Laravel Cache provides a feature called "cache tags" that allows you to tag related cache items together. This feature is useful when you want to invalidate or retrieve a group of cache items at once.

  1. Tagging Cache Items: To tag cache items, you can use the tags method. You can pass a single tag or an array of tags to associate with the cache item.
    Cache::tags(['users', 'roles'])->put('key', 'value', 60);​

     

  2. Retrieving Tagged Items: To retrieve items based on their tags, you can use the tags method with the get method. It will return an instance of Illuminate\Cache\TaggedCache.
    $taggedCache = Cache::tags(['users', 'roles']);
    $value = $taggedCache->get('key');​

     

  3. Removing Tagged Items: To remove all items associated with a specific tag or tags, you can use the tags method with the forget method.
    Cache::tags(['users'])->forget('key'); // Remove 'key' associated with the 'users' tag
    Cache::tags(['users', 'roles'])->flush(); // Remove all items associated with both 'users' and 'roles' tags​

 

Cache Events:

Laravel Cache allows you to listen to events related to cache operations, such as storing, retrieving, and removing items. This feature can be helpful for logging or performing additional actions when cache events occur.

To listen to cache events, you can define listeners in the EventServiceProvider class:

/**
 * The event listener mappings for the application.
 *
 * @var array
 */
protected $listen = [
    'Illuminate\Cache\Events\CacheHit' => [
        'App\Listeners\LogCacheHit',
    ],

    'Illuminate\Cache\Events\CacheMissed' => [
        'App\Listeners\LogCacheMissed',
    ],

    'Illuminate\Cache\Events\KeyForgotten' => [
        'App\Listeners\LogKeyForgotten',
    ],

    'Illuminate\Cache\Events\KeyWritten' => [
        'App\Listeners\LogKeyWritten',
    ],
];

 

In this example, we have defined event listeners for CacheHit, CacheMissed, KeyForgotten, and KeyWritten events. You can create corresponding listener classes to handle these events and perform desired actions.

 

Laravel Cache provides a flexible and efficient way to manage caching in your web applications. By utilizing caching effectively, you can significantly improve the performance and responsiveness of your application. In this post, we explored the configuration, usage, cache tags, and cache events in Laravel Cache, giving you a solid foundation to leverage caching capabilities in your Laravel projects.


Tags - Laravel PHP

Abid Raza

Editor

Leave a comment