README

支持此包

这是一个 MIT 许可的开源项目，其持续开发得益于社区的支援。如果您想支持这个项目以及我们的其他包，请考虑成为赞助者。

感谢以下赞助商的慷慨，请花点时间了解一下

Impetus

我创建了这个包是为了响应一个客户项目，该项目中有很多复杂的嵌套表单和多个 <select>，导致一个页面上有超过 700 次数据库查询。我需要一个可以将缓存过程从模型中抽象出来的包，以及一个可以让我缓存自定义查询和模型关系的包。这个包是试图满足这些需求的一种尝试。

特性

自动、自失效的关系（仅预加载）缓存。
自动、自失效的模型查询缓存。
自动使用缓存标签（对于支持缓存标签的缓存提供者），对于不支持缓存标签的提供者将刷新整个缓存。

缓存驱动

这个包最适合可标记的缓存驱动。

+ Redis
+ MemCached
+ APC
+ Array

它不会与非标记的驱动一起工作。

- Database
- File
- DynamoDB

要求

PHP 7.3+

Laravel 8.0+

- Please note that prior Laravel versions are not supported and the package
- versions that are compatible with prior versions of Laravel contain bugs.
- Please only use with the versions of Laravel noted above to be compatible.

可能的包冲突

任何覆盖了 Model 类中的 newEloquentModel() 的包可能会与这个包冲突。当然，任何实现了自己的 Querybuilder 类的包实际上绕过了这个包，因此它们不兼容。

以下是已确定的冲突包

当前不工作的事项

以下项目目前不与这个包一起工作

