缓存

• 介绍
• 配置
  • 驱动程序先决条件
• 缓存使用
  • 获取缓存实例
  • 从缓存中检索项目
  • 将项目存储在缓存中
  • 从缓存中删除项目
  • 缓存记忆化
  • 缓存助手
• 缓存标签
• 原子锁
  • 管理锁
  • 跨进程管理锁
• 缓存故障转移
• 添加自定义缓存驱动
  • 编写驱动
  • 注册驱动
• 事件

介绍

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

幸运的是，Laravel 提供了一个用于各种缓存后端的表达性、统一的 API，使您能够利用其快速的数据检索并加速您的 Web 应用程序。

配置

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

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

驱动程序先决条件

数据库

使用 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

在使用 Redis 缓存与 Laravel 之前，您需要通过 PECL 安装 PhpRedis PHP 扩展，或通过 Composer 安装 predis/predis 包（~2.0）。Laravel Sail 已经包含了此扩展。此外，官方的 Laravel 应用程序平台如 Laravel Cloud 和 Laravel Forge 默认安装了 PhpRedis 扩展。

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

DynamoDB

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

此表还应具有一个字符串分区键，其名称应与应用程序的 cache 配置文件中的 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 方法的键应对应于 cache 配置文件中 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 方法时，如果缓存值已过期，某些用户可能会遇到响应时间较慢的情况。对于某些类型的数据，允许在缓存值在后台重新计算时提供部分过期的数据可能很有用，从而防止某些用户在计算缓存值时遇到响应时间较慢的情况。这通常称为“过期时重新验证”模式，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);

如果未将存储时间传递给 put 方法，项目将被无限期存储：

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');

NOTE

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

从缓存中删除项目

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

Cache::forget('key');

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

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

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

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

Cache::flush();

WARNING

清除缓存不尊重您配置的缓存“前缀”，并将删除缓存中的所有条目。在清除由其他应用程序共享的缓存时，请仔细考虑这一点。

缓存记忆化

Laravel 的 memo 缓存驱动允许你在单次请求或作业执行期间，将已解析的缓存值临时存储在内存中。这样可以防止在同一次执行中重复读取缓存，从而显著提升性能。

要使用记忆化缓存，可调用 memo 方法：

use Illuminate\Support\Facades\Cache;

$value = Cache::memo()->get('key');

memo 方法还可以选择性地接受一个缓存存储名称，用于指定记忆化驱动所装饰的底层缓存存储：

// 使用默认的缓存存储...
$value = Cache::memo()->get('key');

// 使用 Redis 缓存存储...
$value = Cache::memo('redis')->get('key');

对于给定的 key，第一次调用 get 会从缓存存储中获取值，而同一次请求或作业中的后续调用则会直接从内存中获取该值：

// 命中缓存...
$value = Cache::memo()->get('key');

// 不命中缓存，返回记忆化的值...
$value = Cache::memo()->get('key');

当调用修改缓存值的方法（如 put、increment、remember 等）时，记忆化缓存会自动忘记已记忆的值，并将变更操作委托给底层的缓存存储：

Cache::memo()->put('name', 'Taylor'); // 写入到底层缓存...
Cache::memo()->get('name');           // 命中底层缓存...
Cache::memo()->get('name');           // 已记忆，不再命中缓存...

Cache::memo()->put('name', 'Tim');    // 忘记记忆的值，写入新值...
Cache::memo()->get('name');           // 再次命中底层缓存...

缓存助手

除了使用 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();
});

NOTE

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

缓存标签

WARNING

使用 file、dynamodb 或 database 缓存驱动时，不支持缓存标签。

存储带标签的缓存项

缓存标签允许你为缓存中的相关项添加标签，然后一次性清空已分配给某个标签的所有缓存值。你可以通过传入一个有序的标签名数组来访问带标签的缓存。例如，让我们访问一个带标签的缓存并将一个值 put 到缓存中：

use Illuminate\Support\Facades\Cache;

Cache::tags(['people', 'artists'])->put('John', $john, $seconds);
Cache::tags(['people', 'authors'])->put('Anne', $anne, $seconds);

访问带标签的缓存项

通过标签存储的项在访问时也必须提供用于存储该值的相同标签。要检索一个带标签的缓存项，请将相同的有序标签列表传给 tags 方法，然后使用要检索的键调用 get 方法：

$john = Cache::tags(['people', 'artists'])->get('John');

$anne = Cache::tags(['people', 'authors'])->get('Anne');

移除带标签的缓存项

你可以清空分配给某个标签或标签列表的所有项。例如，以下代码会移除所有带有 people、authors 或两者同时存在标签的缓存。因此，Anne 和 John 都会从缓存中被移除：

Cache::tags(['people', 'authors'])->flush();

相反，下面的代码只会移除带有 authors 标签的缓存值，所以会移除 Anne，但不会移除 John：

Cache::tags('authors')->flush();

原子锁

WARNING

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

管理锁

原子锁允许在不担心竞争条件的情况下操作分布式锁。例如，Laravel Cloud 使用原子锁来确保在服务器上一次仅执行一个远程任务。您可以使用 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 等待指定的秒数。如果在指定的时间限制内无法获取锁，将抛出 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();

缓存故障转移

failover 缓存驱动器提供了在与缓存交互时的自动故障转移功能。如果主缓存存储因任何原因发生故障，Laravel 将自动尝试使用列表中下一个已配置的存储。这对于在缓存可靠性至关重要的生产环境中确保高可用性特别有用。

要配置故障转移缓存存储，请指定 failover 驱动器并按顺序提供一个要尝试的存储名称数组。默认情况下，Laravel 在应用程序的 config/cache.php 配置文件中包含了一个故障转移配置示例：

'failover' => [
    'driver' => 'failover',
    'stores' => [
        'database',
        'array',
    ],
],

一旦您配置了一个使用 failover 驱动器的存储，您可能希望将故障转移存储设置为应用程序 .env 文件中的默认缓存存储：

CACHE_STORE=failover

当缓存存储操作失败并激活故障转移时，Laravel 会派发 Illuminate\Cache\Events\CacheFailedOver 事件，允许您报告或记录缓存存储已发生故障的情况。

添加自定义缓存驱动

编写驱动

要创建自定义缓存驱动，我们首先需要实现 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 facade 的 extend 方法完成自定义驱动注册：

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

NOTE

如果您想知道将自定义缓存驱动代码放在哪里，可以在 app 目录中创建一个 Extensions 命名空间。但是，请记住，Laravel 没有严格的应用程序结构，您可以根据自己的喜好组织应用程序。

注册驱动

要在 Laravel 中注册自定义缓存驱动，我们将使用 Cache facade 的 extend 方法。由于其他服务提供者可能会尝试在其 boot 方法中读取缓存值，我们将在 booting 回调中注册自定义驱动。通过使用 booting 回调，我们可以确保在调用应用程序的服务提供者的 boot 方法之前但在调用所有服务提供者的 register 方法之后注册自定义驱动。我们将在应用程序的 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
{
    /**
     * 注册任何应用程序服务。
     */
    public function register(): void
    {
        $this->app->booting(function () {
             Cache::extend('mongo', function (Application $app) {
                 return Cache::repository(new MongoStore);
             });
         });
    }

    /**
     * 启动任何应用程序服务。
     */
    public function boot(): void
    {
        // ...
    }
}

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

一旦注册了扩展，请将应用程序的 config/cache.php 配置文件中的 CACHE_STORE 环境变量或 default 选项更新为扩展的名称。

事件

要在每个缓存操作上执行代码，您可以监听缓存调度的各种事件：

事件名称
Illuminate\Cache\Events\CacheFlushed
Illuminate\Cache\Events\CacheFlushing
Illuminate\Cache\Events\CacheHit
Illuminate\Cache\Events\CacheMissed
Illuminate\Cache\Events\ForgettingKey
Illuminate\Cache\Events\KeyForgetFailed
Illuminate\Cache\Events\KeyForgotten
Illuminate\Cache\Events\KeyWriteFailed
Illuminate\Cache\Events\KeyWritten
Illuminate\Cache\Events\RetrievingKey
Illuminate\Cache\Events\RetrievingManyKeys
Illuminate\Cache\Events\WritingKey
Illuminate\Cache\Events\WritingManyKeys

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

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