缓存

引言

一些由您的应用程序执行的数据检索或处理任务可能是 CPU 密集型的，或者需要几秒钟才能完成。在这种情况下，通常会将检索到的数据缓存一段时间，以便在随后的请求中快速检索相同的数据。缓存的数据通常存储在非常快速的数据存储系统中，如 Memcached 或 Redis。

幸运的是，Laravel 提供了一个表达丰富、统一的 API，支持各种缓存后端，使您能够利用它们的快速数据检索功能，从而加速您的 web 应用程序。

配置

您的应用程序的缓存配置文件位于 config/cache.php。在此文件中，您可以指定要在应用程序中默认使用的缓存存储。Laravel 默认支持流行的缓存后端，如 Memcached、 Redis、 DynamoDB 和关系型数据库。此外，还提供了基于文件的缓存驱动程序，而 array 和 "null" 缓存驱动程序则为您的自动化测试提供了方便的缓存后端。

缓存配置文件还包含其它一些选项，您可以查看。在默认情况下，Laravel 配置为使用 database 缓存驱动程序，该驱动将序列化的缓存对象存储在应用程序的数据库中。

驱动程序前提条件

数据库

使用数据库缓存驱动时，您需要一个数据库表来存储缓存数据。通常，这个表会包含在 Laravel 的默认迁移 0001_01_01_000001_create_cache_table.php 中；但是，如果您的应用程序没有此迁移，您可以使用 make:cache-table Artisan 命令来创建它：

php artisan make:cache-table
php artisan migrate

Memcached

使用 Memcached 驱动时，您需要安装 Memcached PECL 扩展包。您可以在 config/cache.php 配置文件中列出所有的 Memcached 服务器。该文件已经包含了 memcached.servers 配置项，供您参考：

'memcached' => [
    // ...
    'servers' => [
        [
            'host' => env('MEMCACHED_HOST', '127.0.0.1'),
            'port' => env('MEMCACHED_PORT', 11211),
            'weight' => 100,
        ],
    ],
],

如果需要，您可以将 host 设置为 UNIX 套接字路径。如果这样做，port 应该设置为 0：

'memcached' => [
    // ...
    'servers' => [
        [
            'host' => '/var/run/memcached/memcached.sock',
            'port' => 0,
            'weight' => 100
        ],
    ],
],

Redis

在 Laravel 中使用 Redis 缓存之前，您需要安装 PhpRedis PHP 扩展（通过 PECL）或者通过 Composer 安装 predis/predis 包（版本 ~2.0）。 Laravel Sail 已经包含了此扩展。另外，像 Laravel Forge 和 Laravel Vapor 这样的官方部署平台默认已安装 PhpRedis 扩展。

有关配置 Redis 的更多信息，请查阅其【Laravel 文档页面】。

DynamoDB

在使用 DynamoDB 缓存驱动之前，您必须创建一个 DynamoDB 表来存储所有缓存数据。通常，此表应命名为 cache，但是您应该根据缓存配置文件中的 stores.dynamodb.table 配置值来命名表。表名也可以通过环境变量 DYNAMODB_CACHE_TABLE 设置。

此表还应该有一个与缓存配置文件中的 stores.dynamodb.attributes.key 配置项相对应的字符串分区键。默认情况下，分区键的名称应为 key。

通常，DynamoDB 不会主动删除过期的项。因此，您应该在表上【启用生存时间（TTL）】。在配置表的 TTL 设置时，您应该将 TTL 属性名称设置为 expires_at。

接下来，安装 AWS SDK，以便您的 Laravel 应用程序能够与 DynamoDB 通信：

composer require aws/aws-sdk-php

此外，您应确保为 DynamoDB 缓存存储配置选项提供值。通常，这些选项（如 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY）应该在应用程序的 .env 配置文件中定义：

'dynamodb' => [
    'driver' => 'dynamodb',
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
    'endpoint' => env('DYNAMODB_ENDPOINT'),
],

MongoDB

