缓存

配置
缓存使用
添加自定义缓存驱动
缓存标签
- 存储带标签的缓存项目
- 访问带标签的缓存项目
缓存事件

配置

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

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

缓存先决条件

数据库

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

php

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

Memcached

使用 Memcached 缓存需要安装 Memcached PECL 包。

默认的配置使用基于 TCP/IP 的 Memcached::addServer：

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 之前，您需要通过 Composer 安装 predis/predis 包 (~1.0)。

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

缓存使用

获取缓存实例

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

然而，您也可以使用 Cache facade，我们将在整个文档中使用它。Cache facade 提供对 Laravel 缓存契约底层实现的便捷、简洁的访问。

例如，让我们在控制器中导入 Cache facade：

php

<?php

namespace App\Http\Controllers;

use Cache;
use Illuminate\Routing\Controller;

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', 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 方法可用于确定缓存中是否存在项目：

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', $minutes, function() {
    return DB::table('users')->get();
});

如果缓存中不存在该项目，将执行传递给 remember 方法的 Closure，其结果将被放入缓存中。

您还可以结合使用 remember 和 forever 方法：

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', $minutes);

您也可以传递一个表示缓存项目过期时间的 PHP DateTime 实例，而不是传递项目过期的分钟数：

php

$expiresAt = Carbon::now()->addMinutes(10);

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

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

php

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

forever 方法可用于永久存储项目在缓存中。这些值必须使用 forget 方法手动从缓存中移除：

php

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

从缓存中移除项目

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

php

Cache::forget('key');

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

php

Cache::flush();

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

添加自定义缓存驱动

要使用自定义驱动扩展 Laravel 缓存，我们将使用 Cache facade 上的 extend 方法，该方法用于将自定义驱动解析器绑定到管理器。通常，这是在服务提供者中完成的。

例如，要注册一个名为 "mongo" 的新缓存驱动：

php

<?php

namespace App\Providers;

use Cache;
use App\Extensions\MongoStore;
use Illuminate\Support\ServiceProvider;

class CacheServiceProvider extends ServiceProvider
{
    /**
     * 执行服务的注册后引导。
     *
     * @return void
     */
    public function boot()
    {
        Cache::extend('mongo', function($app) {
            return Cache::repository(new MongoStore);
        });
    }

    /**
     * 在容器中注册绑定。
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

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

对 Cache::extend 的调用可以在默认的 App\Providers\AppServiceProvider 的 boot 方法中完成，该方法随新的 Laravel 应用程序一起提供，或者您可以创建自己的服务提供者来容纳扩展 - 只需不要忘记在 config/app.php 提供者数组中注册提供者。

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

php

<?php

namespace App\Extensions;

class MongoStore implements \Illuminate\Contracts\Cache\Store
{
    public function get($key) {}
    public function put($key, $value, $minutes) {}
    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 连接实现这些方法中的每一个。一旦我们的实现完成，我们就可以完成自定义驱动注册：

php

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

一旦您的扩展完成，只需将 config/cache.php 配置文件的 driver 选项更新为扩展的名称。

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

缓存标签

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

存储带标签的缓存项目

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

php

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

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

然而，您不限于 put 方法。您可以在使用标签时使用任何缓存存储方法。

访问带标签的缓存项目

要检索带标签的缓存项目，请将相同的有序标签列表传递给 tags 方法：

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

缓存事件

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

php

/**
 * 为您的应用程序注册任何其他事件。
 *
 * @param  \Illuminate\Contracts\Events\Dispatcher  $events
 * @return void
 */
public function boot(DispatcherContract $events)
{
    parent::boot($events);

    $events->listen('cache.hit', function ($key, $value) {
        //
    });

    $events->listen('cache.missed', function ($key) {
        //
    });

    $events->listen('cache.write', function ($key, $value, $minutes) {
        //
    });

    $events->listen('cache.delete', function ($key) {
        //
    });
}

缓存 ​

配置 ​

缓存先决条件 ​

数据库 ​

Memcached ​

Redis ​

缓存使用 ​

获取缓存实例 ​

访问多个缓存存储 ​

从缓存中检索项目 ​

检查项目是否存在 ​

增加/减少值 ​

检索或更新 ​

检索并删除 ​

将项目存储在缓存中 ​

从缓存中移除项目 ​

添加自定义缓存驱动 ​

缓存标签 ​

存储带标签的缓存项目 ​

访问带标签的缓存项目 ​

缓存事件 ​

缓存

配置

缓存先决条件

数据库

Memcached

Redis

缓存使用

获取缓存实例

访问多个缓存存储

从缓存中检索项目

检查项目是否存在

增加/减少值

检索或更新

检索并删除

将项目存储在缓存中

从缓存中移除项目

添加自定义缓存驱动

缓存标签

存储带标签的缓存项目

访问带标签的缓存项目

缓存事件