缓存

配置
- 驱动程序先决条件
缓存使用
缓存标签
原子锁
添加自定义缓存驱动程序
- 编写驱动程序
- 注册驱动程序
事件

配置

Laravel 为各种缓存后端提供了一个富有表现力的统一 API。缓存配置位于 config/cache.php。在此文件中，您可以指定希望在整个应用程序中默认使用哪个缓存驱动程序。Laravel 开箱即支持流行的缓存后端，如 Memcached 和 Redis。

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

驱动程序先决条件

数据库

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

php

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

NOTE

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

Memcached

使用 Memcached 驱动程序需要安装 Memcached PECL 包。您可以在 config/cache.php 配置文件中列出所有 Memcached 服务器：

php

'memcached' => [
    [
        'host' => '127.0.0.1',
        '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）。

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

缓存使用

获取缓存实例

Illuminate\Contracts\Cache\Factory 和 Illuminate\Contracts\Cache\Repository 契约提供对 Laravel 缓存服务的访问。Factory 契约提供对为您的应用程序定义的所有缓存驱动程序的访问。Repository 契约通常是您应用程序的默认缓存驱动程序的实现，由您的 cache 配置文件指定。

然而，您也可以使用 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');

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

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 方法的 Closure，其结果将被放入缓存中。

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

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

php

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

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

php

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

如果不存在则存储

add 方法仅在缓存存储中不存在该项目时才会将其添加到缓存中。如果项目实际添加到缓存中，该方法将返回 true。否则，该方法将返回 false：

php

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

永久存储项目

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

php

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

NOTE

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

从缓存中移除项目

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

php

Cache::forget('key');

您还可以通过提供零或负的 TTL 来移除项目：

php

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

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

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

php

Cache::flush();

NOTE

清除缓存不尊重缓存前缀，并将移除缓存中的所有条目。在清除由其他应用程序共享的缓存时，请仔细考虑这一点。

缓存助手

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

NOTE

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

缓存标签

NOTE

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

原子锁

NOTE

要使用此功能，您的应用程序必须使用 memcached、dynamodb、redis、database 或 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 方法还接受一个 Closure。在执行 Closure 后，Laravel 将自动释放锁：

php

Cache::lock('foo')->get(function () {
    // 锁定无限期并自动释放...
});

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

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

跨进程管理锁

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

php

// 在控制器中...
$podcast = Podcast::find($id);

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

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

// 在 ProcessPodcast 作业中...
Cache::restoreLock('foo', $this->owner)->release();

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

php

Cache::lock('foo')->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 连接实现这些方法中的每一个。要了解如何实现这些方法中的每一个，请查看框架源代码中的 Illuminate\Cache\MemcachedStore。一旦我们的实现完成，我们就可以完成自定义驱动程序注册。

php

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

NOTE

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

注册驱动程序

要在 Laravel 中注册自定义缓存驱动程序，我们将使用 Cache facade 上的 extend 方法。对 Cache::extend 的调用可以在新鲜 Laravel 应用程序附带的默认 App\Providers\AppServiceProvider 的 boot 方法中完成，或者您可以创建自己的服务提供者来容纳扩展 - 只需不要忘记在 config/app.php 提供者数组中注册提供者：

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()
    {
        //
    }

    /**
     * 启动任何应用程序服务。
     *
     * @return void
     */
    public function boot()
    {
        Cache::extend('mongo', function ($app) {
            return Cache::repository(new MongoStore);
        });
    }
}

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

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

事件

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

php

/**
 * 应用程序的事件监听器映射。
 *
 * @var array
 */
protected $listen = [
    'Illuminate\Cache\Events\CacheHit' => [
        'App\Listeners\LogCacheHit',
    ],

    'Illuminate\Cache\Events\CacheMissed' => [
        'App\Listeners\LogCacheMissed',
    ],

    'Illuminate\Cache\Events\KeyForgotten' => [
        'App\Listeners\LogKeyForgotten',
    ],

    'Illuminate\Cache\Events\KeyWritten' => [
        'App\Listeners\LogKeyWritten',
    ],
];

缓存 ​

配置 ​

驱动程序先决条件 ​

数据库 ​

Memcached ​

Redis ​

缓存使用 ​

获取缓存实例 ​

访问多个缓存存储 ​

从缓存中检索项目 ​

检查项目是否存在 ​

增加/减少值 ​

检索并存储 ​

检索并删除 ​

将项目存储在缓存中 ​

如果不存在则存储 ​

永久存储项目 ​

从缓存中移除项目 ​

缓存助手 ​

缓存标签 ​

存储带标签的缓存项目 ​

访问带标签的缓存项目 ​

移除带标签的缓存项目 ​

原子锁 ​

驱动程序先决条件 ​

数据库 ​

管理锁 ​

跨进程管理锁 ​

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

编写驱动程序 ​

注册驱动程序 ​

事件 ​

缓存

配置

驱动程序先决条件

数据库

Memcached

Redis

缓存使用

获取缓存实例

访问多个缓存存储

从缓存中检索项目

检查项目是否存在

增加/减少值

检索并存储

检索并删除

将项目存储在缓存中

如果不存在则存储

永久存储项目

从缓存中移除项目

缓存助手

缓存标签

存储带标签的缓存项目

访问带标签的缓存项目

移除带标签的缓存项目

原子锁

驱动程序先决条件

数据库

管理锁

跨进程管理锁

添加自定义缓存驱动程序

编写驱动程序

注册驱动程序

事件