缓存系统

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

    数据库

    当使用 database 缓存驱动时,你需要配置一个表来存放缓存数据,下面是构建缓存数据表结构的 Schema 声明示例:

    Memcached

    使用 Memcached 驱动需要安装 。你可以把所有 Memcached 服务器都列在 config/cache.php 配置文件中:

    1. 'memcached' => [
    2. [
    3. 'host' => '127.0.0.1',
    4. 'port' => 11211,
    5. 'weight' => 100
    6. ],
    7. ],

    你可以将 host 选项设置为 UNIX 的 socket 路径。如果你这样配置了,记得 port 选项应该设置为 0:

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

    Redis

    在使用 Laravel 的 Redis 缓存之前,你需要通过 Composer 安装 predis/predis 扩展包 (~1.0) 或者使用 PECL 安装 PhpRedis PHP 拓展。

    如需了解更多配置 Redis 的信息,请参考 。

    获取缓存实例

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

    不过,你也可以使用 Cache Facade,我们将在后续的文档中介绍。Cache Facade 为 Laravel 缓存契约底层的实现提供了方便又简洁的方法:

    1. <?php
    2. namespace App\Http\Controllers;
    3. use Illuminate\Support\Facades\Cache;
    4. class UserController extends Controller
    5. {
    6. /**
    7. * 显示应用程序的所有用户的列表。
    8. * @return Response
    9. */
    10. public function index()
    11. {
    12. $value = Cache::get('key');
    13. //
    14. }
    15. }

    访问多个缓存存储

    使用 Cache Facade,你可以通过 store 方法来访问各种缓存存储。 传入 store 方法的键应该对应 cache 配置信息文件中的 stores 配置数组中所列的存储之一:

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

    从缓存中获取数据

    Cache Facade 中的 get 方法是用来从缓存中获取数据的方法。如果该数据不存在于缓存中,则该方法返回 null。你也可以向 get 方法传递第二个参数,用来指定如果查找的数据不存在时,你希望返回的默认值:

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

    你甚至可以传递 Closure 作为默认值。如果指定的数据不存在于缓存中,将返回 Closure 的结果。传递闭包的方法可以允许你从数据库或其他外部服务中获取默认值:

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

    确认项目是否存在

    方法可用于确定缓存中是否存在项目。如果值为 nullfalse,则此方法将返回 false

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

    递增与递减值

    incrementdecrement 方法可以用来调整高速缓存中整数项的值。这两个方法都可以传入第二个可选参数,用来指示要递增或递减值的数量:

    1. Cache::increment('key');
    2. Cache::increment('key', $amount);
    3. Cache::decrement('key');
    4. Cache::decrement('key', $amount);

    获取和存储

    如果缓存中不存在你想找的数据,则传递给 remember 方法的 Closure 将被执行,然后将其结果返回并放置在缓存中。

    你还可以使用 rememberForever 方法从缓存中查找数据或永久存储它:

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

    获取和删除

    如果你需要从缓存中获取到数据之后再删除它,你可以使用 pull 方法。和 get 方法一样,如果缓存中不存在该数据, 则返回 null :

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

    你可以使用 Cache Facade 的 put 方法来将数据存储到缓存中。当你在缓存中存放数据时,你需要使用第三个参数来设定缓存的过期时间:

    1. Cache::put('key', 'value', $minutes);

    除了以整数形式传递过期的分钟数,还可以传递一个 DateTime 实例来表示该数据的过期时间:

    1. $expiresAt = now()->addMinutes(10);
    2. Cache::put('key', 'value', $expiresAt);

    只存储没有的数据

    add 方法将不存在于缓存中的数据放入缓存中,如果存放成功返回 true ,否则返回 false

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

    数据永久存储

    forever 方法可以用来将数据永久存入缓存中。因为这些缓存数据不会过期,所以必须通过 forget 方法从缓存中手动删除它们:

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

    {tip} 如果你使用 Memcached 驱动,那么当缓存数量达到其大小限制时,可能会删除「永久」存储的数据。

    删除缓存中的数据

    你可以使用 forget 方法从缓存中删除数据:

    1. Cache::forget('key');

    你也可以使用 flush 方法清空所有缓存:

    1. Cache::flush();

    Cache 辅助函数

    除了可以使用 Cache Facade 或者 Cache 契约 之外,你也可以使用全局帮助函数 cache 来获取和保存缓存数据。当 cache 只接收一个字符串参数的时候,它将会返回给定键对应的值:

    如果你向函数提供了一组键值对和到期时间,它会在指定时间内在缓存中存储数据:

    1. cache(['key' => 'value'], $minutes);
    2. cache(['key' => 'value'], now()->addSeconds(10));

    {tip} 如果在测试中使用全局函数 cache,可以使用 Cache::shouldReceive 方法,就像正在 一样。

    所谓的缓存标记,就是对缓存的数据打上相关的标记,以便清空所有被分配指定标记的缓存值。你可以通过传入标记名称的有序数组来为缓存数据写入标记。例如,我们可以将值 put 进缓存的同时标记它:

    1. Cache::tags(['people', 'artists'])->put('John', $john, $minutes);
    2. Cache::tags(['people', 'authors'])->put('Anne', $anne, $minutes);

    访问被标记的缓存数据

    若要获取一个被标记的缓存数据,请将相同的有序标记数组传递给 tags 方法,然后调用 get 方法来获取你要检索的键:

    1. $john = Cache::tags(['people', 'artists'])->get('John');
    2. $anne = Cache::tags(['people', 'authors'])->get('Anne');

    移除被标记的缓存数据

    你可以清空有单个标记或是一组标记的所有缓存数据。例如,下面的语句会删除被标记为 peopleauthors 或两者都有的缓存。所以,AnneJohn 都会从缓存被删除:

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

    相比之下,下面的语句只会删除被标记为 authors 的缓存,所以 Anne 会被移除,但 John 不会:

    1. Cache::tags('authors')->flush();

    要创建自定义的缓存驱动程序,首先需要实现 契约 。因此,MongoDB 的缓存实现看起来会像这样:

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

    我们只需要使用 MongoDB 的连接来实现这些方法。关于如何实现这些方法的示例,可以参阅框架源代码中的 Illuminate\Cache\MemcachedStore。一旦我们完成方法的实现,可以像下面这样完成自定义驱动的注册了。

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

    {tip} 如果你想自定义的缓存驱动代码的放置,你可以在 app 目录下创建一个 Extensions 命名空间。Laravel 没有硬性规定应用程序的结构,你可以根据自己的喜好自由组织你的应用程序。

    注册驱动

    要使用 Laravel 来注册自定义的缓存驱动,就要在 Cache Facade 上使用 extend 方法。对 Cache::extend 的调用可以在最新的 Laravel 应用程序中附带的 App\Providers\AppServiceProviderboot 方法中完成,或者你可以创建自己的服务提供器来放置这些扩展,只是不要忘记在 config/app.php 中的 providers 数组中注册提供器:

    1. <?php
    2. namespace App\Providers;
    3. use App\Extensions\MongoStore;
    4. use Illuminate\Support\Facades\Cache;
    5. use Illuminate\Support\ServiceProvider;
    6. class CacheServiceProvider extends ServiceProvider
    7. {
    8. /**
    9. * 执行服务的注册后引导。
    10. *
    11. * @return void
    12. */
    13. public function boot()
    14. {
    15. Cache::extend('mongo', function ($app) {
    16. return Cache::repository(new MongoStore);
    17. });
    18. }
    19. /**
    20. * 在容器中注册绑定。
    21. *
    22. * @return void
    23. */
    24. public function register()
    25. {
    26. //
    27. }

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

    你的自定义的扩展注册后,需要将 config/cache.php 配置文件中的 选项更新为你的扩展名。

    你可以监听缓存触发的 来对每个缓存的操作执行代码。为此,你应该要将这些事件监听器放在 EventServiceProvider 中: