缓存

简介
配置
- 驱动先决条件
缓存使用
原子锁
- 管理锁
- 跨进程管理锁
添加自定义缓存驱动
- 编写驱动程序
- 注册驱动程序
事件

简介

您的应用程序执行的某些数据检索或处理任务可能是 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 命令来创建它

1php artisan make:cache-table
2 
3php artisan migrate

php artisan make:cache-table

php artisan migrate

Memcached

使用 Memcached 驱动程序需要安装 Memcached PECL 包。您可以在 config/cache.php 配置文件中列出所有 Memcached 服务器。此文件已包含 memcached.servers 条目以帮助您入门

 1'memcached' => [
 2    // ...
 3 
 4    'servers' => [
 5        [
 6            'host' => env('MEMCACHED_HOST', '127.0.0.1'),
 7            'port' => env('MEMCACHED_PORT', 11211),
 8            'weight' => 100,
 9        ],
10    ],
11],

'memcached' => [
    // ...

    'servers' => [
        [
            'host' => env('MEMCACHED_HOST', '127.0.0.1'),
            'port' => env('MEMCACHED_PORT', 11211),
            'weight' => 100,
        ],
    ],
],

如果需要，您可以将 host 选项设置为 UNIX 套接字路径。如果这样做，则应将 port 选项设置为 0

 1'memcached' => [
 2    // ...
 3 
 4    'servers' => [
 5        [
 6            'host' => '/var/run/memcached/memcached.sock',
 7            'port' => 0,
 8            'weight' => 100
 9        ],
10    ],
11],

'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 通信

1composer require aws/aws-sdk-php

composer require aws/aws-sdk-php

此外，您应确保为 DynamoDB 缓存存储配置选项提供值。通常，这些选项（例如 AWS_ACCESS_KEY_ID 和 AWS_SECRET_ACCESS_KEY）应在应用程序的 .env 配置文件中定义

1'dynamodb' => [
2    'driver' => 'dynamodb',
3    'key' => env('AWS_ACCESS_KEY_ID'),
4    'secret' => env('AWS_SECRET_ACCESS_KEY'),
5    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
6    'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
7    'endpoint' => env('DYNAMODB_ENDPOINT'),
8],

'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 缓存契约的底层实现的便捷、简洁的访问

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Support\Facades\Cache;
 6 
 7class UserController extends Controller
 8{
 9    /**
10     * Show a list of all users of the application.
11     */
12    public function index(): array
13    {
14        $value = Cache::get('key');
15 
16        return [
17            // ...
18        ];
19    }
20}

<?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 配置数组中列出的存储之一相对应

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

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

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

从缓存中检索项目

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

1$value = Cache::get('key');
2 
3$value = Cache::get('key', 'default');

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

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

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

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

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

确定项目是否存在

可以使用 has 方法来确定缓存中是否存在项目。如果项目存在但其值为 null，此方法也将返回 false

1if (Cache::has('key')) {
2    // ...
3}

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

递增 / 递减值

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

1// Initialize the value if it does not exist...
2Cache::add('key', 0, now()->addHours(4));
3 
4// Increment or decrement the value...
5Cache::increment('key');
6Cache::increment('key', $amount);
7Cache::decrement('key');
8Cache::decrement('key', $amount);

// 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 方法执行此操作

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

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

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

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

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

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

过时数据后台刷新

使用 Cache::remember 方法时，如果缓存的值已过期，某些用户可能会遇到响应时间缓慢的情况。对于某些类型的数据，允许在后台重新计算缓存值时提供部分过时的数据可能很有用，从而防止某些用户在计算缓存值时遇到响应时间缓慢的情况。这通常被称为“过时数据后台刷新”模式，Cache::flexible 方法提供了此模式的实现。

flexible 方法接受一个数组，该数组指定缓存值被视为“新鲜”的时间以及何时变为“过时”。数组中的第一个值表示缓存被视为新鲜的秒数，而第二个值定义了它可以作为过时数据提供服务多长时间，之后才需要重新计算。

如果在新鲜期内（在第一个值之前）发出请求，则会立即返回缓存，而无需重新计算。如果在过时期间（在两个值之间）发出请求，则会将过时值提供给用户，并且会注册一个延迟函数，以便在响应发送给用户后刷新缓存值。如果在第二个值之后发出请求，则缓存被视为已过期，并且会立即重新计算该值，这可能会导致用户的响应速度变慢

1$value = Cache::flexible('users', [5, 10], function () {
2    return DB::table('users')->get();
3});

$value = Cache::flexible('users', [5, 10], function () {
    return DB::table('users')->get();
});

检索和删除

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

1$value = Cache::pull('key');
2 
3$value = Cache::pull('key', 'default');

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

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

在缓存中存储项目

您可以在 Cache 外观模式上使用 put 方法将项目存储在缓存中

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

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

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

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

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

除了将秒数作为整数传递之外，您还可以传递一个 DateTime 实例，表示缓存项目的期望过期时间

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

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

如果不存在则存储

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

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

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

永久存储项目

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

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

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

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

从缓存中移除项目

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

1Cache::forget('key');

Cache::forget('key');

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

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

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

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

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

1Cache::flush();

Cache::flush();

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

缓存助手

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

1$value = cache('key');

$value = cache('key');

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

1cache(['key' => 'value'], $seconds);
2 
3cache(['key' => 'value'], now()->addMinutes(10));

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

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

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

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

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

在测试对全局 cache 函数的调用时，您可以像测试外观模式一样使用 Cache::shouldReceive 方法。

原子锁

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

管理锁

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

1use Illuminate\Support\Facades\Cache;
2 
3$lock = Cache::lock('foo', 10);
4 
5if ($lock->get()) {
6    // Lock acquired for 10 seconds...
7 
8    $lock->release();
9}

use Illuminate\Support\Facades\Cache;

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

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

    $lock->release();
}

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

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

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

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

 1use Illuminate\Contracts\Cache\LockTimeoutException;
 2 
 3$lock = Cache::lock('foo', 10);
 4 
 5try {
 6    $lock->block(5);
 7 
 8    // Lock acquired after waiting a maximum of 5 seconds...
 9} catch (LockTimeoutException $e) {
10    // Unable to acquire lock...
11} finally {
12    $lock->release();
13}

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 将尝试在指定的秒数内获取锁，并在闭包执行后自动释放锁

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

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

跨进程管理锁

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

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

1$podcast = Podcast::find($id);
2 
3$lock = Cache::lock('processing', 120);
4 
5if ($lock->get()) {
6    ProcessPodcast::dispatch($podcast, $lock->owner());
7}

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

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

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

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

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

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

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

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

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

添加自定义缓存驱动

编写驱动程序

要创建自定义缓存驱动程序，我们首先需要实现 Illuminate\Contracts\Cache\Store 契约。因此，MongoDB 缓存实现可能如下所示

 1<?php
 2 
 3namespace App\Extensions;
 4 
 5use Illuminate\Contracts\Cache\Store;
 6 
 7class MongoStore implements Store
 8{
 9    public function get($key) {}
10    public function many(array $keys) {}
11    public function put($key, $value, $seconds) {}
12    public function putMany(array $values, $seconds) {}
13    public function increment($key, $value = 1) {}
14    public function decrement($key, $value = 1) {}
15    public function forever($key, $value) {}
16    public function forget($key) {}
17    public function flush() {}
18    public function getPrefix() {}
19}

<?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 外观模式的 extend 方法来完成自定义驱动程序注册

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

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

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

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

 1<?php
 2 
 3namespace App\Providers;
 4 
 5use App\Extensions\MongoStore;
 6use Illuminate\Contracts\Foundation\Application;
 7use Illuminate\Support\Facades\Cache;
 8use Illuminate\Support\ServiceProvider;
 9 
10class AppServiceProvider extends ServiceProvider
11{
12    /**
13     * Register any application services.
14     */
15    public function register(): void
16    {
17        $this->app->booting(function () {
18             Cache::extend('mongo', function (Application $app) {
19                 return Cache::repository(new MongoStore);
20             });
21         });
22    }
23 
24    /**
25     * Bootstrap any application services.
26     */
27    public function boot(): void
28    {
29        // ...
30    }
31}

<?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\CacheHit`
`Illuminate\Cache\Events\CacheMissed`
`Illuminate\Cache\Events\KeyForgotten`
`Illuminate\Cache\Events\KeyWritten`

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

1'database' => [
2    'driver' => 'database',
3    // ...
4    'events' => false,
5],

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

序言

快速入门

架构概念

基础知识

深入

安全

数据库

Eloquent ORM

测试

扩展包

缓存

产品

扩展包

资源