如果您使用 MongoDB，官方的 mongodb/laravel-mongodb 包提供了 MongoDB 缓存驱动，并且可以通过一个 MongoDB 数据库连接进行配置。MongoDB 支持 TTL 索引，这可以用来自动清理过期的缓存项。

有关 MongoDB 配置的更多信息，请参考 MongoDB 【缓存和锁定文档】。

缓存使用

获取缓存实例

要获取缓存存储实例，您可以使用 Cache facade，这是我们在本教程中将使用的方法。Cache facade 提供了方便的、简洁的访问 Laravel 缓存契约底层实现的方式：

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * 显示应用程序中所有用户的列表。
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            // ...
        ];
    }
}

访问多个缓存存储

通过 Cache facade，您可以使用 store 方法访问不同的缓存存储。传递给 store 方法的键应该对应于缓存配置文件中 stores 配置数组中列出的存储：

$value = Cache::store('file')->get('foo');

Cache::store('redis')->put('bar', 'baz', 600); // 10分钟

从缓存中检索项

Cache facade 的 get 方法用于从缓存中检索项。如果项不存在于缓存中，将返回 null。如果需要，您可以向 get 方法传递第二个参数，指定如果项不存在时返回的默认值：

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

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

您甚至可以传递一个闭包作为默认值。如果指定的项不存在于缓存中，将返回闭包的结果。使用闭包可以推迟从数据库或其它外部服务获取默认值：

$value = Cache::get('key', function () {
    return DB::table(/* ... */)->get();
});

确定项是否存在

has 方法用于判断项是否存在于缓存中。如果项存在但其值为 null，该方法也会返回 false：

if (Cache::has('key')) {
    // ...
}

增加 / 减少值

increment 和 decrement 方法可以用来调整缓存中整数项的值。这两个方法都接受一个可选的第二个参数，表示要增加或减少的数量：

// 如果项不存在，先初始化值...
Cache::add('key', 0, now()->addHours(4));

// 增加或减少值...
Cache::increment('key');
Cache::increment('key', $amount);
Cache::decrement('key');
Cache::decrement('key', $amount);

检索并存储

有时，您可能希望从缓存中检索一个项，但如果该项不存在，则存储一个默认值。例如，您可能希望从缓存中检索所有用户，或者如果不存在，则从数据库中检索它们并将其添加到缓存中。您可以使用 Cache::remember 方法做到这一点：

$value = Cache::remember('users', $seconds, function () {
    return DB::table('users')->get();
});

如果项不存在于缓存中，传递给 remember 方法的闭包将会执行，并且其结果将会被存储到缓存中。

您可以使用 rememberForever 方法来检索项或在项不存在时将其永久存储：

$value = Cache::rememberForever('users', function () {
    return DB::table('users')->get();
});

陈旧数据与重新验证

当使用 Cache::remember 方法时，如果缓存的值已过期，一些用户可能会遇到响应时间慢的问题。对于某些类型的数据，可以通过允许在后台重新计算缓存值的同时向用户提供部分过期的数据，来避免某些用户在缓存值被计算时遇到响应延迟。这种方法通常被称为“陈旧数据并重新验证”（stale-while-revalidate）模式，Cache::flexible 方法提供了这种模式的实现。

flexible 方法接受一个数组，指定缓存值被认为是 “新鲜” 的时长以及何时变为 “过期”。数组中的第一个值表示缓存被认为是新鲜的时间（秒），第二个值定义了它在被重新计算之前可以作为过期数据提供的时间。

如果请求发生在新鲜期内（第一个值之前），缓存会立即返回而无需重新计算。如果请求发生在过期期内（两个值之间），将提供过期值，并且在响应发送给用户后，会注册一个【延迟函数】来刷新缓存值。如果请求发生在第二个值之后，缓存被认为已过期，值会立即重新计算，这可能导致用户的响应时间变慢：

$value = Cache::flexible('users', [5, 10], function () {
    return DB::table('users')->get();
});

检索并删除

如果您需要从缓存中检索一个项并删除它，可以使用 pull 方法。与 get 方法一样，如果项不存在于缓存中，将返回 null：

$value = Cache::pull('key');

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

将项存储在缓存中

