Laravel 中文文档

主题

缓存 ​

简介 ​

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

值得庆幸的是，Laravel 为各种缓存后端提供了富有表现力的统一 API，让你可以利用它们极快的数据检索速度来加速你的 Web 应用程序。

配置 ​

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

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

驱动前提条件 ​

Database ​

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

shell
php artisan make:cache-table

php artisan migrate

Memcached ​

使用 Memcached 驱动需要安装 Memcached PECL 包。你可以在 config/cache.php 配置文件中列出所有 Memcached 服务器。此文件已包含 memcached.servers 条目以供你开始使用：

php
'memcached' => [
    // ...

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

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

php
'memcached' => [
    // ...

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

Redis ​

在 Laravel 中使用 Redis 缓存之前，你需要通过 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 通信：

shell
composer require aws/aws-sdk-php

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

php
'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
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * Show a list of all users of the application.
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            // ...
        ];
    }
}

访问多个缓存存储 ​

使用 Cache facade，你可以通过 store 方法访问各种缓存存储。传递给 store 方法的键应对应 cache 配置文件中 stores 配置数组中列出的存储之一：

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

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

从缓存中检索项 ​

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

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

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

你甚至可以传递一个闭包作为默认值。如果指定的项不存在于缓存中，将返回闭包的结果。传递闭包允许你延迟从数据库或其他外部服务检索默认值：

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

判断项是否存在 ​

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

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

递增 / 递减值 ​

increment 和 decrement 方法可用于调整缓存中整数项的值。这两个方法都接受可选的第二个参数，指示递增或递减项值的数量：

php
// Initialize the value if it does not exist...
Cache::add('key', 0, now()->plus(hours: 4));

// Increment or decrement the value...
Cache::increment('key');
Cache::increment('key', $amount);
Cache::decrement('key');
Cache::decrement('key', $amount);

检索并存储 ​

有时你可能希望从缓存中检索项，但如果请求的项不存在则存储默认值。例如，你可能希望从缓存中检索所有用户，或者如果不存在，则从数据库中检索它们并将它们添加到缓存中。你可以使用 Cache::remember 方法来实现：

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

如果项不存在于缓存中，传递给 remember 方法的闭包将被执行，其结果将被放入缓存中。

你可以使用 rememberForever 方法从缓存中检索项，如果不存在则永久存储它：

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

Stale While Revalidate ​

使用 Cache::remember 方法时，如果缓存值已过期，某些用户可能会遇到较慢的响应时间。对于某些类型的数据，允许在后台重新计算缓存值的同时提供部分过时的数据可能很有用，这可以防止某些用户在缓存值计算时遇到较慢的响应时间。这通常称为“stale-while-revalidate”模式，Cache::flexible 方法提供了此模式的实现。

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

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

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

检索并删除 ​

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

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

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

在缓存中存储项 ​

你可以使用 Cache facade 的 put 方法在缓存中存储项：

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

如果未向 put 方法传递存储时间，该项将无限期存储：

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

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

php
Cache::put('key', 'value', now()->plus(minutes: 10));

不存在时存储 ​

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

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

延长项生存时间 ​

touch 方法允许你延长现有缓存项的生存时间（TTL）。如果缓存项存在并且其过期时间成功延长，touch 方法将返回 true。如果项不存在于缓存中，方法将返回 false：

php
Cache::touch('key', 3600);

你可以提供 DateTimeInterface、DateInterval 或 Carbon 实例来指定确切的过期时间：

php
Cache::touch('key', now()->addHours(2));

永久存储项 ​

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

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

NOTE

如果你使用 Memcached 驱动，“永久”存储的项可能会在缓存达到其大小限制时被删除。

从缓存中删除项 ​

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

php
Cache::forget('key');

你也可以通过提供零或负数的过期秒数来删除项：

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

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

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

php
Cache::flush();

你可以使用 flushLocks 方法清除缓存中的所有原子锁：

php
Cache::flushLocks();

WARNING

清除缓存不会遵循你配置的缓存"前缀"，将删除缓存中的所有条目。在清除与其他应用程序共享的缓存时请仔细考虑。

缓存记忆化 ​

Laravel 的 memo 缓存驱动允许你在单个请求或任务执行期间将已解析的缓存值临时存储在内存中。这可以防止在同一执行过程中重复命中缓存，显著提高性能。

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

php
use Illuminate\Support\Facades\Cache;

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

memo 方法可选地接受一个缓存存储名称，该名称指定记忆化驱动将装饰的底层缓存存储：

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

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

对给定键的第一次 get 调用会从缓存存储中检索值，但在同一请求或任务中的后续调用将从内存中检索值：

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

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

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

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

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

Cache 辅助函数 ​

除了使用 Cache facade 外，你还可以使用全局 cache 函数通过缓存检索和存储数据。当使用单个字符串参数调用 cache 函数时，它将返回给定键的值：

php
$value = cache('key');

如果你向函数提供键/值对数组和过期时间，它将在指定的时间内将值存储在缓存中：

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

cache(['key' => 'value'], now()->plus(minutes: 10));

当不带任何参数调用 cache 函数时，它将返回 Illuminate\Contracts\Cache\Factory 实现的实例，允许你调用其他缓存方法：

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

NOTE

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

缓存标签 ​

WARNING

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

存储带标签的缓存项 ​

