패키지 개발

번역일: 2026년 6월 20일

패키지 개발

소개
- 파사드 사용 시 주의사항
패키지 자동 감지
서비스 프로바이더
리소스
커맨드
퍼블릭 에셋
파일 그룹 퍼블리싱

소개

패키지는 Laravel에 기능을 추가하는 가장 핵심적인 방법입니다. 날짜 처리를 편리하게 해주는 Carbon, Eloquent 모델에 파일을 연결해주는 Spatie의 Laravel Media Library 등이 대표적인 예입니다.

패키지는 크게 두 가지 종류로 나뉩니다.

독립형 패키지: 특정 프레임워크에 종속되지 않고 어떤 PHP 프로젝트에서도 사용할 수 있습니다. Carbon, PHPUnit 등이 이에 해당하며, composer.json에 추가하는 것만으로 Laravel에서도 바로 사용할 수 있습니다.
Laravel 전용 패키지: 라우트, 컨트롤러, 뷰, 설정 파일 등 Laravel 애플리케이션에 특화된 기능을 제공합니다.

이 문서는 주로 Laravel 전용 패키지를 개발하는 방법을 다룹니다.

파사드 사용 시 주의사항

Laravel 애플리케이션을 직접 작성할 때는 컨트랙트(Contracts)와 파사드(Facades) 중 어느 것을 사용해도 테스트 가능성 면에서 큰 차이가 없습니다. 그러나 패키지를 개발할 때는 Laravel의 테스트 헬퍼에 접근할 수 없는 경우가 많습니다.

패키지 테스트를 일반 Laravel 애플리케이션에 설치된 것처럼 작성하고 싶다면 Orchestral Testbench 패키지를 활용하세요.

패키지 자동 감지

Laravel 애플리케이션의 config/app.php 파일에는 로드할 서비스 프로바이더 목록을 정의하는 providers 옵션이 있습니다. 패키지를 배포할 때 사용자가 이 목록에 서비스 프로바이더를 직접 추가하지 않아도 되도록, 패키지의 composer.json 파일 extra 섹션에 프로바이더와 파사드를 선언할 수 있습니다.

"extra": {
    "laravel": {
        "providers": [
            "Barryvdh\\Debugbar\\ServiceProvider"
        ],
        "aliases": {
            "Debugbar": "Barryvdh\\Debugbar\\Facade"
        }
    }
},

이렇게 설정해두면 사용자가 패키지를 설치하는 것만으로 서비스 프로바이더와 파사드가 자동으로 등록됩니다.

패키지 자동 감지 비활성화

패키지 사용자 입장에서 특정 패키지의 자동 감지를 비활성화하고 싶다면, 애플리케이션의 composer.json 파일 extra 섹션에 해당 패키지를 명시하면 됩니다.

"extra": {
    "laravel": {
        "dont-discover": [
            "barryvdh/laravel-debugbar"
        ]
    }
},

모든 패키지의 자동 감지를 비활성화하려면 * 문자를 사용합니다.

"extra": {
    "laravel": {
        "dont-discover": [
            "*"
        ]
    }
},

서비스 프로바이더

서비스 프로바이더는 패키지와 Laravel을 연결하는 핵심 진입점입니다. 서비스 프로바이더는 서비스 컨테이너에 필요한 항목을 바인딩하고, 뷰·설정·언어 파일 같은 패키지 리소스를 어디서 로드할지 Laravel에 알려주는 역할을 합니다.

서비스 프로바이더는 Illuminate\Support\ServiceProvider 클래스를 상속하며 register와 boot 두 메서드를 포함합니다. 기반 클래스는 illuminate/support Composer 패키지에 포함되어 있으므로, 패키지의 의존성에 추가해야 합니다. 서비스 프로바이더의 구조와 목적에 대한 자세한 내용은 관련 문서를 참고하세요.

리소스

설정

패키지의 설정 파일을 애플리케이션의 config 디렉터리에 퍼블리시하면, 사용자가 기본값을 손쉽게 재정의할 수 있습니다. 서비스 프로바이더의 boot 메서드에서 publishes 메서드를 호출해 설정 파일을 퍼블리시 가능하게 만드세요.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->publishes([
        __DIR__.'/../config/courier.php' => config_path('courier.php'),
    ]);
}

이제 사용자가 vendor:publish 커맨드를 실행하면 설정 파일이 지정된 위치로 복사됩니다. 퍼블리시된 설정 파일은 다른 설정 파일과 동일하게 접근할 수 있습니다.

$value = config('courier.option');

WARNING

설정 파일에 클로저(익명 함수)를 정의하지 마세요. 사용자가 config:cache Artisan 커맨드를 실행할 때 올바르게 직렬화되지 않습니다.

기본 패키지 설정 병합

패키지 설정 파일을 사용자가 퍼블리시한 설정 파일과 병합하도록 설정할 수도 있습니다. 이렇게 하면 사용자는 변경하고 싶은 옵션만 퍼블리시된 파일에 정의하면 됩니다. 설정 병합은 서비스 프로바이더의 register 메서드에서 mergeConfigFrom 메서드를 사용합니다.

첫 번째 인수로 패키지 설정 파일의 경로를, 두 번째 인수로 애플리케이션 설정 파일의 이름을 전달합니다.

/**
 * 애플리케이션 서비스를 등록합니다.
 */
public function register(): void
{
    $this->mergeConfigFrom(
        __DIR__.'/../config/courier.php', 'courier'
    );
}

WARNING

이 메서드는 설정 배열의 최상위 레벨만 병합합니다. 사용자가 다차원 배열의 일부만 정의하면, 누락된 하위 옵션은 자동으로 병합되지 않습니다.

라우트

패키지에 라우트가 포함되어 있다면 loadRoutesFrom 메서드로 로드할 수 있습니다. 이 메서드는 애플리케이션의 라우트가 캐시되어 있는지 자동으로 확인하고, 이미 캐시된 경우에는 라우트 파일을 다시 로드하지 않습니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadRoutesFrom(__DIR__.'/../routes/web.php');
}

마이그레이션

패키지에 데이터베이스 마이그레이션이 포함된 경우, loadMigrationsFrom 메서드로 마이그레이션 경로를 Laravel에 알릴 수 있습니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
}

마이그레이션이 등록되면 php artisan migrate 커맨드를 실행할 때 자동으로 함께 실행됩니다. 애플리케이션의 database/migrations 디렉터리에 별도로 복사할 필요가 없습니다.

언어 파일

패키지에 언어 파일이 포함된 경우, loadTranslationsFrom 메서드로 로드 경로를 지정합니다. 예를 들어 패키지 이름이 courier라면 서비스 프로바이더의 boot 메서드에 다음과 같이 추가합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadTranslationsFrom(__DIR__.'/../lang', 'courier');
}

패키지 번역 문자열은 패키지명::파일명.키 형식으로 참조합니다. 예를 들어 courier 패키지의 messages 파일에서 welcome 키를 불러오려면 다음과 같이 작성합니다.

echo trans('courier::messages.welcome');

JSON 형식의 번역 파일은 loadJsonTranslationsFrom 메서드로 등록합니다. 이 메서드에는 JSON 번역 파일이 들어 있는 디렉터리 경로를 전달합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadJsonTranslationsFrom(__DIR__.'/../lang');
}

언어 파일 퍼블리싱

패키지의 언어 파일을 애플리케이션의 lang/vendor 디렉터리에 퍼블리시하려면 서비스 프로바이더의 publishes 메서드를 사용합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadTranslationsFrom(__DIR__.'/../lang', 'courier');

    $this->publishes([
        __DIR__.'/../lang' => $this->app->langPath('vendor/courier'),
    ]);
}

사용자가 vendor:publish Artisan 커맨드를 실행하면 언어 파일이 지정된 위치로 복사됩니다.

뷰

패키지의 뷰를 Laravel에 등록하려면 뷰 파일의 위치를 알려줘야 합니다. 서비스 프로바이더의 loadViewsFrom 메서드를 사용하며, 첫 번째 인수로 뷰 템플릿 경로, 두 번째 인수로 패키지 이름을 전달합니다. 패키지 이름이 courier라면 다음과 같이 작성합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadViewsFrom(__DIR__.'/../resources/views', 'courier');
}

패키지 뷰는 패키지명::뷰명 형식으로 참조합니다. 예를 들어 courier 패키지의 dashboard 뷰는 다음과 같이 사용합니다.

Route::get('/dashboard', function () {
    return view('courier::dashboard');
});

패키지 뷰 재정의

loadViewsFrom을 사용하면 Laravel은 두 위치에서 뷰를 탐색합니다.

애플리케이션의 resources/views/vendor/{패키지명} 디렉터리
loadViewsFrom에 지정한 패키지 디렉터리

즉, Laravel은 먼저 resources/views/vendor/courier 디렉터리에 커스텀 뷰가 있는지 확인하고, 없으면 패키지 내 뷰 디렉터리에서 찾습니다. 이 방식 덕분에 패키지 사용자는 패키지 뷰를 손쉽게 커스터마이즈할 수 있습니다.

뷰 퍼블리싱

패키지 뷰를 애플리케이션의 resources/views/vendor 디렉터리에 퍼블리시하려면 서비스 프로바이더의 publishes 메서드를 사용합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->loadViewsFrom(__DIR__.'/../resources/views', 'courier');

    $this->publishes([
        __DIR__.'/../resources/views' => resource_path('views/vendor/courier'),
    ]);
}

사용자가 vendor:publish Artisan 커맨드를 실행하면 패키지 뷰가 지정된 위치로 복사됩니다.