您可以使用 Cache facade 的 put 方法将项目存储到缓存中：

Cache::put('key', 'value', $seconds = 10);

如果没有传递存储时间（秒数），该项目将被无限期地存储：

Cache::put('key', 'value');

除了传递秒数作为整数，您还可以传递一个 DateTime 实例，表示缓存项目的过期时间：

Cache::put('key', 'value', now()->addMinutes(10));

如果不存在则存储

add 方法仅在缓存中不存在该项目时才会将其添加到缓存。如果项目确实被添加到缓存中，该方法将返回 true，否则返回 false。add 方法是一个原子操作：

Cache::add('key', 'value', $seconds);

永久存储项目

forever 方法可用于将项目永久存储到缓存中。由于这些项目不会过期，因此必须使用 forget 方法手动将其从缓存中删除：

Cache::forever('key', 'value');

如果您使用的是 Memcached 驱动，当缓存达到大小限制时，存储为 “永久” 的项目可能会被删除。

从缓存中移除项

您可以使用 forget 方法从缓存中删除项目：

Cache::forget('key');

您还可以通过提供零或负数的过期秒数来删除项目：

Cache::put('key', 'value', 0);

Cache::put('key', 'value', -5);

您可以使用 flush 方法清空整个缓存：

Cache::flush();

清空缓存时不会尊重您配置的缓存 “前缀”，并且会从缓存中删除所有条目。在清除与其它应用程序共享的缓存时，请谨慎操作。

缓存助手

除了使用 Cache facade，您还可以使用全局的 cache 函数通过缓存来获取和存储数据。当 cache 函数只传入一个字符串参数时，它将返回给定键的值：

$value = cache('key');

如果您提供一个包含键/值对的数组和过期时间，该函数将会在指定的持续时间内将值存储到缓存中：

cache(['key' => 'value'], $seconds);

cache(['key' => 'value'], now()->addMinutes(10));

当 cache 函数没有传入任何参数时，它将返回一个 Illuminate\Contracts\Cache\Factory 实例，允许您调用其它缓存方法：

cache()->remember('users', $seconds, function () {
    return DB::table('users')->get();
});

在测试全局 cache 函数的调用时，您可以像【测试 facade】一样使用 Cache::shouldReceive 方法。

原子锁

要使用此功能，您的应用程序必须将 memcached、redis、dynamodb、database、file 或 array 缓存驱动设置为默认缓存驱动。此外，所有服务器必须与相同的中央缓存服务器进行通信。

管理锁

原子锁允许在不担心竞争条件的情况下操作分布式锁。例如，【Laravel Forge】使用原子锁确保在服务器上一次只执行一个远程任务。您可以使用 Cache::lock 方法创建和管理锁：

use Illuminate\Support\Facades\Cache;

$lock = Cache::lock('foo', 10);

if ($lock->get()) {
    // 锁定成功，持续 10 秒...

    $lock->release();
}

get 方法还可以接受一个闭包。闭包执行完后，Laravel 会自动释放锁：

Cache::lock('foo', 10)->get(function () {
    // 锁定成功，持续 10 秒并自动释放...
});

如果您请求锁时锁不可用，您可以指示 Laravel 等待指定的时间。如果在指定的时间内无法获取锁，Laravel 会抛出一个 Illuminate\Contracts\Cache\LockTimeoutException 异常：

use Illuminate\Contracts\Cache\LockTimeoutException;

$lock = Cache::lock('foo', 10);

try {
    $lock->block(5);

    // 最多等待 5 秒后获取锁...
} catch (LockTimeoutException $e) {
    // 无法获取锁...
} finally {
    $lock->release();
}

上面的示例可以通过将闭包传递给 block 方法进行简化。当将闭包传递给该方法时，Laravel 会尝试在指定的秒数内获取锁，并在闭包执行完毕后自动释放锁：

Cache::lock('foo', 10)->block(5, function () {
    // 最多等待 5 秒后获取锁...
});

跨进程管理锁

