패키지 개발

번역일: 2026년 6월 21일

패키지 개발

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

소개

패키지는 Laravel에 기능을 추가하는 가장 일반적인 방법입니다. 날짜 처리를 도와주는 Carbon처럼 범용적인 라이브러리일 수도 있고, Spatie의 Laravel Media Library처럼 Eloquent 모델에 파일을 연결해주는 Laravel 전용 패키지일 수도 있습니다.

패키지는 크게 두 종류로 나뉩니다. 첫 번째는 독립형 패키지로, 특정 프레임워크에 의존하지 않고 어떤 PHP 프로젝트에서도 사용할 수 있습니다. Carbon이나 Pest가 대표적입니다. 이런 패키지는 composer.json에 추가하기만 하면 Laravel에서도 사용할 수 있습니다.

두 번째는 Laravel 전용 패키지로, 라우트, 컨트롤러, 뷰, 설정 파일 등 Laravel 애플리케이션을 확장하기 위한 요소들을 포함합니다. 이 가이드는 주로 이런 Laravel 전용 패키지를 개발하는 방법을 다룹니다.

Facade 사용 시 주의사항

일반적인 Laravel 애플리케이션을 개발할 때는 Contract와 Facade 중 어느 것을 사용해도 테스트 용이성 면에서 큰 차이가 없습니다. 하지만 패키지를 개발할 때는 상황이 다릅니다. 패키지 테스트 환경에서는 Laravel의 테스트 헬퍼를 모두 사용하지 못할 수 있습니다.

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

패키지 자동 감지

Laravel 애플리케이션의 bootstrap/providers.php 파일에는 로드할 서비스 프로바이더 목록이 정의되어 있습니다. 그런데 패키지 사용자가 직접 이 파일을 수정하도록 요구하는 대신, 패키지의 composer.json 파일 extra 섹션에 서비스 프로바이더를 선언해두면 Laravel이 패키지 설치 시 자동으로 등록합니다. 서비스 프로바이더 외에도 Facade를 함께 등록할 수 있습니다.

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

자동 감지가 설정된 패키지는 composer require로 설치하는 것만으로 서비스 프로바이더와 Facade가 자동으로 등록되어, 사용자에게 편리한 설치 경험을 제공합니다.

패키지 자동 감지 비활성화

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

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

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

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

서비스 프로바이더

서비스 프로바이더는 패키지와 Laravel 사이의 연결 고리입니다. 서비스 프로바이더는 Laravel의 서비스 컨테이너에 바인딩을 등록하고, 뷰·설정 파일·언어 파일 등 패키지 리소스의 위치를 Laravel에 알립니다.

서비스 프로바이더는 Illuminate\Support\ServiceProvider 클래스를 상속하며, register와 boot 두 메서드를 포함합니다. 기반 클래스인 ServiceProvider는 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 메서드를 사용하세요.

mergeConfigFrom의 첫 번째 인수는 패키지 설정 파일 경로이고, 두 번째 인수는 애플리케이션 설정의 키 이름입니다.

/**
 * 패키지 서비스를 등록합니다.
 */
public function register(): void
{
    $this->mergeConfigFrom(
        __DIR__.'/../config/courier.php', 'courier'
    );
}

WARNING

이 메서드는 설정 배열의 1단계 깊이만 병합합니다. 사용자가 다차원 배열의 일부만 정의한 경우, 정의되지 않은 나머지 옵션은 병합되지 않습니다.

라우트

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

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

마이그레이션

패키지에 데이터베이스 마이그레이션이 포함된 경우, publishesMigrations 메서드를 사용해 해당 디렉터리 또는 파일이 마이그레이션을 포함하고 있음을 Laravel에 알릴 수 있습니다. 마이그레이션이 퍼블리싱될 때 Laravel은 파일명의 타임스탬프를 현재 날짜와 시간으로 자동 갱신합니다.

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

언어 파일

패키지에 언어 파일이 포함된 경우, loadTranslationsFrom 메서드로 Laravel에 로드 방법을 알립니다. 예를 들어 패키지 이름이 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에 지정한 패키지 뷰 디렉터리를 탐색합니다.

예를 들어 courier 패키지의 경우, 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는 컴포넌트 이름을 파스칼 케이스로 변환해 클래스를 자동으로 찾습니다. "점(dot)" 표기법을 사용한 하위 디렉터리도 지원합니다.

익명 컴포넌트

패키지에 익명 컴포넌트가 포함된 경우, 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,
        ]);
    }
}

Optimize 커맨드

Laravel의 optimize 커맨드는 애플리케이션의 설정, 이벤트, 라우트, 뷰를 캐시합니다. optimizes 메서드를 사용하면 optimize 및 optimize:clear 커맨드 실행 시 함께 호출될 패키지 전용 Artisan 커맨드를 등록할 수 있습니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    if ($this->app->runningInConsole()) {
        $this->optimizes(
            optimize: 'package:optimize',
            clear: 'package:clear-optimizations',
        );
    }
}

Reload 커맨드

Laravel의 reload 커맨드는 실행 중인 서비스를 종료하여 프로세스 모니터가 자동으로 재시작할 수 있도록 합니다. reloads 메서드를 사용하면 reload 커맨드 실행 시 함께 호출될 패키지 전용 Artisan 커맨드를 등록할 수 있습니다.

/**
 * 패키지 서비스를 부트스트랩합니다.
 */
public function boot(): void
{
    if ($this->app->runningInConsole()) {
        $this->reloads('package:reload');
    }
}

공개 에셋

패키지에 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->publishesMigrations([
        __DIR__.'/../database/migrations/' => database_path('migrations')
    ], 'courier-migrations');
}

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

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

또한 --provider 플래그를 사용하면 해당 서비스 프로바이더에 정의된 모든 퍼블리싱 파일을 한 번에 퍼블리싱할 수 있습니다.

php artisan vendor:publish --provider="Your\Package\ServiceProvider"