Laravel 11.x 中文文档

简体中文

English

简体中文

English

主题

缓存 ​

介绍 ​

您应用程序执行的一些数据检索或处理任务可能会消耗大量 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 命令来创建它：

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 Forge 和 Laravel Vapor，默认安装了 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
{
    /**
     * 显示应用程序中所有用户的列表。
     */
    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分钟

从缓存中检索项目 ​

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
// 如果不存在则初始化值...
Cache::add('key', 0, now()->addHours(4));

// 增加或减少值...
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();
});

过期时重新验证 ​

在使用 Cache::remember 方法时，如果缓存值已过期，某些用户可能会体验到缓慢的响应时间。对于某些类型的数据，允许部分过期的数据在后台重新计算缓存值时被服务是有用的，这样可以防止某些用户在计算缓存值时体验到缓慢的响应时间。这通常被称为“过期时重新验证”模式，Cache::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()->addMinutes(10));

如果不存在则存储 ​

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

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

永久存储项目 ​

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

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

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

从缓存中移除项目 ​

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

php
Cache::forget('key');

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

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

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

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

php
Cache::flush();
exclamation

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

缓存助手 ​

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

php
$value = cache('key');

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

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

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

当 cache 函数在没有任何参数的情况下被调用时，它返回 Illuminate\Contracts\Cache\Factory 实现的实例，允许您调用其他缓存方法：

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

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

原子锁 ​

exclamation

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

管理锁 ​

原子锁允许在不担心竞争条件的情况下操作分布式锁。例如，Laravel Forge 使用原子锁确保在服务器上一次只执行一个远程任务。您可以使用 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 秒后获得...
});

跨进程管理锁 ​

有时，您可能希望在一个进程中获得锁并在另一个进程中释放它。例如，您可能在 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();

添加自定义缓存驱动 ​

编写驱动程序 ​

要创建我们的自定义缓存驱动，我们首先需要实现 Illuminate\Contracts\Cache\Store 契约。因此，一个 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);
});
lightbulb

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

注册驱动程序 ​

要将自定义缓存驱动注册到 Laravel，我们将使用 Cache facade 上的 extend 方法。由于其他服务提供者可能会在其 boot 方法中尝试读取缓存值，因此我们将在 booting 回调中注册自定义驱动。通过使用 booting 回调，我们可以确保在调用应用程序的服务提供者的 boot 方法之前注册自定义驱动，但在所有服务提供者的 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 实例，该实例是 服务容器 的实例。

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

事件 ​

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

事件名称
Illuminate\Cache\Events\CacheHit
Illuminate\Cache\Events\CacheMissed
Illuminate\Cache\Events\KeyForgotten
Illuminate\Cache\Events\KeyWritten

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

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

版权所有 © 2024-2025 laravel.wiki