Laravel 跨范围的自定义查询构建器

你好 ？

好吧，我们来谈谈查询范围。它们非常棒，毫无疑问它们使查询更容易阅读。但我讨厌他们一件事：魔法。当你与一个并非每个人都是后端开发人员的团队合作时，这可能会让他们的生活变得悲惨。当然，您可以添加 PHPDocs，但总有一些神奇的事情发生。如果您以前从未使用过瞄准镜，不用担心，请坚持住。

那么，什么是范围？ ？

考虑这段代码：

use App\Models\User;

$users = User::query()
    ->where('votes', '>', 100);
    ->where('active', 1);
    ->orderBy('created_at')
    ->get();

这是您通常编写查询的方式。但是当查询变得太复杂或难以阅读时，您可以将它们抽象到范围中：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    public function scopePopular(Builder $query): void
    {
        $query->where('votes', '>', 100);
    }

    public function scopeActive(Builder $query): void
    {
        $query->where('active', 1);
    }
}

现在你可以这样做：

$users = User::query()
    ->popular()
    ->active()
    ->orderBy('created_at')
    ->get();

读起来好多了，对吧？我知道。但问题是，你没有得到任何自动完成功能。这对 IDE 来说是黑暗魔法。由于作用域在运行时解析并以作用域为前缀，因此除非您提供帮助，否则您的 IDE 无法了解它们。

一种方法是通过 PHPDocs，如下所示：

/**
 * @method static Builder popular()
 * @method static Builder active()
 */
class User extends Model

范围的另一个缺点？最常用的模型最终会徒劳地增加大量的模型。我喜欢浏览我的模型并立即看到关系和核心逻辑，而不是一堆查询抽象。

苏？我们是否会放弃范围并继续前进？嗯，这是一个选项，或者您可以使用自定义查询生成器。

自定义查询生成器？

顾名思义，自定义查询生成器可让您将所有查询抽象移至专用类中。代码将以某种方式变得更有组织性。

让我们创建一个新类 UserQueryBuilder：

<?php

namespace App\Eloquent\QueryBuilders;

use App\Models\User;
use Illuminate\Database\Eloquent\Builder;

class UserQueryBuilder extends Builder
{
    public function popular(): self
    {
        return $this->where('votes', '>', 100);
    }

    public function active(): self
    {
        return $this->where('active', 1);
    }
}

构建器应该放在哪里？没有指南，但我个人喜欢将它们放在 app/Eloquent/QueryBuilders 中。

现在让我们在用户模型中使用这个构建器：

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class User extends Model
{
    public function newEloquentBuilder($query): UserQueryBuilder
    {
        return new UserQueryBuilder($query);
    }

    // for type hints
    public static function query(): UserQueryBuilder
    {
        return parent::query();
    }
}

就像这样，您现在可以这样做：

$users = User::query()
    ->popular()
    ->active()
    ->orderBy('created_at')
    ->get();

工作原理完全相同，并且您可以获得完全自动补全。另外，代码导航功能完美，可以带您到达您需要去的地方？

另一个很酷的事情是您可以根据需要动态解析查询构建器。

public function newEloquentBuilder($query): UserQueryBuilder
{
    if ($this->status === State::Pending) {
        return new PendingUserQueryBuilder($query); // extends UserQueryBuilder
    }

    return new UserQueryBuilder($query);
}

这样，当您可以按上下文（如状态）对查询进行分组时，您就可以避免使用一个大型查询构建器。

就这样了✅

瞄准镜很酷，如果我只有 2-3 个，我会坚持使用它们。但当事情开始失控时，自定义查询构建器就是最佳选择。它们值得付出额外的努力，让您的代码保持干净、有组织且易于维护？

以上是Laravel 跨范围的自定义查询构建器的详细内容。更多信息请关注PHP中文网其他相关文章！