README

Matryoshka 是一个为 Laravel 提供俄罗斯套娃缓存功能的包。

想了解这个包是如何从头制作的？请访问 Laracasts.com。

安装

步骤 1: Composer

从命令行运行

composer require laracasts/matryoshka

步骤 2: 服务提供者

打开你的 Laravel 应用程序的 config/app.php 文件，并在 providers 数组中添加

Laracasts\Matryoshka\MatryoshkaServiceProvider::class

这将引导该包进入 Laravel。

步骤 3: 缓存驱动器

为了使此包正常工作，你必须使用支持标签的 Laravel 缓存驱动器（如 Cache::tags('foo')）。Memcached 和 Redis 等驱动器支持此功能。

检查你的 .env 文件，确保你的 CACHE_DRIVER 选择符合此要求

CACHE_DRIVER=memcached

需要任何帮助，请参阅 Laravel 缓存配置文档。

使用方法

基础知识

现在包已安装，你可以在视图的任何位置使用提供的 @cache Blade 指令，如下所示

@cache('my-cache-key')
    <div>
        <h1>Hello World</h1>
    </div>
@endcache

通过将此 HTML 块用 @cache 和 @endcache 指令包围，我们要求包缓存给定的 HTML。现在这个例子很简单，但是你可以想象一个更复杂的视图，其中包括各种嵌套缓存以及触发额外数据库查询的懒加载关系调用。在缓存 HTML 片段的初始页面加载之后，每次刷新都会从缓存中获取。因此，那些额外的数据库查询将永远不会执行。

请注意，在生产环境中，这会“永久”缓存 HTML 片段。另一方面，在本地开发中，每次刷新页面时，我们将自动为您清除相关的缓存。这样，您可以随心所欲地更新视图和模板，而无需担心手动清除缓存。

现在，因为您的生产服务器将永久缓存片段，您希望在您的部署过程中添加一个清除相关缓存的步骤。

Cache::tags('views')->flush();

缓存模型

虽然您可以为任何字符串硬编码缓存键，但俄罗斯套娃缓存的真正威力在于我们使用基于时间戳的方法。

考虑以下片段

@cache($post)
    <article>
        <h2>{{ $post->title }}></h2>
        <p>Written By: {{ $post->author->username }}</p>

        <div class="body">{{ $post->body }}</div>
    </article>
@endcache

在这个例子中，我们传递了 $post 对象本身到 @cache 指令 - 而不是字符串。然后包会在模型上查找 getCacheKey() 方法。我们已经为您完成了这项工作；只需让您的 Eloquent 模型使用 Laracasts\Matryoshka\Cacheable 特性，如下所示

use Laracasts\Matryoshka\Cacheable;

class Post extends Eloquent
{
    use Cacheable;
}

或者，您可以在您每个 Eloquent 模型继承的父类上使用此特性。

这就完成了！现在，此片段的缓存键将包括对象的 id 和 updated_at 时间戳：App\Post/1-13241235123。

关键是，因为我们把 updated_at 时间戳纳入缓存键中，所以每次更新给定的帖子时，缓存键都会改变。这将有效地清除缓存！

触摸

为了使这项技术正常工作，我们必须有一些机制来在每个模型更新时通知父级关系（并随后清除父级缓存）。以下是一个基本的工作流程：

数据库中的模型被更新。
它的updated_at时间戳被刷新，为该实例触发新的缓存键。
模型“接触”（或ping）其父级。
父级的updated_at时间戳也被更新，这将清除其相关的缓存。
只有受影响的片段会重新渲染。所有其他缓存项保持不变。

幸运的是，Laravel自带“touch”功能。考虑一个需要在其更新发生时通知其父级Card关系的Note对象。

<?php

namespace App;

use Laracasts\Matryoshka\Cacheable;
use Illuminate\Database\Eloquent\Model;

class Note extends Model
{
    use Cacheable;

    protected $touches = ['card'];

    public function card()
    {
        return $this->belongsTo(Card::class);
    }
}

注意$touches = ['card']部分。这指示Laravel在笔记更新时pingcard关系的时间戳。

现在，一切准备就绪。你可以这样渲染你的视图

resources/views/cards/_card.blade.php

@cache($card)
    <article class="Card">
        <h2>{{ $card->title }}</h2>

        <ul>
            @foreach ($card->notes as $note)
                @include ('cards/_note')
            @endforeach
        </ul>
    </article>
@endcache

resources/views/cards/_note.blade.php

@cache($note)
    <li>{{ $note->body }}</li>
@endcache

注意我们缓存的俄罗斯套娃式级联；这是关键。如果有任何笔记被更新，其个人缓存将清除——连同其父级——但任何兄弟将保持不变。

缓存集合

你并不总是想缓存模型实例；你可能会希望缓存Laravel集合！没问题。

@cache($posts)
    @foreach ($posts as $post)
        @include ('post')
    @endforeach
@endcache

只要$posts集合的内容不发生变化，那么这个@foreach部分就永远不会运行。相反，和往常一样，我们会从缓存中提取。

在幕后，这个包会检测到你传递了一个Laravel集合到cache指令，并随后为集合生成一个唯一的缓存键。

常见问题解答

1. 有没有方法可以覆盖模型实例的缓存键？

是的。假设你有

@cache($post)
    <div>view here</div>
@endcache

在幕后，我们会寻找模型上的getCacheKey方法。现在，如上所述，你可以使用Laracasts\Matryoshka\Cacheable特性来立即导入此功能。或者，你也可以向@cache指令传递第二个参数，如下所示

@cache($post, 'my-custom-key')
    <div>view here</div>
@endcache

这指示包使用my-custom-key作为缓存，这在分页和其他相关任务中可能很有用。

2. 我在哪里可以了解更多关于这种缓存方法的信息？

阅读这两篇文章

如果你喜欢Laracasts，请在这里观看这个包的从头创建过程。

laracasts / matryoshka

维护者

详细信息