컨트랙트 (Contracts)
소개
라라벨의 "컨트랙트"는 프레임워크가 제공하는 핵심 서비스를 정의한 일련의 인터페이스입니다. 예를 들어, Illuminate\Contracts\Queue\Queue 컨트랙트는 작업을 큐에 넣을 때 필요한 메서드를 정의하며, Illuminate\Contracts\Mail\Mailer 컨트랙트는 이메일을 전송하는 데 필요한 메서드를 정의합니다.
각 컨트랙트마다 프레임워크에서 제공하는 구현체가 존재합니다. 예를 들어, 라라벨은 여러 종류의 드라이버를 지원하는 큐 구현체와 Symfony Mailer를 기반으로 하는 메일러 구현체를 제공합니다.
라라벨의 모든 컨트랙트는 별도의 GitHub 저장소에 위치하고 있습니다. 이 저장소는 사용 가능한 모든 컨트랙트를 빠르게 참조할 수 있는 곳이며, 라라벨 서비스와 상호작용하는 패키지를 만들 때 활용할 수 있는, 독립적인 패키지로 제공됩니다.
컨트랙트 vs. 파사드
라라벨의 파사드와 헬퍼 함수는 서비스 컨테이너에서 컨트랙트를 타입힌트하고 resolve(해결)하지 않아도 라라벨의 서비스를 간편하게 사용할 수 있게 해줍니다. 대부분의 경우, 각 파사드에는 이에 상응하는 컨트랙트가 존재합니다.
파사드는 클래스의 생성자에서 별도로 의존성을 선언하지 않아도 되지만, 컨트랙트는 클래스의 의존성을 명확하게 정의할 수 있게 해줍니다. 일부 개발자들은 이런 방식으로 명시적으로 의존성을 선언하는 것을 선호하여 컨트랙트 사용을 더 선호하고, 다른 개발자들은 파사드가 주는 편리함을 즐깁니다. 일반적으로, 대부분의 애플리케이션에서는 개발 과정에서 파사드만 사용해도 아무런 문제가 없습니다.
컨트랙트를 언제 사용할 것인가
컨트랙트와 파사드 중 무엇을 사용할지는 개인의 취향이나 개발팀의 선호에 따라 달라집니다. 두 방법 모두 견고하고, 테스트하기 쉬운 라라벨 애플리케이션을 만드는 데 사용할 수 있습니다. 컨트랙트와 파사드는 상호 배타적인 존재가 아닙니다. 애플리케이션의 일부는 파사드를, 다른 일부는 컨트랙트에 의존하게 만들 수도 있습니다. 클래스의 책임을 명확히 분리해서 유지한다면, 컨트랙트와 파사드 중 무엇을 사용하든 실제로 체감할 수 있는 차이는 거의 없습니다.
대부분의 경우, 개발 단계에서는 파사드만 사용해도 문제가 없습니다. 만약 여러 PHP 프레임워크와 통합되는 패키지를 개발하는 중이라면, 패키지의 composer.json 파일에 라라벨의 구체적 구현을 직접 의존시키지 않고 illuminate/contracts 패키지만으로 라라벨 서비스와 통합하는 인터페이스를 정의할 수 있습니다.
컨트랙트 사용하는 방법
컨트랙트의 구현체를 어떻게 받아낼 수 있을까요? 사실 매우 간단합니다.
라라벨에서는 컨트롤러, 이벤트 리스너, 미들웨어, 큐 작업, 그리고 라우트 클로저까지 다양한 종류의 클래스가 서비스 컨테이너로부터 resolve(해결)됩니다. 그래서, 컨트랙트의 구현체가 필요하다면 클래스의 생성자에서 해당 인터페이스를 "타입힌트" 하기만 하면 됩니다.
예를 들어, 아래와 같은 이벤트 리스너를 살펴보겠습니다.
<?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
{
// ...
}
}
이 이벤트 리스너가 resolve(해결)될 때, 서비스 컨테이너는 해당 클래스의 생성자 타입힌트를 읽어 적절한 값을 주입해줍니다. 서비스 컨테이너에 어떤 요소를 등록하는지 더 자세히 알고 싶다면 관련 문서를 참고하시기 바랍니다.
컨트랙트 레퍼런스
이 표는 모든 라라벨 컨트랙트와 이에 상응하는 파사드를 빠르게 참조할 수 있도록 제공합니다.