범위에 대한 Laravel 사용자 정의 쿼리 빌더-PHP 튜토리얼-php.cn

범위에 대한 Laravel 사용자 정의 쿼리 빌더

Barbara Streisand

풀어 주다： 2024-11-28 05:37:18

원래의

960명이 탐색했습니다.

Laravel Custom Query Builders Over Scopes

안녕하세요 ?

자, 쿼리 범위에 대해 이야기해 보겠습니다. 정말 훌륭합니다. 쿼리를 훨씬 쉽게 읽을 수 있습니다. 의심의 여지가 없습니다. 하지만 내가 그들에 대해 싫어하는 것이 하나 있는데 바로 마술이다. 그리고 모두가 백엔드 개발자가 아닌 팀과 함께 일한다면 그들의 삶을 비참하게 만들 수 있습니다. 물론, PHPDoc을 추가할 수 있지만 항상 마법 같은 일이 벌어지고 있습니다. 이전에 스코프를 사용해 본 적이 없더라도 걱정하지 마세요.

그렇다면 범위란 무엇입니까? ?

다음 코드를 고려하세요.

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에서 이를 알 수 있는 방법이 없습니다.

한 가지 방법은 다음과 같이 PHPDoc을 이용하는 것입니다.

/**
 * @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);
}

로그인 후 복사

이렇게 하면 상태와 같은 컨텍스트별로 쿼리를 그룹화할 수 있을 때 하나의 큰 쿼리 빌더를 사용하지 않아도 됩니다.