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 trait添加到基模型中，然后在那里设置缓存键前缀配置值。

以下是一个示例

<?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在所有seeder查询中使用，以避免在多次重置时拉取缓存的旧信息。您可以通过在查询链中的任何位置使用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中包含全面的文档。
提供符合https://keepachangelog.com格式的最新CHANGELOG.md。
在整个代码中没有任何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。只有符合所有标准的拉取请求才会被接受。

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

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

genealabs / laravel-model-caching

维护者

详细信息