뷰 컴포넌트

Blade 컴포넌트를 포함하는 패키지를 개발하거나, 컴포넌트를 일반적이지 않은 디렉터리에 배치하는 경우, 컴포넌트 클래스와 HTML 태그 별칭을 수동으로 등록해야 합니다. 일반적으로 패키지 서비스 프로바이더의 boot 메서드에서 등록합니다.

use Illuminate\Support\Facades\Blade;
use VendorPackage\View\Components\AlertComponent;

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    Blade::component('package-alert', AlertComponent::class);
}

컴포넌트를 등록하면 태그 별칭으로 렌더링할 수 있습니다.

<x-package-alert/>

패키지 컴포넌트 자동 로드

componentNamespace 메서드를 사용하면 네임스페이스 규칙에 따라 컴포넌트 클래스를 자동으로 로드할 수 있습니다. 예를 들어 Nightshade 패키지에 Nightshade\Views\Components 네임스페이스 아래 Calendar와 ColorPicker 컴포넌트가 있다면 다음과 같이 등록합니다.

use Illuminate\Support\Facades\Blade;

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    Blade::componentNamespace('Nightshade\\Views\\Components', 'nightshade');
}

이렇게 하면 패키지명:: 형식으로 패키지 컴포넌트를 사용할 수 있습니다.

<x-nightshade::calendar />
<x-nightshade::color-picker />

Blade는 컴포넌트 이름을 PascalCase로 변환해 대응하는 클래스를 자동으로 찾습니다. 하위 디렉터리는 점(.) 표기법으로 지원됩니다.

익명 컴포넌트

패키지에 익명 컴포넌트가 포함된 경우, loadViewsFrom 메서드에서 지정한 뷰 디렉터리 안의 components 디렉터리에 배치해야 합니다. 렌더링 시에는 패키지 뷰 네임스페이스를 컴포넌트 이름 앞에 붙입니다.

<x-courier::alert />

"About" Artisan 커맨드

Laravel 내장 about Artisan 커맨드는 애플리케이션의 환경 및 설정 요약 정보를 출력합니다. 패키지에서 AboutCommand 클래스를 통해 이 출력에 추가 정보를 포함시킬 수 있습니다. 일반적으로 서비스 프로바이더의 boot 메서드에서 등록합니다.

use Illuminate\Foundation\Console\AboutCommand;

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    AboutCommand::add('My Package', fn () => ['Version' => '1.0.0']);
}

커맨드

패키지의 Artisan 커맨드를 Laravel에 등록하려면 commands 메서드를 사용합니다. 이 메서드는 커맨드 클래스 이름의 배열을 인수로 받습니다. 등록 후에는 Artisan CLI를 통해 커맨드를 실행할 수 있습니다.

use Courier\Console\Commands\InstallCommand;
use Courier\Console\Commands\NetworkCommand;

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    if ($this->app->runningInConsole()) {
        $this->commands([
            InstallCommand::class,
            NetworkCommand::class,
        ]);
    }
}

퍼블릭 에셋

패키지에 JavaScript, CSS, 이미지 등의 에셋이 포함된 경우, 서비스 프로바이더의 publishes 메서드로 애플리케이션의 public 디렉터리에 퍼블리시할 수 있습니다. 아래 예시에서는 관련 에셋을 묶어 퍼블리시할 때 편리하게 사용할 수 있도록 public 에셋 그룹 태그도 함께 지정합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->publishes([
        __DIR__.'/../public' => public_path('vendor/courier'),
    ], 'public');
}

사용자가 vendor:publish 커맨드를 실행하면 에셋이 지정된 위치로 복사됩니다. 패키지 업데이트 시마다 에셋을 덮어써야 하는 경우가 많으므로 --force 플래그를 함께 사용하도록 안내하세요.

php artisan vendor:publish --tag=public --force

파일 그룹 퍼블리싱

패키지의 에셋과 리소스를 그룹별로 따로 퍼블리시하고 싶을 때가 있습니다. 예를 들어 에셋은 퍼블리시하지 않고 설정 파일만 퍼블리시하도록 허용하고 싶을 수 있습니다. publishes 메서드를 호출할 때 태그를 지정하면 그룹을 구분할 수 있습니다.

아래 예시는 courier 패키지의 boot 메서드에서 courier-config와 courier-migrations 두 개의 퍼블리시 그룹을 정의합니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    $this->publishes([
        __DIR__.'/../config/package.php' => config_path('package.php')
    ], 'courier-config');

    $this->publishes([
        __DIR__.'/../database/migrations/' => database_path('migrations')
    ], 'courier-migrations');
}

이제 사용자는 vendor:publish 커맨드에 태그를 지정해 원하는 그룹만 퍼블리시할 수 있습니다.

php artisan vendor:publish --tag=courier-config