缓存

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

简介

应用程序执行的某些数据检索或处理任务可能需要大量 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 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 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 通信。

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 外观模式，这将是我们在本文档中使用的。Cache 外观模式提供对 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 外观模式，你可以通过 store 方法访问各种缓存存储。传递给 store 方法的键应对应于 cache 配置文件中 stores 配置数组中列出的存储之一。

$value = Cache::store('file')->get('foo');
 
Cache::store('redis')->put('bar', 'baz', 600); // 10 Minutes

从缓存中检索项目

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

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

从缓存中删除项目

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

Cache::forget('key');

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

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

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

Cache::flush();

缓存助手

除了使用 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();
});

原子锁

管理锁

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

注册驱动程序

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

事件

要在每次缓存操作时执行代码，您可以监听缓存分发的各种事件。

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

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