缓存#

• 简介
• 配置
  • 驱动器先决条件
• 缓存使用
  • 获取缓存实例
  • 从缓存中检索项目
  • 在缓存中存储项目
  • 从缓存中移除项目
  • 缓存辅助函数
• 原子锁
  • 管理锁
  • 跨进程管理锁
• 添加自定义缓存驱动器
  • 编写驱动器
  • 注册驱动器
• 事件

简介#

您的应用程序执行的一些数据检索或处理任务可能非常消耗 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 migrateCopy

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,
        ],
    ],
],Copy

如有需要，您可以将 host 选项设置为 UNIX 套接字路径。就像，port 选项应设为 0：

'memcached' => [
    // ...

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

Redis#

在 Laravel 中使用 Redis 缓存之前，您需要通过 PECL 安装 PhpRedis PHP 扩展，或者通过 Composer 安装 predis/predis 包（~2.0 版本）。Laravel Sail 已包含此扩展。此外，诸如 Laravel Forge 和 Laravel Vapor 这样的官方 Laravel 部署平台，默认已安装 PhpRedis 扩展。

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

DynamoDB#

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

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

接下来，安装 AWS SDK，以便你的 Laravel 应用程序能够与 DynamoDB 通信：

composer require aws/aws-sdk-phpCopy

此外，你应确保为 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'),
],Copy

缓存使用#

获取缓存实例#

要获取缓存存储实例，你可以使用 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 [
            // ...
        ];
    }
}Copy

访问多个缓存存储#

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

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

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

从缓存中检索项目#

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

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

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

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

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

检查项目是否存在#

has 方法可用于确定缓存中是否存在某个项目。如果该项目存在但其值为 null，此方法也将返回 false：

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

递增 / 递减值#

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

// 如果值不存在，则初始化该值..
Cache::add('key', 0, now()->addHours(4));

// 增加或减少值...
Cache::increment('key');
Cache::increment('key', $amount);
Cache::decrement('key');
Cache::decrement('key', $amount);Copy

检索和存储#

有时你可能希望从缓存中检索一个项目，但如果请求的项目不存在，也会存储一个默认值。例如，你可能希望从缓存中检索所有用户，如果他们不存在，则从数据库中检索他们并将其添加到缓存中。你可以使用 Cache::remember 方法来做这件事：

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

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

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

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

检索和删除#

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

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

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

存储项目到缓存中#

你可以使用 Cache facade 上的 put 方法将项目存储到缓存中：

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

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

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

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

Cache::put('key', 'value', now()->addMinutes(10));Copy

如果不存在则存储#

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

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

永久存储项目#

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

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

注意
如果你使用的是 Memcached 驱动程序，当缓存达到大小限制时，存储的「永久」项目可能会被移除。

从缓存中移除项目#

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

Cache::forget('key');Copy

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

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

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

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

Cache::flush();Copy

注意
清除缓存不会考虑你配置的缓存「前缀」，并且会从缓存中删除所有条目。当清除一个被其他应用程序共享的缓存时，请谨慎考虑。

缓存助手函数#

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

$value = cache('key');Copy

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

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

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

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

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

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

原子锁#

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

管理锁#

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

use Illuminate\Support\Facades\Cache;

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

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

    $lock->release();
}Copy

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

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

如果你请求时锁不可用，你可以指示 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();
}Copy

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

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

跨进程管理锁#

有时，你可能希望在一个进程中获得锁，并在另一个进程中释放它。例如，你可能在一个 Web 请求中获得锁，并希望在由该请求触发的队列任务结束时释放锁。在这种情况下，你应该将锁的作用域「owner token」传递给队列任务，以便任务可以使用给定的令牌重新实例化锁。

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

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

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

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

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

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

如果你希望释放锁而不考虑其当前所有者，你可以使用 forceRelease 方法：

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

添加自定义缓存驱动#

编写驱动#

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

我们只需要使用 MongoDB 连接实现每个方法。要查看如何实现每个方法的示例，可以看一下 Laravel 框架源码 中的 Illuminate\Cache\MemcachedStore。完成实现后，我们可以通过调用 Cache facade 的 extend 方法完成我们的自定义驱动注册：

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

技巧
如果你想知道在哪里放置你的自定义缓存驱动代码，你可以在 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
    {
        // ...
    }
}Copy

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

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

事件#

你可以监听由缓存分发的各种事件，以便在每个缓存操作上执行代码：

为提升性能，你可以在应用程序的 config/cache.php 配置文件中，为特定缓存存储设置 events 配置项为 false ，从而禁用缓存事件：

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

本译文仅用于学习和交流目的，转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议，如果我们的工作有侵犯到您的权益，请及时联系我们。

原文地址：https://learnku.com/docs/laravel/11.x/ca...

译文地址：https://learnku.com/docs/laravel/11.x/ca...