缓存标签允许你对缓存中的相关项进行标记，然后清除分配了给定标签的所有缓存值。你可以通过传入有序的标签名称数组来访问带标签的缓存。例如，让我们访问一个带标签的缓存并 put 一个值到缓存中：

php
use Illuminate\Support\Facades\Cache;

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

访问带标签的缓存项 ​

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

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

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

删除带标签的缓存项 ​

你可以清除分配了一个标签或标签列表的所有项。例如，以下代码将删除标记了 people、authors 或两者的所有缓存。因此，Anne 和 John 都将从缓存中被删除：

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

相比之下，以下代码只会删除标记了 authors 的缓存值，因此 Anne 会被删除，但 John 不会：

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

原子锁 ​

WARNING

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

管理锁 ​

原子锁允许操作分布式锁而无需担心竞争条件。例如，Laravel Cloud 使用原子锁来确保一次只有一个远程任务在服务器上执行。你可以使用 Cache::lock 方法创建和管理锁：

php
use Illuminate\Support\Facades\Cache;

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

if ($lock->get()) {
    // 获取锁 10 秒...

    $lock->release();
}

get 方法也接受一个闭包。闭包执行后，Laravel 将自动释放锁：

php
Cache::lock('foo', 10)->get(function () {
    // 获取锁 10 秒并自动释放...
});

如果在你请求锁时锁不可用，你可以指示 Laravel 等待指定的秒数。如果在指定的时间限制内无法获取锁，将抛出 Illuminate\Contracts\Cache\LockTimeoutException：

php
use Illuminate\Contracts\Cache\LockTimeoutException;

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

try {
    $lock->block(5);

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

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

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

跨进程管理锁 ​

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

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

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

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

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

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

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

如果你想释放锁而不尊重其当前所有者，可以使用 forceRelease 方法：

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

并发限制 ​

Laravel 的原子锁功能还提供了几种限制闭包并发执行的方式。当你想在整个基础设施中只允许一个运行实例时，可以使用 withoutOverlapping：

php
Cache::withoutOverlapping('foo', function () {
    // 等待最多 10 秒后获取锁...
});

默认情况下，锁会一直持有直到闭包执行完毕，并且该方法最多等待 10 秒来获取锁。你可以使用额外的参数自定义这些值：

php
Cache::withoutOverlapping('foo', function () {
    // 等待最多 5 秒后获取锁 120 秒...
}, lockFor: 120, waitFor: 5);

如果在指定的等待时间内无法获取锁，将抛出 Illuminate\Contracts\Cache\LockTimeoutException。

如果你需要受控的并行性，可以使用 funnel 方法设置最大并发执行数。funnel 方法适用于任何支持锁的缓存驱动：

php
Cache::funnel('foo')
    ->limit(3)
    ->releaseAfter(60)
    ->block(10)
    ->then(function () {
        // 获取并发锁...
    }, function () {
        // 无法获取并发锁...
    });

funnel 键标识要限制的资源。limit 方法定义最大并发执行数。releaseAfter 方法设置一个安全超时时间（秒），超时后已获取的槽位将自动释放。block 方法设置等待可用槽位的秒数。

如果你更喜欢通过异常来处理超时而不是提供失败闭包，可以省略第二个闭包。如果在指定的等待时间内无法获取锁，将抛出 Illuminate\Cache\Limiters\LimiterTimeoutException：

php
use Illuminate\Cache\Limiters\LimiterTimeoutException;

try {
    Cache::funnel('foo')
        ->limit(3)
        ->releaseAfter(60)
        ->block(10)
        ->then(function () {
            // 获取并发锁...
        });
} catch (LimiterTimeoutException $e) {
    // 无法获取并发锁...
}

如果你想为并发限制器使用特定的缓存存储，可以在所需的存储上调用 funnel 方法：

php
Cache::store('redis')->funnel('foo')
    ->limit(3)
    ->block(10)
    ->then(function () {
        // 使用 "redis" 存储获取并发锁...
    });

NOTE

funnel 方法要求缓存存储实现 Illuminate\Contracts\Cache\LockProvider 接口。如果你尝试在不支持锁的缓存存储上使用 funnel，将抛出 BadMethodCallException。

缓存故障转移 ​

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

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

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

配置好使用 failover 驱动的存储后，你需要在应用程序的 .env 文件中将故障转移存储设置为默认缓存存储，以使用故障转移功能：

ini
CACHE_STORE=failover

当缓存存储操作失败并激活故障转移时，Laravel 将分发 Illuminate\Cache\Events\CacheFailedOver 事件，允许你报告或记录缓存存储已失败。

添加自定义缓存驱动 ​

编写驱动 ​

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

php
<?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 方法来完成自定义驱动注册：

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

NOTE

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

注册驱动 ​

要向 Laravel 注册自定义缓存驱动，我们将使用 Cache facade 上的 extend 方法。由于其他 service provider 可能会在其 boot 方法中尝试读取缓存值，我们将在 booting 回调中注册自定义驱动。通过使用 booting 回调，我们可以确保在应用程序 service provider 的 boot 方法被调用之前、但在所有 service provider 的 register 方法被调用之后注册自定义驱动。我们将在应用程序的 App\Providers\AppServiceProvider 类的 register 方法中注册 booting 回调：

php
<?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\CacheFlushFailed
Illuminate\Cache\Events\CacheLocksFlushed
Illuminate\Cache\Events\CacheLocksFlushing
Illuminate\Cache\Events\CacheLocksFlushFailed
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 来禁用缓存事件：

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