Laravel Custom Query Builder über Bereiche

Hallo ?

Okay, lass uns über Abfragebereiche sprechen. Sie sind großartig, sie machen Abfragen viel einfacher zu lesen, daran besteht kein Zweifel. Aber eines hasse ich an ihnen: Magie. Und wenn Sie mit einem Team zusammenarbeiten, in dem nicht jeder ein Backend-Entwickler ist, kann das das Leben zur Hölle machen. Sicher, Sie können PHPDocs hinzufügen, aber es ist immer etwas Magisches im Gange. Wenn Sie noch nie zuvor Zielfernrohre verwendet haben, keine Sorge, bleiben Sie dran, Kumpel.

Was sind also Scopes? ?

Beachten Sie diesen Code:

use App\Models\User;

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

So würden Sie normalerweise Anfragen schreiben. Wenn Abfragen jedoch zu komplex oder schwer lesbar werden, können Sie sie in Bereiche abstrahieren:

<?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);
    }
}

Jetzt können Sie Folgendes tun:

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

Liest sich viel besser, oder? Ich weiß. Das Problem ist jedoch, dass Sie keine automatische Vervollständigung erhalten. Das ist dunkle Magie für die IDE. Da Bereiche zur Laufzeit aufgelöst werden und ihnen der Bereich vorangestellt wird, kann Ihre IDE nichts davon wissen, es sei denn, Sie helfen ihr.

Eine Möglichkeit ist über PHPDocs, etwa so:

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

Ein weiterer Nachteil von Zielfernrohren? Die am häufigsten verwendeten Modelle sind umsonst mit Unmengen davon aufgebläht. Ich liebe es, durch meine Modelle zu blättern und sofort die Beziehungen und die Kernlogik zu erkennen, nicht einen Haufen Abfrageabstraktionen.

Sooo? Lassen wir die Zielfernrohre einfach fallen und machen wir weiter? Nun, das ist eine Option, oder Sie könnten benutzerdefinierte Abfrage-Builder verwenden.

Benutzerdefinierte Abfrage-Builder?

Wie der Name schon sagt, können Sie mit einem benutzerdefinierten Abfrage-Builder alle Ihre Abfrageabstraktionen in eine dedizierte Klasse verschieben. Der Code wird in gewisser Weise besser organisiert.

Lassen Sie uns eine neue Klasse UserQueryBuilder erstellen:

<?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);
    }
}

Wohin mit Bauarbeitern? Es gibt keine Richtlinie, aber ich persönlich platziere sie gerne in app/Eloquent/QueryBuilders.

Nun verwenden wir diesen Builder im Benutzermodell:

<?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();
    }
}

Und einfach so können Sie jetzt Folgendes tun:

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

Funktioniert genauso und Sie erhalten eine vollständige automatische Vervollständigung. Außerdem funktioniert die Code-Navigation perfekt und bringt Sie dorthin, wo Sie sein müssen?

Eine weitere coole Sache ist, dass Sie Abfrage-Builder bei Bedarf dynamisch auflösen können.

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

    return new UserQueryBuilder($query);
}

Auf diese Weise vermeiden Sie die Verwendung eines großen Abfrage-Builders, da Sie Abfragen nach Kontext gruppieren können (z. B. nach einem Bundesstaat).

Das ist es ✅

Zielfernrohre sind cool, und wenn ich nur 2-3 davon habe, bleibe ich dabei. Aber wenn die Dinge außer Kontrolle geraten, sind benutzerdefinierte Abfrage-Builder die richtige Wahl. Sie sind den zusätzlichen Aufwand wert, denn sie sorgen dafür, dass Ihr Code sauber, organisiert und einfacher zu warten ist?

Das obige ist der detaillierte Inhalt vonLaravel Custom Query Builder über Bereiche. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!