컨트랙트 (Contracts)
소개 (Introduction)
Laravel의 "컨트랙트"는 프레임워크가 제공하는 핵심 서비스를 정의하는 인터페이스 집합입니다. 예를 들어, Illuminate\Contracts\Queue\Queue 컨트랙트는 작업을 큐잉하는 데 필요한 메서드를 정의하고, Illuminate\Contracts\Mail\Mailer 컨트랙트는 이메일을 전송하는 데 필요한 메서드를 정의합니다.
각 컨트랙트에는 프레임워크에서 제공하는 대응하는 구현체가 있습니다. 예를 들어, Laravel은 다양한 드라이버를 지원하는 큐 구현체와 Symfony Mailer를 기반으로 작동하는 메일러 구현체를 제공합니다.
모든 Laravel 컨트랙트는 별도의 GitHub 저장소에서 관리됩니다. 이 저장소는 모든 사용 가능한 컨트랙트의 빠른 참고 자료를 제공함과 동시에, Laravel 서비스와 상호작용하는 패키지를 만들 때 사용할 수 있는 단일 독립 패키지를 제공합니다.
컨트랙트와 파사드 비교
Laravel의 파사드와 헬퍼 함수는 서비스 컨테이너에서 명시적으로 컨트랙트를 타입-힌트 하거나 해석할 필요 없이 Laravel 서비스를 간편하게 사용할 수 있는 방법입니다. 대부분의 경우, 각 파사드는 동일한 기능을 제공하는 컨트랙트를 갖고 있습니다.
파사드는 클래스 생성자에서 별도로 주입받을 필요가 없지만, 컨트랙트는 클래스의 명시적인 의존성을 정의할 수 있도록 해줍니다. 일부 개발자는 의존성을 명확히 정의하는 방식을 선호하여 컨트랙트를 더 선호하는 반면, 다른 개발자는 파사드의 간편함을 더 선호합니다. 일반적으로 대부분의 애플리케이션은 개발 과정에서 파사드를 문제 없이 사용할 수 있습니다.
컨트랙트를 언제 사용하나요? (When to Use Contracts)
컨트랙트를 사용할지, 파사드를 사용할지 결정하는 것은 개인의 취향과 개발 팀의 상황에 달려 있습니다. 컨트랙트와 파사드는 모두 견고하고 테스트하기 좋은 Laravel 애플리케이션을 만드는 데 사용할 수 있습니다. 두 방식은 상호 배타적이지 않습니다. 애플리케이션의 일부는 파사드를 사용하고, 다른 일부는 컨트랙트를 의존할 수 있습니다. 클래스의 책임이 명확히 분리되어 있다면, 컨트랙트와 파사드를 사용하는 것 간에 실제적으로 큰 차이를 느끼기 어렵습니다.
일반적으로 대다수 애플리케이션은 개발하는 동안 파사드를 문제 없이 사용할 수 있습니다. 만약 여러 PHP 프레임워크와 통합하는 패키지를 개발한다면, illuminate/contracts 패키지를 사용하여 Laravel 서비스와의 통합을 정의하는 것이 좋습니다. 이렇게 하면 패키지의 composer.json에 Laravel의 구체적인 구현체를 꼭 명시하지 않아도 됩니다.
컨트랙트 사용 방법 (How to Use Contracts)
그렇다면 컨트랙트의 구현체를 어떻게 획득할 수 있을까요? 사실 매우 간단합니다.
Laravel에서는 컨트롤러, 이벤트 리스너, 미들웨어, 큐 작업, 라우트 클로저 등 다양한 유형의 클래스가 서비스 컨테이너를 통해 해석(resolved)됩니다. 따라서 컨트랙트 구현체를 얻으려면, 해당 클래스 생성자의 인수 타입 힌트로 인터페이스를 지정하면 됩니다.
예를 들어, 다음의 이벤트 리스너를 살펴보세요:
<?php
namespace App\Listeners;
use App\Events\OrderWasPlaced;
use App\Models\User;
use Illuminate\Contracts\Redis\Factory;
class CacheOrderInformation
{
/**
* Create the event listener.
*/
public function __construct(
protected Factory $redis,
) {}
/**
* Handle the event.
*/
public function handle(OrderWasPlaced $event): void
{
// ...
}
}
이 이벤트 리스너가 해석될 때, 서비스 컨테이너는 클래스 생성자의 타입 힌트를 읽어 알맞은 값을 자동으로 주입합니다. 서비스 컨테이너에 등록하는 방법에 대해 더 알고 싶다면, 관련 문서를 참고하세요.
컨트랙트 참고 자료 (Contract Reference)
아래 표는 Laravel의 모든 컨트랙트와 대응하는 파사드를 빠르게 참고할 수 있도록 정리한 것입니다: