Laravel 11의 PHP 제네릭

Laravel을 사용하는 웹 애플리케이션 빌더이고 정적 코드 분석을 위해 PHPStan을 사용하는 경우 Laravel으로 업그레이드할 때 새로운 오류가 표시되기 시작합니다. 11.x.

PHPStan을 사용하여 새로 Laravel을 설치한 경우 ./vendor/bin/phpstan을 처음 실행하면 다음 오류가 발생합니다.

 ------ -----------------------------------------------------------------------------------
  Line   app\Models\User.php
 ------ -----------------------------------------------------------------------------------
  13     Class App\Models\User uses generic trait
         Illuminate\Database\Eloquent\Factories\HasFactory but does not specify its types:
         TFactory
 ------ -----------------------------------------------------------------------------------

그래서 무엇이 바뀌었나요? Laravel 11에서 HasFactory 특성에는 이제 예약된 일반 태그 중 하나인 @template 태그가 있는 PHPDoc이 있습니다. 이미 짐작하셨겠지만 제네릭은 프레임워크의 많은 부분에서 사용되고 있습니다.

/**
 * @template TFactory of \Illuminate\Database\Eloquent\Factories\Factory
 */
trait HasFactory
{
    ...
}

권장되지는 않지만 phpstan.neon 파일에 다음 코드 줄을 추가하면 이 오류 범주를 무시할 수 있습니다.

parameters:
    ignoreErrors:
        -
            identifier: missingType.generics

하지만 제네릭은 그다지 이해하기 어렵지 않으니 시작해 보세요!

제네릭이란 무엇입니까?

프로그래밍에서 제네릭은 여러 데이터 유형에 사용할 수 있는 코드를 작성할 수 있는 기능을 의미합니다. 각 데이터 유형에 대해 별도의 코드를 작성하는 대신 혼합 또는 객체와 같은 일반적인 유형을 사용하는 것과 달리 유형 안전성을 유지하면서 다양한 유형에서 작동할 수 있는 하나의 일반적인 코드 조각을 작성할 수 있습니다.

Laravel 10에서 IlluminateDatabaseConcernsBuildsQueries::first 메소드를 사용하면 IlluminateDatabaseEloquentBuilder 또는 null과 같이 이를 사용하는 클래스의 인스턴스인 일반 객체인 Model의 인스턴스를 반환할 수 있습니다.

/**
 * Execute the query and get the first result.
 *
 * @param  array|string  $columns
 * @return \Illuminate\Database\Eloquent\Model|object|static|null
 */
public function first($columns = ['*'])
{
    return $this->take(1)->get($columns)->first();
}

제네릭 구문

제네릭은 PHP에서 최우선적으로 지원되지 않습니다. 이를 사용하려면 PHPDocs 태그 @template, @template-covariant, @template-contravariant, @extends, @implements 및 @use.

일반 유형의 규칙은 유형 매개변수를 사용하여 정의됩니다. PHPDocs에서는 @template 태그로 주석을 답니다. 유형 매개변수 이름은 기존 클래스 이름을 사용하지 않는 한 무엇이든 될 수 있습니다. of 키워드를 사용하여 유형 매개변수 대신 사용할 수 있는 유형을 상한으로 제한할 수도 있습니다. 이를 제한된 유형 매개변수
라고 합니다.

<?php

namespace Illuminate\Database\Eloquent;

/**
 * @template TModel of \Illuminate\Database\Eloquent\Model
 *
 */
class Builder implements BuilderContract
{
}

PHP 제네릭의 유형

일반 기능

일반 함수는 일반 함수와 똑같지만 유형 매개변수가 있습니다. 이를 통해 일반적인 방법을 보다 일반적인 방식으로 사용할 수 있습니다.

IlluminateSupportValidatedInput::enum 메소드를 예로 들어보세요.

• 유형 매개변수 TEnum을 정의합니다.

• $enumClass 매개변수는 의사 유형 class-string이고 동일한 유형 매개변수 TEnum에 제한됩니다.

• 반환 유형은 TEnum 또는 null일 수도 있습니다.
  

 ------ -----------------------------------------------------------------------------------
  Line   app\Models\User.php
 ------ -----------------------------------------------------------------------------------
  13     Class App\Models\User uses generic trait
         Illuminate\Database\Eloquent\Factories\HasFactory but does not specify its types:
         TFactory
 ------ -----------------------------------------------------------------------------------

$request→validated()→enum('status', OrderStatus::class)를 호출하면 PHPStan은 OrderStatus 객체 또는 null을 얻는다는 것을 알게 됩니다!

일반 클래스

일반 클래스를 사용하면 유형 안전성을 보장하면서 모든 데이터 유형에서 작동할 수 있는 클래스를 만들 수 있습니다. 특정 유형에 대한 자리 표시자로 클래스를 정의할 수 있으며, 나중에 클래스가 인스턴스화될 때 대체될 수 있습니다.

Laravel 소스 코드의 좋은 예는 IlluminateDatabaseEloquentBuilder 클래스입니다.

/**
 * @template TFactory of \Illuminate\Database\Eloquent\Factories\Factory
 */
trait HasFactory
{
    ...
}

유형 매개변수 TModel은 IlluminateDatabaseEloquentModel의 모든 하위 클래스에 정의되고 바인딩됩니다. make 메소드의 반환 유형으로 동일한 유형 매개변수가 사용됩니다.

