Laravel 9.x 中文文档

简体中文

English

简体中文

English

主题

缓存 ​

介绍 ​

您的应用程序执行的一些数据检索或处理任务可能会占用大量CPU或需要几秒钟才能完成。在这种情况下，通常会将检索到的数据缓存一段时间，以便在后续请求相同数据时可以快速检索。缓存的数据通常存储在非常快速的数据存储中，例如Memcached或Redis。

幸运的是，Laravel提供了一个表达性强、统一的API，用于各种缓存后端，使您能够利用其快速的数据检索并加速您的Web应用程序。

配置 ​

您的应用程序的缓存配置文件位于config/cache.php。在此文件中，您可以指定希望在整个应用程序中默认使用哪个缓存驱动程序。Laravel支持流行的缓存后端，如Memcached、Redis、DynamoDB和关系数据库。此外，还提供了基于文件的缓存驱动程序，而array和"null"缓存驱动程序为您的自动化测试提供了方便的缓存后端。

缓存配置文件还包含各种其他选项，这些选项在文件中有记录，因此请务必阅读这些选项。默认情况下，Laravel配置为使用file缓存驱动程序，该驱动程序将序列化的缓存对象存储在服务器的文件系统上。对于较大的应用程序，建议您使用更强大的驱动程序，如Memcached或Redis。您甚至可以为同一驱动程序配置多个缓存配置。

驱动程序先决条件 ​

数据库 ​

使用database缓存驱动程序时，您需要设置一个表来包含缓存项目。您将在下面找到一个表的Schema声明示例：

php
Schema::create('cache', function ($table) {
    $table->string('key')->unique();
    $table->text('value');
    $table->integer('expiration');
});
lightbulb

您还可以使用php artisan cache:table Artisan命令生成具有正确架构的迁移。

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' => [
    [
        'host' => '/var/run/memcached/memcached.sock',
        'port' => 0,
        'weight' => 100
    ],
],

Redis ​

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

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

DynamoDB ​

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

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

缓存使用 ​

获取缓存实例 ​

要获取缓存存储实例，您可以使用Cache facade，这也是我们将在整个文档中使用的。Cache facade提供了对Laravel缓存合同的底层实现的便捷、简洁的访问：

php
<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * 显示应用程序的所有用户列表。
     *
     * @return Response
     */
    public function index()
    {
        $value = Cache::get('key');

        //
    }
}

访问多个缓存存储 ​

使用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::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');

在缓存中存储项目 ​

您可以使用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

使用file、dynamodb或database缓存驱动程序时不支持缓存标签。此外，当使用多个标签存储"永久"的缓存时，性能在诸如memcached之类的驱动程序上会更好，因为它会自动清除过时的记录。

存储带标签的缓存项目 ​

缓存标签允许您在缓存中标记相关项目，然后刷新所有已分配给给定标签的缓存值。您可以通过传入有序的标签名称数组来访问带标签的缓存。例如，让我们访问一个带标签的缓存并将一个值put到缓存中：

php
Cache::tags(['people', 'artists'])->put('John', $john, $seconds);

Cache::tags(['people', 'authors'])->put('Anne', $anne, $seconds);

访问带标签的缓存项目 ​

通过标签存储的项目不能在不提供用于存储该值的标签的情况下访问。要检索带标签的缓存项目，请将相同的有序标签列表传递给tags方法，然后使用您希望检索的键调用get方法：

php
$john = Cache::tags(['people', 'artists'])->get('John');

$anne = Cache::tags(['people', 'authors'])->get('Anne');

移除带标签的缓存项目 ​

您可以刷新分配给标签或标签列表的所有项目。例如，此语句将移除所有带有people、authors或两者标签的缓存。因此，Anne和John都将从缓存中移除：

php
Cache::tags(['people', 'authors'])->flush();

相反，此语句将仅移除带有authors标签的缓存值，因此Anne将被移除，但John不会：

php
Cache::tags('authors')->flush();

原子锁 ​

exclamation

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

驱动程序先决条件 ​

数据库 ​

使用database缓存驱动程序时，您需要设置一个表来包含应用程序的缓存锁。您将在下面找到一个表的Schema声明示例：

php
Schema::create('cache_locks', function ($table) {
    $table->string('key')->primary();
    $table->string('owner');
    $table->integer('expiration');
});

管理锁 ​

原子锁允许在不担心竞争条件的情况下操作分布式锁。例如，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 {
    optional($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 ($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\Support\Facades\Cache;
use Illuminate\Support\ServiceProvider;

class CacheServiceProvider extends ServiceProvider
{
    /**
     * 注册任何应用程序服务。
     *
     * @return void
     */
    public function register()
    {
        $this->app->booting(function () {
             Cache::extend('mongo', function ($app) {
                 return Cache::repository(new MongoStore);
             });
         });
    }

    /**
     * 启动任何应用程序服务。
     *
     * @return void
     */
    public function boot()
    {
        //
    }
}

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

一旦您的扩展注册完毕，更新config/cache.php配置文件的driver选项为您的扩展的名称。

事件 ​

要在每个缓存操作上执行代码，您可以监听缓存触发的事件。通常，您应将这些事件监听器放在应用程序的App\Providers\EventServiceProvider类中：

php
use App\Listeners\LogCacheHit;
use App\Listeners\LogCacheMissed;
use App\Listeners\LogKeyForgotten;
use App\Listeners\LogKeyWritten;
use Illuminate\Cache\Events\CacheHit;
use Illuminate\Cache\Events\CacheMissed;
use Illuminate\Cache\Events\KeyForgotten;
use Illuminate\Cache\Events\KeyWritten;

/**
 * 应用程序的事件监听器映射。
 *
 * @var array
 */
protected $listen = [
    CacheHit::class => [
        LogCacheHit::class,
    ],

    CacheMissed::class => [
        LogCacheMissed::class,
    ],

    KeyForgotten::class => [
        LogKeyForgotten::class,
    ],

    KeyWritten::class => [
        LogKeyWritten::class,
    ],
];

版权所有 © 2024-2025 laravel.wiki