缓存 – 乌鸦嘴文档中心

介绍

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

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

配置

您的应用程序的缓存配置文件位于 config/cache.php。在这个文件中，您可以指定在整个应用程序中默认使用的缓存存储。Laravel 开箱即支持流行的缓存后端，如 Memcached (opens in a new tab)、Redis (opens in a new tab)、DynamoDB (opens in a new tab) 以及关系型数据库。此外，还提供了一个基于文件的缓存驱动程序，而 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 包 (opens in a new tab)。您可以在 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 缓存之前，您需要通过 PECL 安装 PhpRedis PHP 扩展或通过 Composer 安装 predis/predis 包（~2.0）。Laravel Sail 已经包含此扩展。此外，官方的 Laravel 部署平台，如 Laravel Forge (opens in a new tab) 和 Laravel Vapor (opens in a new tab)，默认情况下已安装 PhpRedis 扩展。

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

DynamoDB

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

此表还应该有一个字符串分区键，其名称应与您的应用程序的 cache 配置文件中 stores.dynamodb.attributes.key 配置项的值相对应。默认情况下，分区键应命名为 key。

接下来，安装 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'),
],

缓存使用

获取缓存实例

要获取缓存存储实例，您可以使用 Cache 外观，这也是我们在整个文档中将要使用的。Cache 外观为 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 外观，您可以通过 store 方法访问各种缓存存储。传递给 store 方法的键应该与您的 cache 配置文件中的 stores 配置数组中列出的存储之一相对应：

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

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

从缓存中检索项目

Cache 外观的 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 外观上使用 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');

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

从缓存中删除项目

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

Cache::forget('key');

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

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

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

Cache::flush();

[!警告]
刷新缓存不会考虑您配置的缓存“前缀”，并将从缓存中删除所有条目。在清除与其他应用程序共享的缓存时，请仔细考虑这一点。

缓存助手

除了使用 Cache 外观外，您还可以使用全局 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 函数的调用时，您可以使用 Cache::shouldReceive 方法，就像您在测试外观时一样。

原子锁

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

管理锁

原子锁允许在操作分布式锁时无需担心竞争条件。例如，Laravel Forge (opens in a new tab) 使用原子锁来确保在服务器上同一时间只有一个远程任务在执行。您可以使用 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();

添加自定义缓存驱动程序

编写驱动程序

要创建我们的自定义缓存驱动程序，我们首先需要实现 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 框架源代码 (opens in a new tab) 中的 Illuminate\Cache\MemcachedStore。一旦我们的实现完成，我们可以通过调用 Cache 外观的 extend 方法来完成我们的自定义驱动程序注册：

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

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

注册驱动程序

要向 Laravel 注册自定义缓存驱动程序，我们将在 Cache 外观上使用 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\CacheHit`
`Illuminate\Cache\Events\CacheMissed`
`Illuminate\Cache\Events\KeyForgotten`
`Illuminate\Cache\Events\KeyWritten`

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

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

广播集合