파사드(Facades)
소개
Laravel 공식 문서 전반에서, "파사드"를 통해 Laravel의 기능과 상호작용하는 코드 예제를 자주 볼 수 있습니다. 파사드는 애플리케이션의 서비스 컨테이너에서 제공되는 클래스에 "정적" 인터페이스를 제공합니다. Laravel은 거의 모든 기능에 접근할 수 있는 다양한 파사드를 기본적으로 제공합니다.
Laravel 파사드는 서비스 컨테이너 내의 실제 클래스에 대한 "정적 프록시" 역할을 하며, 전통적인 정적 메서드보다 더 높은 테스트 용이성과 유연성을 유지하면서도 간결하고 표현력 있는 문법을 제공합니다. 파사드가 어떻게 동작하는지 완전히 이해하지 못해도 괜찮으니, 일단 흐름을 따라가며 Laravel을 계속 학습해도 무방합니다.
Laravel의 모든 파사드는 Illuminate\Support\Facades 네임스페이스에 정의되어 있습니다. 따라서 아래와 같이 파사드에 쉽게 접근할 수 있습니다:
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Route;
Route::get('/cache', function () {
return Cache::get('key');
});Laravel 공식 문서 전반에서 다양한 프레임워크 기능을 설명할 때 파사드가 자주 사용됩니다.
헬퍼 함수
파사드를 보완하기 위해, Laravel은 일반적인 기능을 더욱 쉽게 사용할 수 있도록 다양한 전역 "헬퍼 함수"도 제공합니다. 자주 사용되는 헬퍼 함수로는 view, response, url, config 등이 있습니다. 각 헬퍼 함수는 해당 기능의 문서에서 설명되어 있지만, 전체 목록은 별도의 헬퍼 문서에서 확인할 수 있습니다.
예를 들어, JSON 응답을 생성할 때 Illuminate\Support\Facades\Response 파사드 대신 response 함수를 사용할 수 있습니다. 헬퍼 함수는 전역적으로 사용할 수 있으므로, 별도의 클래스를 import하지 않아도 됩니다:
use Illuminate\Support\Facades\Response;
Route::get('/users', function () {
return Response::json([
// ...
]);
});
Route::get('/users', function () {
return response()->json([
// ...
]);
});파사드를 언제 사용할 것인가
파사드는 여러 가지 장점이 있습니다. 간결하고 기억하기 쉬운 문법을 제공하여, 복잡한 클래스명을 기억하거나 직접 주입하거나 수동으로 설정할 필요 없이 Laravel의 기능을 사용할 수 있습니다. 또한, PHP의 동적 메서드 사용 덕분에 테스트도 용이합니다.
하지만 파사드를 사용할 때 주의해야 할 점도 있습니다. 가장 큰 위험은 클래스의 "스코프 크리프(scope creep)"입니다. 파사드는 사용이 매우 쉽고 주입이 필요 없기 때문에, 한 클래스에서 너무 많은 파사드를 사용하게 되어 클래스가 점점 커질 수 있습니다. 의존성 주입을 사용할 경우, 생성자가 커지면서 클래스가 너무 커졌다는 시각적 피드백을 받을 수 있지만, 파사드는 그렇지 않습니다. 따라서 파사드를 사용할 때는 클래스의 크기에 특별히 주의하여, 책임 범위가 좁게 유지되도록 해야 합니다. 만약 클래스가 너무 커진다면, 여러 개의 작은 클래스로 분리하는 것을 고려하세요.
파사드 vs. 의존성 주입
의존성 주입의 주요 장점 중 하나는 주입된 클래스의 구현을 쉽게 교체할 수 있다는 점입니다. 이는 테스트 시에 특히 유용한데, 모의(mock) 객체나 스텁(stub)을 주입하여 해당 메서드가 호출되었는지 검증할 수 있기 때문입니다.
일반적으로, 진짜 정적 클래스 메서드는 모킹이나 스텁이 불가능합니다. 하지만 파사드는 동적 메서드를 사용하여 서비스 컨테이너에서 객체를 가져와 메서드 호출을 프록시하기 때문에, 주입된 클래스 인스턴스를 테스트하는 것과 동일하게 파사드도 테스트할 수 있습니다. 예를 들어, 아래와 같은 라우트가 있다고 가정해봅시다:
use Illuminate\Support\Facades\Cache;
Route::get('/cache', function () {
return Cache::get('key');
});Laravel의 파사드 테스트 메서드를 사용하면, 아래와 같이 Cache::get 메서드가 기대한 인자로 호출되었는지 검증하는 테스트를 작성할 수 있습니다:
use Illuminate\Support\Facades\Cache;
test('basic example', function () {
Cache::shouldReceive('get')
->with('key')
->andReturn('value');
$response = $this->get('/cache');
$response->assertSee('value');
});use Illuminate\Support\Facades\Cache;
/**
* A basic functional test example.
*/
public function test_basic_example(): void
{
Cache::shouldReceive('get')
->with('key')
->andReturn('value');
$response = $this->get('/cache');
$response->assertSee('value');
}파사드 vs. 헬퍼 함수
파사드 외에도, Laravel은 뷰 생성, 이벤트 발생, 작업 디스패치, HTTP 응답 전송 등 다양한 일반 작업을 수행할 수 있는 "헬퍼" 함수들을 제공합니다. 이들 헬퍼 함수 중 상당수는 해당 파사드와 동일한 기능을 수행합니다. 예를 들어, 아래의 파사드 호출과 헬퍼 함수 호출은 동일합니다:
return Illuminate\Support\Facades\View::make('profile');
return view('profile');파사드와 헬퍼 함수 사이에는 실질적인 차이가 전혀 없습니다. 헬퍼 함수를 사용할 때도, 해당 파사드와 동일하게 테스트할 수 있습니다. 예를 들어, 아래와 같은 라우트가 있다고 가정해봅시다:
Route::get('/cache', function () {
return cache('key');
});cache 헬퍼는 내부적으로 Cache 파사드의 기반 클래스의 get 메서드를 호출합니다. 따라서 헬퍼 함수를 사용하더라도, 아래와 같이 해당 메서드가 기대한 인자로 호출되었는지 검증하는 테스트를 작성할 수 있습니다:
use Illuminate\Support\Facades\Cache;
/**
* A basic functional test example.
*/
public function test_basic_example(): void
{
Cache::shouldReceive('get')
->with('key')
->andReturn('value');
$response = $this->get('/cache');
$response->assertSee('value');
}파사드는 어떻게 동작하는가
Laravel 애플리케이션에서 파사드는 컨테이너의 객체에 접근할 수 있도록 해주는 클래스입니다. 이 동작을 가능하게 하는 핵심은 Facade 클래스에 있습니다. Laravel의 파사드와 여러분이 직접 만드는 커스텀 파사드는 모두 기본 Illuminate\Support\Facades\Facade 클래스를 확장합니다.
Facade 기본 클래스는 __callStatic() 매직 메서드를 활용하여, 파사드에서의 호출을 컨테이너에서 가져온 객체로 위임합니다. 아래 예제에서는 Laravel 캐시 시스템에 호출을 하고 있습니다. 이 코드를 보면, 마치 Cache 클래스의 정적 get 메서드를 호출하는 것처럼 보일 수 있습니다:
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Cache;
use Illuminate\View\View;
class UserController extends Controller
{
/**
* Show the profile for the given user.
*/
public function showProfile(string $id): View
{
$user = Cache::get('user:'.$id);
return view('profile', ['user' => $user]);
}
}파일 상단에서 Cache 파사드를 "import"하고 있는 것을 볼 수 있습니다. 이 파사드는 Illuminate\Contracts\Cache\Factory 인터페이스의 실제 구현체에 접근할 수 있도록 프록시 역할을 합니다. 파사드를 통해 호출하는 모든 메서드는 Laravel의 캐시 서비스의 실제 인스턴스로 전달됩니다.
Illuminate\Support\Facades\Cache 클래스를 살펴보면, 정적 메서드 get이 정의되어 있지 않다는 것을 알 수 있습니다:
class Cache extends Facade
{
/**
* Get the registered name of the component.
*/
protected static function getFacadeAccessor(): string
{
return 'cache';
}
}대신, Cache 파사드는 기본 Facade 클래스를 확장하고, getFacadeAccessor() 메서드를 정의합니다. 이 메서드는 서비스 컨테이너 바인딩의 이름을 반환하는 역할을 합니다. 사용자가 Cache 파사드의 어떤 정적 메서드를 참조하면, Laravel은 서비스 컨테이너에서 cache 바인딩을 가져와 해당 객체에 요청된 메서드(이 경우 get)를 실행합니다.
실시간 파사드(Real-Time Facades)
실시간 파사드를 사용하면, 애플리케이션 내의 어떤 클래스든 파사드처럼 사용할 수 있습니다. 이를 어떻게 활용할 수 있는지 살펴보기 위해, 먼저 실시간 파사드를 사용하지 않는 코드를 살펴보겠습니다. 예를 들어, Podcast 모델에 publish 메서드가 있다고 가정해봅시다. 하지만 팟캐스트를 발행하려면 Publisher 인스턴스를 주입해야 합니다:
<?php
namespace App\Models;
use App\Contracts\Publisher;
use Illuminate\Database\Eloquent\Model;
class Podcast extends Model
{
/**
* Publish the podcast.
*/
public function publish(Publisher $publisher): void
{
$this->update(['publishing' => now()]);
$publisher->publish($this);
}
}메서드에 퍼블리셔 구현체를 주입하면, 주입된 퍼블리셔를 모킹하여 메서드를 독립적으로 쉽게 테스트할 수 있습니다. 하지만 이 방식은 publish 메서드를 호출할 때마다 항상 퍼블리셔 인스턴스를 전달해야 합니다. 실시간 파사드를 사용하면, 동일한 테스트 용이성을 유지하면서도 Publisher 인스턴스를 명시적으로 전달할 필요가 없습니다. 실시간 파사드를 생성하려면, import하는 클래스의 네임스페이스 앞에 Facades를 붙이면 됩니다:
<?php
namespace App\Models;
use App\Contracts\Publisher;
use Facades\App\Contracts\Publisher;
use Illuminate\Database\Eloquent\Model;
class Podcast extends Model
{
/**
* Publish the podcast.
*/
public function publish(Publisher $publisher): void
public function publish(): void
{
$this->update(['publishing' => now()]);
$publisher->publish($this);
Publisher::publish($this);
}
}실시간 파사드를 사용하면, Facades 접두사 뒤에 오는 인터페이스 또는 클래스 이름의 일부를 사용하여 서비스 컨테이너에서 퍼블리셔 구현체를 가져옵니다. 테스트 시에는 Laravel의 내장 파사드 테스트 헬퍼를 사용하여 이 메서드 호출을 모킹할 수 있습니다:
<?php
use App\Models\Podcast;
use Facades\App\Contracts\Publisher;
use Illuminate\Foundation\Testing\RefreshDatabase;
uses(RefreshDatabase::class);
test('podcast can be published', function () {
$podcast = Podcast::factory()->create();
Publisher::shouldReceive('publish')->once()->with($podcast);
$podcast->publish();
});<?php
namespace Tests\Feature;
use App\Models\Podcast;
use Facades\App\Contracts\Publisher;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;
class PodcastTest extends TestCase
{
use RefreshDatabase;
/**
* A test example.
*/
public function test_podcast_can_be_published(): void
{
$podcast = Podcast::factory()->create();
Publisher::shouldReceive('publish')->once()->with($podcast);
$podcast->publish();
}
}파사드 클래스 레퍼런스
아래는 모든 파사드와 그 기반 클래스 목록입니다. 이는 특정 파사드 루트의 API 문서를 빠르게 찾아볼 수 있는 유용한 도구입니다. 서비스 컨테이너 바인딩 키도 함께 표기되어 있습니다.