缓存

简介

您应用程序执行的一些数据检索或处理任务可能是 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 命令来创建它：
```
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 缓存之前，您需要通过 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
{
    /**
     * Show a list of all users of the application.
     */
    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 Minutes

从缓存中检索项目

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 方法可用于调整缓存中整数项目的值。这两个方法都接受一个可选的第二个参数，指示要递增或递减项目值的数量：

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

// Increment or decrement the value...
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');

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

从缓存中删除项目

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

Cache::forget('key');

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

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

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

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

Cache::flush();

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

缓存记忆化

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

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

use Illuminate\Support\Facades\Cache;

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

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

// Using the default cache store...
$value = Cache::memo()->get('key');

// Using the Redis cache store...
$value = Cache::memo('redis')->get('key');

给定键的第一个 get 调用从您的缓存存储中检索值，但同一请求或作业中的后续调用将从内存中检索值：

// Hits the cache...
$value = Cache::memo()->get('key');

// Does not hit the cache, returns memoized value...
$value = Cache::memo()->get('key');

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

Cache::memo()->put('name', 'Taylor'); // Writes to underlying cache...
Cache::memo()->get('name');           // Hits underlying cache...
Cache::memo()->get('name');           // Memoized, does not hit cache...

Cache::memo()->put('name', 'Tim');    // Forgets memoized value, writes new value...
Cache::memo()->get('name');           // Hits underlying cache again...

缓存辅助函数

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

原子锁

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

管理锁

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

use Illuminate\Support\Facades\Cache;

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

if ($lock->get()) {
    // Lock acquired for 10 seconds...

    $lock->release();
}

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

Cache::lock('foo', 10)->get(function () {
    // Lock acquired for 10 seconds and automatically released...
});

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

use Illuminate\Contracts\Cache\LockTimeoutException;

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

try {
    $lock->block(5);

    // Lock acquired after waiting a maximum of 5 seconds...
} catch (LockTimeoutException $e) {
    // Unable to acquire lock...
} finally {
    $lock->release();
}

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

Cache::lock('foo', 10)->block(5, function () {
    // Lock acquired for 10 seconds after waiting a maximum of 5 seconds...
});

跨进程管理锁

有时，您可能希望在一个进程中获取锁，并在另一个进程中释放它。例如，您可能在 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 facade 的 extend 方法来完成我们的自定义驱动程序注册：

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

如果您想知道将自定义缓存驱动程序代码放在哪里，您可以在 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
{
    /**
     * 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 配置文件中的 driver 选项相对应。第二个参数是一个闭包，它应该返回一个 Illuminate\Cache\Repository 实例。该闭包将被传递一个 $app 实例，它是服务容器的一个实例。

注册扩展后，将 CACHE_STORE 环境变量或应用程序的 config/cache.php 配置文件中的 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,
],

广播

集合