- caching of lazy-loaded relationships, see #127. Currently lazy-loaded belongs-to relationships are cached. Caching of other relationships is in the works.
- using select() clauses in Eloquent queries, see #238 (work-around discussed in the issue)
- using transactions. If you are using transactions, you will likely have to manually flush the cache, see [issue #305](https://github.com/GeneaLabs/laravel-model-caching/issues/305).

安装

在需要时，请确保不要要求这个包的特定版本

composer require genealabs/laravel-model-caching

使用 Lumen 时的注意事项

以下步骤需要您自己解决，并在您的 Lumen 应用中实现。通过 Google 搜索提供了各种实现方式。

在 Lumen 中注册包以加载

$app->register(GeneaLabs\LaravelModelCaching\Providers\Service::class);

确保您的 Lumen 应用可以加载配置文件。
将此包的配置文件发布到您的应用加载配置文件的位置。

升级说明

0.6.0

禁用此包的环境和配置变量已更改。

如果您之前已发布配置文件，请再次发布，并根据需要调整。
```
php artisan modelCache:publish --config
```
如果您在 .env 文件中禁用了此包，请将条目从 MODEL_CACHE_DISABLED=true 更改为 MODEL_CACHE_ENABLED=false。

0.5.0

以下实现已更改（请参阅下面的相应部分）

特定于模型的缓存前缀

配置

用法

为了获得最佳性能，建议使用可标记的缓存提供程序（redis、memcached）。虽然这是可选的，但使用不可标记的缓存提供程序意味着每次创建、保存、更新或删除模型时，整个缓存都会被清除。

为了便于维护，我建议添加一个使用 Cachable 的 BaseModel 模型，所有其他模型都从这个模型扩展。如果您不想这样做，只需直接从 CachedModel 扩展您的模型。

以下是一个 BaseModel 类的示例

<?php namespace App;

use GeneaLabs\LaravelModelCaching\Traits\Cachable;

abstract class BaseModel
{
    use Cachable;
    //
}

多个数据库连接

感谢 @dtvmedia 提出此功能。这实际上比缓存前缀更健壮。

自动处理多个数据库连接的键的分离。这对于多租户应用程序非常重要，当然，任何使用多个数据库连接的应用程序也是如此。

可选的缓存键前缀

感谢 @lucian-dragomir 提出此功能！您可以使用缓存键前缀来为多租户应用程序保持缓存条目的分离。为此，建议将 Cachable 特性添加到基模型中，然后设置缓存键前缀配置值。

以下是一个示例

<?php namespace GeneaLabs\LaravelModelCaching\Tests\Fixtures;

use GeneaLabs\LaravelModelCaching\Traits\Cachable;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;

class BaseModel extends Model
{
    use Cachable;

    protected $cachePrefix = "test-prefix";
}

您还可以在配置中设置缓存前缀，以便为所有缓存模型设置前缀

    'cache-prefix' => 'test-prefix',

异常：用户模型

我不建议缓存用户模型，因为它是一个特殊情况，因为它扩展了 Illuminate\Foundation\Auth\User。覆盖它将破坏功能。不仅如此，缓存用户模型可能也不是一个好主意，因为您始终希望获取其最新信息。

实验性：在特定模型中缓存冷却期

在某些情况下，您可能希望添加一个缓存失效冷却期。例如，您可能有一个繁忙的网站，其中评论提交速度很高，您不希望每次提交评论都使缓存失效。虽然我不一定推荐这样做，但您可以尝试其有效性。

要使用它，必须在模型（或基模型，如果您想要在多个或所有模型上使用它）中启用它

class MyModel extends Model
{
    use Cachable;

    protected $cacheCooldownSeconds = 300; // 5 minutes

    // ...
}

之后它可以在查询中实现

(new Comment)
    ->withCacheCooldownSeconds(30) // override default cooldown seconds in model
    ->get();

或

(new Comment)
    ->withCacheCooldownSeconds() // use default cooldown seconds in model
    ->get();

禁用查询缓存

有两种方法可以禁用模型缓存

在按查询实例中使用 ->disableCache()。
在您的 .env 文件中设置 MODEL_CACHE_ENABLED=false。

如果您只需要禁用代码块或非 eloquent 查询的缓存，这可能是一个更好的选择

$result = app("model-cache")->runDisabled(function () {
    return (new MyModel)->get(); // or any other stuff you need to run with model-caching disabled
});

建议：在所有种子查询中使用选项 #1，以避免在多次重新播种时拉入缓存信息。您可以通过在查询链中的任何位置使用 disableCache() 来禁用特定的查询。例如

$results = $myModel->disableCache()->where('field', $value)->get();

手动刷新特定模型

您可以使用以下 artisan 命令来刷新特定模型的缓存

php artisan modelCache:clear --model=App\Model

当手动更新数据库时，这很有用。您也可以在从 Laravel 应用程序外部更新数据库后触发此操作。

总结

这就是您需要做的。所有模型查询和关系现在都缓存了！

在测试中，这使某些页面的性能优化高达 900%！通常您应该看到大约 100% 的性能提升。

对质量的承诺

在包开发过程中，我尽最大努力采用良好的设计和开发实践，以确保这个包尽可能好。我的包开发清单包括

✅ 使用单元测试尽可能实现接近 100% 的代码覆盖率。
✅ 消除 SensioLabs Insight 和 Scrutinizer 确定的任何问题。
✅ 完全符合 PSR1、PSR2 和 PSR4。
✅ 在 README.md 中包含全面的文档。
✅ 提供一个最新的 CHANGELOG.md，该格式符合在 https://keepachangelog.com 中概述的格式。
✅ 在所有代码中无 PHPMD 或 PHPCS 警告。

贡献

请遵守和尊重包含的《行为准则》的各个方面 https://github.com/GeneaLabs/laravel-model-caching/blob/master/CODE_OF_CONDUCT.md。

报告问题

在报告问题时，请尽可能完整地填写包含的模板。信息不完整的问题可能会被忽略或关闭，如果包含的信息不足以采取行动。

提交拉取请求

请查看《贡献指南》 https://github.com/GeneaLabs/laravel-model-caching/blob/master/CONTRIBUTING.md。只有符合所有标准的 PR 才会被接受。

如果你喜欢开源软件，给你的使用的仓库点个 ⭐️。

我们已将出色的 symfony/thanks composer 包作为开发依赖项包含在内。通过给你的操作系统包维护者点星来告知你感激他们。只需安装此包后运行 composer thanks 即可。（不必担心，由于它是开发依赖项，它不会安装在你的实时环境中。）

雪软 / laravel-model-caching

维护者

详情