有时，您可能希望在一个进程中获取锁，并在另一个进程中释放它。例如，您可能在 web 请求期间获取锁，并希望在该请求触发的队列任务结束时释放锁。在这种情况下，您应该将锁的作用域 "所有者令牌" 传递给队列任务，以便任务可以使用给定的令牌重新实例化锁。

在下面的示例中，如果成功获取锁，我们将调度一个队列任务。此外，我们通过锁的 owner 方法将锁的所有者令牌传递给队列任务：

$podcast = Podcast::find($id);

$lock = Cache::lock('processing', 120);

if ($lock->get()) {
    ProcessPodcast::dispatch($podcast, $lock->owner());
}

在应用程序的 ProcessPodcast 队列任务中，我们可以使用所有者令牌恢复并释放锁：

Cache::restoreLock('processing', $this->owner)->release();

如果您希望在不尊重当前所有者的情况下释放锁，您可以使用 forceRelease 方法：

Cache::lock('processing')->forceRelease();

添加自定义缓存驱动

编写驱动

要创建自定义缓存驱动程序，我们首先需要实现 Illuminate\Contracts\Cache\Store 接口。因此，一个 MongoDB 缓存实现可能看起来像这样：

<?php

namespace App\Extensions;

use Illuminate\Contracts\Cache\Store;

class MongoStore implements Store
{
    public function get($key) {}
    public function many(array $keys) {}
    public function put($key, $value, $seconds) {}
    public function putMany(array $values, $seconds) {}
    public function increment($key, $value = 1) {}
    public function decrement($key, $value = 1) {}
    public function forever($key, $value) {}
    public function forget($key) {}
    public function flush() {}
    public function getPrefix() {}
}

我们只需要使用 MongoDB 连接来实现这些方法。要了解如何实现每个方法，可以查看 Laravel 框架源代码中的 Illuminate\Cache\MemcachedStore 类。完成实现后，我们可以通过调用 Cache 门面的 extend 方法来完成自定义驱动程序的注册：

Cache::extend('mongo', function (Application $app) {
    return Cache::repository(new MongoStore);
});

如果你在想要将自定义缓存驱动程序代码放在哪里，你可以在 app 目录下创建一个 Extensions 命名空间。然而，请记住，Laravel 没有严格的应用结构，你可以根据个人喜好来组织应用程序。

注册驱动

要在 Laravel 中注册自定义缓存驱动程序，我们将使用 Cache 门面的 extend 方法。由于其它服务提供者可能会尝试在它们的 boot 方法中读取缓存值，因此我们将在 booting 回调中注册自定义驱动程序。通过使用 booting 回调，我们可以确保自定义驱动程序在所有服务提供者的 register 方法被调用之后，但在 boot 方法被调用之前注册。我们将在应用程序的 App\Providers\AppServiceProvider 类的 register 方法中注册 booting 回调：

<?php

namespace App\Providers;

use App\Extensions\MongoStore;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        $this->app->booting(function () {
            Cache::extend('mongo', function (Application $app) {
                return Cache::repository(new MongoStore);
            });
        });
    }

    /**
     * Bootstrap any application services.
     */
    public function boot(): void
    {
        // ...
    }
}

传递给 extend 方法的第一个参数是驱动程序的名称。这个名称将对应于你在 config/cache.php 配置文件中的驱动程序选项。第二个参数是一个闭包，闭包应该返回一个 Illuminate\Cache\Repository 实例。闭包会接收到一个 $app 实例，这是【服务容器】的实例。

注册完扩展后，更新应用程序的 CACHE_STORE 环境变量或 config/cache.php 配置文件中的默认选项为你自定义扩展的名称。

事件

要在每个缓存操作时执行代码，你可以监听缓存触发的各种【事件】：

事件名称：

Illuminate\Cache\Events\CacheHit
Illuminate\Cache\Events\CacheMissed
Illuminate\Cache\Events\KeyForgotten
Illuminate\Cache\Events\KeyWritten

为了提高性能，你可以通过在应用程序的 config/cache.php 配置文件中为特定的缓存存储设置 events 配置选项为 false，来禁用缓存事件：

'database' => [
    'driver' => 'database',
    // ...
    'events' => false,
],