使用Laravel Eloquent Builders更简洁的优化你的模型

2023-06-01 00:00:00 模型 优化 简洁

在过去的几年里,我在 Laravel 中创建了大量的模型。

这些模型的尺寸总是随着大量的访问器和增加的范围而膨胀。

对于未介绍的,模型范围是包含查询的方法,可以在从数据库检索数据时进行链接。

例如:

// Models/Article.php
class Article extends Model
{
    public function scopePublished(Builder $builder)
    {
        return $builder->whereNotNull('published_at');
    }
}

//作用域的使用

Article::published()->get();

正如您可能想象的那样,这些方法会在一段时间后累加起来导致模型臃肿,但是如果我告诉您可以轻松清理它呢?


编写你自己的 Eloquent Builder


可以创建您自己的 Eloquent Builder 并将其绑定到您的模型。

这可以通过创建一个扩展 Eloquent Builder 的类来完成。

我将使用上面的示例作为我们将清理的模型。

因此,让我们从创建一个 ArticleBuilder 开始。

你把它放在哪里并不重要,但我倾向于在 App 命名空间中为它创建一个目录。

<?php
declare(strict_types=1);
namespace App\EloquentBuilders;
use Illuminate\Database\Eloquent\Builder;
class ArticleBuilder extends Builder
{
    public function published(): self
    {
        return $this->whereNotNull('published_at');
    }
}

正如您所看到的,它使用与以前相同的方法,因为范围在后台使用查询构建器!


注册您全新的 Eloquent Builder


现在剩下的就是将我们的自定义查询构建器绑定到文章模型。

这可以通过覆盖 newEloquentBuilder 方法来完成。

覆盖它后,您可以删除任何旧范围。

您的最终结果将如下所示!

<?php
declare(strict_types=1);
namespace App\Models;
use App\EloquentBuilders\ArticleBuilder;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
class Article extends Model
{
    use HasFactory;
    public function newEloquentBuilder($query): Builder
    {
        return new ArticleBuilder($query);
    }
}


使用我们的新构建器


使用全新的查询构建器与使用范围相同。

您需要做的就是像往常一样将其链接到您的查询中。

Article::published()->get();


最后,在功能方面没有任何改变,但是您的模型变得更加清晰。


转:

https://dev.to/rocksheep/cleaner-models-with-laravel-eloquent-builders-12h4

相关文章