后盾人

Appearance

缓存 ​

介绍 ​

您的应用程序执行的某些数据检索或处理任务可能会占用大量 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 ​

在将 Redis 缓存与 Laravel 一起使用之前，您需要通过 PECL 安装 PhpRedis PHP 扩展或通过 Composer 安装 predis/predis 包 （~2.0）。Laravel Sail 已经包含此扩展。此外，Laravel Forge 和 Laravel Vapor 等官方 Laravel 部署平台默认安装了 PhpRedis 扩展。

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

DynamoDB ​

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

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

接下来，安装 AWS 开发工具包，以便您的 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'),
],

缓存使用情况 ​

获取缓存实例 ​

要获取缓存存储实例，您可以使用 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 方法的 key 应该对应于cache配置文件中 stores 配置数组中列出的 store 之一:

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');

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

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();
    });

检索和删除 ​

如果您需要从缓存中检索项目，然后删除该项目，则可以使用 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');

NOTE

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

从缓存中删除项目 ​

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

php
    Cache::forget('key');

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

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

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

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

php
    Cache::flush();

WARNING

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

缓存帮助程序 ​

除了使用 Cache Facade外，您还可以使用全局缓存功能通过缓存来检索和存储数据。当使用单个字符串参数调用 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();
    });

NOTE

在测试对全局缓存函数的调用时，你可以使用 Cache::shouldReceive 方法，就像你正在测试Facade一样。

原子锁 ​

WARNING

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

管理锁 ​

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

php
    use Illuminate\Support\Facades\Cache;

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

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

        $lock->release();
    }

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

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

如果在您请求锁时锁不可用，您可以指示 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 () {
        // Lock acquired after waiting a maximum of 5 seconds...
    });

跨进程管理锁 ​

有时，您可能希望在一个进程中获取锁，并在另一个进程中释放它。例如，您可以在 Web 请求期间获取一个锁，并希望在该请求触发的排队作业结束时释放该锁。在这种情况下，您应该将锁的范围“所有者令牌”传递给排队的作业，以便作业可以使用给定的令牌重新实例化锁。

在下面的示例中，如果成功获取了锁，我们将分派排队的作业。此外，我们将通过锁的 owner 方法将锁的 owner token 传递给排队的作业:

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

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

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

在我们应用程序的 ProcessPodcast 作业中，我们可以使用 owner 令牌恢复和释放锁:

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

如果您想在不尊重其当前所有者的情况下释放锁，您可以使用 forceRelease 方法:

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

添加自定义缓存驱动程序 ​

编写驱动程序 ​

要创建自定义缓存驱动程序，我们首先需要实现 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 连接实现这些方法中的每一个。有关如何实现这些方法的示例，请查看 Illuminate\Cache\MemcachedStore Laravel 框架源代码中的。一旦我们的实现完成，我们就可以通过调用 Cache Facade 的 extend 方法来完成我们的自定义驱动程序注册:

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

NOTE

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

注册驱动程序 ​

要在 Laravel 中注册自定义缓存驱动程序，我们将在 Cache Facade 上使用 extend 方法。由于其他服务提供商可能会尝试在其 boot 方法中读取缓存的值，因此我们将在 booting 回调中注册我们的自定义驱动程序。通过使用 booting 回调，我们可以确保在应用程序的服务提供商上调用 boot 方法之前，但在所有服务提供商上调用 register 方法之后注册自定义驱动程序。我们将在应用程序 App\Providers\AppServiceProvider 类的 register 方法中注册我们的启动回调:

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 选项更新为扩展的名称。

事件 ​

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

Event Name
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,
],

后盾人版权所有 © 2018-2025 创作不易请尊重他人劳动成果，未经授权禁止转载！