Pembina Pertanyaan Tersuai Laravel Dalam Skop

Hello ?

Baiklah, mari kita bincangkan tentang Skop Pertanyaan. Mereka hebat, mereka membuat pertanyaan lebih mudah dibaca, tidak syak lagi mengenainya. Tetapi ada satu perkara yang saya benci tentang mereka: sihir. Dan apabila anda bekerja dengan pasukan yang bukan semua orang adalah pembangun bahagian belakang, ini boleh menyusahkan hidup mereka. Sudah tentu, anda boleh menambah PHPDocs, tetapi sentiasa ada keajaiban yang berlaku. Jika anda tidak pernah menggunakan skop sebelum ini, jangan risau, jangan risau.

Jadi, Apakah Skop? ?

Pertimbangkan kod ini:

use App\Models\User;

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

Beginilah kebiasaan anda menulis pertanyaan. Tetapi apabila pertanyaan menjadi terlalu rumit atau sukar dibaca, anda boleh mengabstrakkannya ke dalam skop:

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

Kini anda boleh melakukan ini:

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

Membaca lebih baik bukan? saya tahu. Tetapi isunya ialah, anda tidak mendapat sebarang autolengkap. Ini adalah sihir gelap kepada IDE. Memandangkan skop diselesaikan pada masa jalan dan diawali dengan skop, tiada cara IDE anda mengetahui tentangnya melainkan anda membantunya.

Salah satu cara ialah melalui PHPDocs, seperti:

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

Satu lagi kelemahan skop? Model yang paling kerap digunakan akhirnya kembung dengan banyak daripada mereka, tanpa apa-apa. Saya suka menyemak model saya dan segera melihat perhubungan dan logik teras, bukan sekumpulan abstrak pertanyaan.

Sooo? Adakah kita hanya membuang skop dan teruskan? Nah, itu pilihan, atau anda boleh menggunakan pembina pertanyaan tersuai.

Pembina Pertanyaan Tersuai ?

Seperti namanya, pembina pertanyaan tersuai membolehkan anda memindahkan semua abstraksi pertanyaan anda ke dalam kelas khusus. Kod akan lebih teratur dengan cara.

Mari buat kelas baharu 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);
    }
}

Di mana untuk meletakkan pembina? Tiada garis panduan, tetapi saya secara peribadi suka meletakkannya dalam apl/Eloquent/QueryBuilders.

Sekarang mari kita gunakan pembina ini dalam model Pengguna:

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

Dan seperti itu, anda kini boleh melakukan:

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

Berfungsi sama, dan anda mendapat autolengkap sepenuhnya. Selain itu, navigasi kod berfungsi dengan sempurna, ia membawa anda ke tempat yang anda perlukan ?

Satu lagi perkara menarik ialah anda boleh menyelesaikan pembina pertanyaan secara dinamik jika perlu.

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

    return new UserQueryBuilder($query);
}

Dengan cara ini anda mengelak daripada mempunyai satu pembina pertanyaan besar apabila anda boleh mengumpulkan pertanyaan mengikut konteks (seperti keadaan).

Itu sahaja ✅

Skop adalah hebat, dan jika saya hanya mempunyai 2-3 daripadanya, saya akan kekal dengannya. Tetapi apabila keadaan mula menjadi tidak terkawal, pembina pertanyaan tersuai adalah cara yang perlu dilakukan. Mereka berbaloi dengan usaha tambahan, memastikan kod anda bersih, teratur dan lebih mudah diselenggara ?

Atas ialah kandungan terperinci Pembina Pertanyaan Tersuai Laravel Dalam Skop. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!