또 다른 예로는 상태에 따라 주문을 필터링하는 로컬 범위가 있는 주문 모델이 있는 경우입니다. 범위 메소드는 TModel 유형을 지정해야 합니다

parameters:
    ignoreErrors:
        -
            identifier: missingType.generics

ℹ️ info: BelongsTo 및 HasOne과 같은 IlluminateDatabaseEloquentRelations 네임스페이스의 모든 Eloquent 관계 클래스는 이제 일반 클래스입니다.

일반 인터페이스

일반 인터페이스는 크게 다르지 않습니다. IlluminateContractsSupportArrayable은 일반 인터페이스의 예입니다

/**
 * Execute the query and get the first result.
 *
 * @param  array|string  $columns
 * @return \Illuminate\Database\Eloquent\Model|object|static|null
 */
public function first($columns = ['*'])
{
    return $this->take(1)->get($columns)->first();
}

인터페이스는 배열 키 유형의 TKey(int 또는 문자열일 수 있음)와 TValue라는 두 가지 유형 매개변수를 정의합니다. 이 두 매개변수는 toArray 함수의 반환 유형을 정의하는 데 사용됩니다. 예는 다음과 같습니다.

<?php

namespace Illuminate\Database\Eloquent;

/**
 * @template TModel of \Illuminate\Database\Eloquent\Model
 *
 */
class Builder implements BuilderContract
{
}

사용자 클래스는 Arrayable 인터페이스를 구현하고 Tkey 유형을 int로, TValue를 문자열로 지정합니다.

일반 특성

이 게시물 시작 부분의 오류에서 IlluminateDatabaseEloquentFactoriesHasFactory 특성을 발견했습니다. 좀 더 자세히 살펴보겠습니다:

/**
 * @template TEnum
 *
 * @param string $key
 * @param class-string<TEnum> $enumClass
 * @return TEnum|null
 */
public function enum($key, $enumClass)
{
    if ($this->isNotFilled($key) ||
        ! enum_exists($enumClass) ||
        ! method_exists($enumClass, 'tryFrom')) {
        return null;
    }
    return $enumClass::tryFrom($this->input($key));
}

HasFactory는 IlluminateDatabaseEloquentFactoriesFactory의 하위 클래스에 바인딩된 유형 매개변수 TFactory를 정의합니다. 그러면 해당 오류를 어떻게 수정할 수 있나요?

특성을 사용할 때 TFactory 유형을 지정해야 합니다. 따라서 HasFactory 특성의 use 문은 PHPDocs @use:
로 주석을 달아야 합니다.

<?php

namespace Illuminate\Database\Eloquent;
/**
 * @template TModel of \Illuminate\Database\Eloquent\Model
 */
class Builder implements BuilderContract
{
    /**
     * @param  array  $attributes
     * @return TModel
     */
    public function make(array $attributes = [])
    {
        return $this->newModelInstance($attributes);
    }
}

일반성 보존

클래스 확장, 인터페이스 구현, 특성 사용 시 하위 클래스의 일반성을 유지할 수 있습니다.

일반성을 유지하는 방법은 하위 클래스 위에 동일한 유형 매개변수를 정의하고 이를 @extends, @implements 및 @use 태그에 전달하는 방식으로 구현됩니다.

일루미네이트DatabaseConcernsBuildsQueries 일반 특성을 예로 사용하겠습니다.

유형 매개변수 TValue를 정의합니다:

 ------ -----------------------------------------------------------------------------------
  Line   app\Models\User.php
 ------ -----------------------------------------------------------------------------------
  13     Class App\Models\User uses generic trait
         Illuminate\Database\Eloquent\Factories\HasFactory but does not specify its types:
         TFactory
 ------ -----------------------------------------------------------------------------------

IlluminateDatabaseEloquentBuilder 클래스는 이 특성을 사용하지만 TModel 매개변수 유형을 전달하여 일반성을 유지합니다. 이제 TModel 유형을 지정하고 결과적으로 BuildsQueries 특성에 TValue를 지정하는 것은 클라이언트 코드에 맡겨졌습니다.

/**
 * @template TFactory of \Illuminate\Database\Eloquent\Factories\Factory
 */
trait HasFactory
{
    ...
}

최종 생각

결론적으로, PHP는 다른 프로그래밍 언어와 동일한 방식으로 제네릭을 기본적으로 지원하지 않지만 PHPStan과 같은 고급 유형 힌트 및 도구를 도입하면 개발자가 코드에 제네릭과 유사한 기능을 구현할 수 있습니다. . PHPDocs, 매개변수화된 클래스 및 인터페이스를 활용하면 코드 재사용성과 유지 관리성을 향상시키는 보다 유연하고 유형이 안전한 애플리케이션을 만들 수 있습니다. PHP가 계속 발전함에 따라 유형 안전성과 정적 분석에 대한 커뮤니티의 관심이 높아지면서 제네릭 구현을 위한 보다 강력한 솔루션이 탄생할 가능성이 높습니다. 이러한 관행을 수용하면 코딩 기술이 향상될 뿐만 아니라 시간이 흘러도 변함없는 고품질 소프트웨어 개발에 기여합니다.

위 내용은 Laravel 11의 PHP 제네릭의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!