파일 저장소

번역일: 2026년 7월 2일

파일 저장소

소개
설정
디스크 인스턴스 가져오기
- 온디맨드 디스크
파일 조회
파일 저장
파일 삭제
디렉터리
테스트
커스텀 파일시스템

소개

Laravel은 Frank de Jonge가 만든 Flysystem 패키지를 기반으로 강력한 파일 저장소 추상화 레이어를 제공합니다. Flysystem 통합 덕분에 로컬 파일시스템, Amazon S3, SFTP 등 다양한 저장소 백엔드를 동일한 API로 다룰 수 있습니다. 개발 환경에서는 로컬 디스크를 사용하다가 운영 환경에서 S3로 전환할 때도 코드를 거의 수정할 필요가 없습니다.

설정

파일시스템 설정 파일은 config/filesystems.php입니다. 이 파일에서 각 파일시스템 **디스크(disk)**를 정의합니다. 디스크란 특정 저장소 드라이버와 저장 위치를 묶은 논리적 단위입니다. 설정 파일에는 지원되는 드라이버별 예시가 포함되어 있으니 참고하세요.

원하는 만큼 디스크를 정의할 수 있으며, 같은 드라이버를 사용하는 디스크를 여러 개 만들어도 됩니다. 예를 들어 S3 버킷을 용도별로 분리해 각각 별도의 디스크로 관리할 수 있습니다.

로컬 드라이버

local 드라이버를 사용할 때, 파일 경로는 filesystems.php의 root 옵션에 설정된 디렉터리를 기준으로 하는 상대 경로입니다. 기본값은 storage/app/private입니다. 예를 들어 아래 코드는 storage/app/private/example.txt 파일을 생성합니다.

Storage::disk('local')->put('example.txt', '내용');

퍼블릭 디스크

config/filesystems.php에는 public 디스크가 미리 정의되어 있습니다. 이 디스크는 외부에서 URL로 직접 접근 가능한 파일(예: 사용자 프로필 이미지, 공개 첨부 파일 등)을 저장하는 용도입니다.

public 디스크는 기본적으로 local 드라이버를 사용하며, 파일을 storage/app/public 디렉터리에 저장합니다. 웹에서 이 파일들에 접근하려면 public/storage가 storage/app/public을 가리키는 심볼릭 링크를 만들어야 합니다.

심볼릭 링크는 아래 Artisan 명령어로 생성합니다.

php artisan storage:link

파일을 저장하고 심볼릭 링크를 생성했다면, asset 헬퍼로 파일의 URL을 생성할 수 있습니다.

echo asset('storage/파일명.jpg');

filesystems.php의 links 옵션에 심볼릭 링크를 추가로 정의할 수도 있습니다.

'links' => [
    public_path('storage') => storage_path('app/public'),
    public_path('images')  => storage_path('app/images'),
],

storage:link 명령어는 이 설정을 모두 읽어 심볼릭 링크를 생성합니다. 반대로 생성된 심볼릭 링크를 모두 제거하려면 storage:unlink 명령어를 사용합니다.

php artisan storage:unlink

드라이버 사전 준비

S3 드라이버 설정

S3 드라이버를 사용하려면 Composer로 Flysystem S3 패키지를 설치해야 합니다.

composer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependencies

S3 디스크 설정은 config/filesystems.php의 s3 항목에서 합니다. 이 파일에는 예시 설정이 이미 포함되어 있습니다. 일반적으로 민감한 인증 정보는 아래 환경 변수로 관리합니다.

AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=
AWS_BUCKET=
AWS_USE_PATH_STYLE_ENDPOINT=false

편의를 위해 이 환경 변수 이름은 AWS CLI 규칙과 동일합니다.

FTP 드라이버 설정

FTP 드라이버를 사용하려면 아래 패키지를 설치합니다.

composer require league/flysystem-ftp "^3.0"

Laravel의 기본 설정 파일에는 FTP 예시가 없지만, 아래와 같이 직접 추가할 수 있습니다.

'ftp' => [
    'driver'   => 'ftp',
    'host'     => env('FTP_HOST'),
    'username' => env('FTP_USERNAME'),
    'password' => env('FTP_PASSWORD'),

    // 선택적 FTP 설정
    // 'port'     => env('FTP_PORT', 21),
    // 'root'     => env('FTP_ROOT'),
    // 'passive'  => true,
    // 'ssl'      => true,
    // 'timeout'  => 30,
],

SFTP 드라이버 설정

SFTP 드라이버를 사용하려면 아래 패키지를 설치합니다.

composer require league/flysystem-sftp-v3 "^3.0"

마찬가지로 config/filesystems.php에 직접 디스크를 추가합니다.

'sftp' => [
    'driver'   => 'sftp',
    'host'     => env('SFTP_HOST'),

    // 비밀번호 인증
    'username' => env('SFTP_USERNAME'),
    'password' => env('SFTP_PASSWORD'),

    // SSH 키 기반 인증 (선택)
    // 'privateKey' => env('SFTP_PRIVATE_KEY'),
    // 'passphrase' => env('SFTP_PASSPHRASE'),

    // 파일/디렉터리 권한 설정 (선택)
    // 'visibility'           => 'private', // `private` = 0600, `public` = 0644
    // 'directory_visibility' => 'private', // `private` = 0700, `public` = 0755

    // 선택적 SFTP 설정
    // 'hostFingerprint'  => env('SFTP_HOST_FINGERPRINT'),
    // 'maxTries'         => 4,
    // 'passphrase'       => env('SFTP_PASSPHRASE'),
    // 'port'             => env('SFTP_PORT', 22),
    // 'root'             => env('SFTP_ROOT', ''),
    // 'timeout'          => 30,
    // 'useAgent'         => true,
],

범위 지정 및 읽기 전용 파일시스템

**범위 지정 디스크(Scoped Disk)**를 사용하면 기존 디스크에 경로 접두사(prefix)를 붙인 새 디스크를 정의할 수 있습니다. 이 기능은 scoped 드라이버로 제공됩니다.

예를 들어 기존 s3 디스크에서 특정 버킷 경로(path/to/uploads)만 다루는 디스크를 만들고 싶다면:

's3-uploads' => [
    'driver' => 'scoped',
    'disk'   => 's3',
    'prefix' => 'path/to/uploads',
],

이제 s3-uploads 디스크에서 파일을 다루면 자동으로 path/to/uploads/ 경로가 앞에 붙습니다.

**읽기 전용 디스크(Read-Only Disk)**는 쓰기 작업을 차단해야 할 때 유용합니다. read-only 옵션을 true로 설정합니다.

's3-읽기전용' => [
    'driver'    => 's3',
    'read-only' => true,
    // ... 기타 S3 설정
],

Amazon S3 호환 파일시스템

AWS S3 외에도 S3 호환 API를 제공하는 객체 스토리지 서비스들이 있습니다. 대표적으로 MinIO나 네이버 클라우드의 Object Storage, KT Cloud Storage 등이 있습니다. 이러한 서비스는 endpoint 옵션을 지정해 S3 드라이버 그대로 사용할 수 있습니다.

's3' => [
    'driver'                  => 's3',
    'key'                     => env('AWS_ACCESS_KEY_ID'),
    'secret'                  => env('AWS_SECRET_ACCESS_KEY'),
    'region'                  => env('AWS_DEFAULT_REGION'),
    'bucket'                  => env('AWS_BUCKET'),
    'url'                     => env('AWS_URL'),
    'endpoint'                => env('AWS_ENDPOINT'),
    'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
],

NOTE

MinIO처럼 path-style URL을 사용하는 서비스는 use_path_style_endpoint를 true로 설정해야 합니다.

디스크 인스턴스 가져오기

Storage 파사드를 사용해 설정된 디스크와 상호작용할 수 있습니다. 예를 들어 기본 디스크에 파일을 저장하려면 put 메서드를 호출합니다.

use Illuminate\Support\Facades\Storage;

Storage::put('avatars/1', $fileContents);

여러 디스크를 사용하는 경우, disk 메서드로 특정 디스크를 지정할 수 있습니다.

Storage::disk('s3')->put('avatars/1', $fileContents);

온디맨드 디스크

설정 파일에 미리 정의하지 않고, 런타임에 특정 설정으로 디스크를 즉석에서 만들고 싶을 때는 Storage::build 메서드를 사용합니다.

use Illuminate\Support\Facades\Storage;

$disk = Storage::build([
    'driver' => 'local',
    'root'   => '/path/to/root',
]);

$disk->put('image.jpg', $content);

파일 조회

get 메서드로 파일 내용을 문자열로 가져올 수 있습니다. 파일이 존재하지 않으면 null을 반환합니다.

$contents = Storage::get('file.jpg');

파일이 JSON 형식이라면 json 메서드로 바로 파싱할 수 있습니다.

$orders = Storage::json('orders.json');

파일 존재 여부는 exists 메서드로 확인합니다.

if (Storage::disk('s3')->exists('photo.jpg')) {
    // ...
}

파일이 없는지 확인하려면 missing 메서드를 사용합니다.

if (Storage::disk('s3')->missing('photo.jpg')) {
    // ...
}

파일 다운로드

download 메서드는 브라우저가 해당 파일을 다운로드하도록 강제하는 응답을 반환합니다. 두 번째 인수로 다운로드 파일명, 세 번째 인수로 HTTP 헤더 배열을 지정할 수 있습니다.

return Storage::download('file.jpg');

return Storage::download('file.jpg', '다운로드파일명.jpg', $headers);

파일 URL

url 메서드로 파일의 URL을 가져올 수 있습니다. local 드라이버를 사용할 경우 /storage/파일경로 형태의 상대 URL이 반환됩니다. s3 드라이버를 사용할 경우에는 S3의 전체 URL이 반환됩니다.

use Illuminate\Support\Facades\Storage;

$url = Storage::url('file.jpg');

local 드라이버를 사용할 때는, 공개적으로 접근해야 하는 파일을 반드시 storage/app/public 디렉터리에 저장해야 합니다. 또한 심볼릭 링크를 생성해야 url 메서드가 정상적으로 동작합니다.

NOTE

local 드라이버 사용 시, url의 반환값은 URL 인코딩이 적용되지 않습니다. 따라서 URL로 유효한 이름으로 파일을 저장하는 것을 권장합니다.

URL 호스트 커스터마이징

Storage 파사드로 생성되는 URL의 호스트를 변경하려면 디스크 설정에 url 옵션을 추가합니다.

'public' => [
    'driver' => 'local',
    'root'   => storage_path('app/public'),
    'url'    => env('APP_URL').'/storage',
    'visibility' => 'public',
    // ...
],

임시 URL

temporaryUrl 메서드를 사용하면 s3 드라이버로 저장된 파일에 대해 만료 시간이 있는 임시 URL을 생성할 수 있습니다. 두 번째 인수로 만료 시각을 DateTime 인스턴스로 전달합니다.

use Illuminate\Support\Facades\Storage;

$url = Storage::temporaryUrl(
    'file.jpg',
    now()->addMinutes(5)
);

추가적인 S3 요청 파라미터가 필요하다면 세 번째 인수로 배열을 전달할 수 있습니다.

$url = Storage::temporaryUrl(
    'file.jpg',
    now()->addMinutes(5),
    [
        'ResponseContentType'        => 'application/octet-stream',
        'ResponseContentDisposition' => 'attachment; filename=file.jpg',
    ]
);

특정 디스크에서 임시 URL을 생성하는 방식을 커스터마이즈해야 한다면 buildTemporaryUrlsUsing 메서드를 사용하세요. 예를 들어 임시 URL을 기본적으로 지원하지 않는 드라이버를 사용하는 디스크에서 파일을 다운로드할 수 있는 컨트롤러가 있을 때 유용합니다. 보통 이 메서드는 서비스 프로바이더의 boot 메서드에서 호출합니다.

<?php

namespace App\Providers;

use DateTime;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\ServiceProvider;
use Illuminate\Support\Str;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Storage::disk('local')->buildTemporaryUrlsUsing(
            function (string $path, DateTime $expiration, array $options) {
                return URL::temporarySignedRoute(
                    'files.download',
                    $expiration,
                    array_merge($options, ['path' => $path])
                );
            }
        );
    }
}

임시 업로드 URL

WARNING

임시 업로드 URL 생성 기능은 s3 드라이버에서만 지원됩니다.

클라이언트 사이드(브라우저, 모바일 앱 등)에서 서버를 거치지 않고 파일을 S3에 직접 업로드해야 하는 경우, temporaryUploadUrl 메서드로 사전 서명된(presigned) 업로드 URL을 생성할 수 있습니다. 이 메서드는 URL과 업로드 시 함께 전송해야 할 헤더를 배열로 반환합니다.

use Illuminate\Support\Facades\Storage;

['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(
    'file.jpg',
    now()->addMinutes(5)
);

이 방식은 S3에 직접 파일을 업로드해야 하는 서버리스 환경이나 대용량 파일 처리에 특히 유용합니다.

파일 메타데이터

파일을 읽고 쓰는 것 외에도 Laravel은 파일 자체에 대한 정보를 조회하는 메서드들을 제공합니다.

use Illuminate\Support\Facades\Storage;

$size         = Storage::size('file.jpg');         // 파일 크기(바이트)
$lastModified = Storage::lastModified('file.jpg'); // 마지막 수정 시각(Unix 타임스탬프)
$mimeType     = Storage::mimeType('file.jpg');     // MIME 타입

파일 경로

path 메서드로 파일의 절대 경로를 가져올 수 있습니다. local 드라이버를 사용할 경우 로컬 파일시스템의 절대 경로가 반환됩니다. s3 드라이버를 사용할 경우 버킷 내 상대 경로가 반환됩니다.

$path = Storage::path('file.jpg');

파일 저장

put 메서드로 파일 내용(문자열 또는 PHP 리소스)을 디스크에 저장합니다.

use Illuminate\Support\Facades\Storage;

Storage::put('avatars/1', $contents);
Storage::put('avatars/1', $resource);

파일 쓰기에 실패하면 put 메서드는 false를 반환합니다. 실패 시 예외를 던지도록 하려면 throw 옵션을 사용할 수 있습니다.

Storage::put('avatars/1', $contents, ['throw' => true]);

파일 앞뒤에 내용 추가

prepend와 append 메서드로 파일의 맨 앞 또는 맨 뒤에 내용을 추가할 수 있습니다.

Storage::prepend('file.log', '로그 시작\n');
Storage::append('file.log', '추가 로그\n');

파일 복사 및 이동

copy 메서드는 파일을 새 위치로 복사하고, move 메서드는 파일 이름을 바꾸거나 다른 위치로 이동합니다.

Storage::copy('old/file.jpg', 'new/file.jpg');
Storage::move('old/file.jpg', 'new/file.jpg');

자동 스트리밍

파일을 스토리지로 스트리밍하면 메모리 사용량을 크게 줄일 수 있습니다. putFile과 putFileAs 메서드는 Illuminate\Http\File 또는 Illuminate\Http\UploadedFile 인스턴스를 받아 자동으로 스트리밍 방식으로 저장합니다.

use Illuminate\Http\File;
use Illuminate\Support\Facades\Storage;

// 자동으로 고유한 파일명 생성
Storage::putFile('photos', new File('/path/to/photo'));

// 파일명 직접 지정
Storage::putFileAs('photos', new File('/path/to/photo'), 'photo.jpg');

putFile에서 디렉터리만 지정하면 Laravel이 자동으로 고유한 파일명(UUID)을 생성합니다. 반환값은 파일명을 포함한 저장 경로입니다.

putFile과 putFileAs의 마지막 인수로 저장 가시성(visibility)을 지정할 수 있습니다.

Storage::putFile('photos', new File('/path/to/photo'), 'public');

파일 업로드

웹 애플리케이션에서 파일 저장의 가장 흔한 경우는 사용자가 업로드한 파일(프로필 사진, 문서 등)을 저장하는 것입니다. UploadedFile 인스턴스의 store 메서드를 사용하면 쉽게 처리할 수 있습니다.

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class UserAvatarController extends Controller
{
    public function update(Request $request): string
    {
        $path = $request->file('avatar')->store('avatars');

        return $path;
    }
}

위 예시에서 몇 가지를 주목하세요. 디렉터리 이름만 지정했고 파일명은 지정하지 않았습니다. 기본적으로 store 메서드는 UUID를 파일명으로 자동 생성합니다. 반환값은 파일명을 포함한 경로입니다. 이 경로를 데이터베이스에 저장해 나중에 활용할 수 있습니다.

위 코드는 Storage::putFile('avatars', $request->file('avatar'))와 동일합니다.

파일명을 직접 지정하려면 storeAs 메서드를 사용합니다.

$path = $request->file('avatar')->storeAs(
    'avatars',
    $request->user()->id
);

Storage 파사드의 putFileAs 메서드를 써도 동일합니다.

$path = Storage::putFileAs(
    'avatars',
    $request->file('avatar'),
    $request->user()->id
);

WARNING

출력 불가 문자나 유효하지 않은 유니코드 문자는 파일 경로에서 자동으로 제거됩니다. 따라서 파일 경로를 Flysystem에 전달하기 전에 미리 정제하는 것이 좋습니다. 파일 경로 정규화는 League\Flysystem\WhitespacePathNormalizer::normalizePath로 수행됩니다.

저장 디스크 지정

기본적으로 store 메서드는 기본 디스크를 사용합니다. 다른 디스크를 지정하려면 두 번째 인수로 디스크 이름을 전달합니다.

$path = $request->file('avatar')->store(
    'avatars/'.$request->user()->id,
    's3'
);

storeAs 메서드를 사용하는 경우 디스크 이름을 세 번째 인수로 전달합니다.

$path = $request->file('avatar')->storeAs(
    'avatars',
    $request->user()->id,
    's3'
);

업로드된 파일 정보

업로드된 파일의 원본 이름이나 확장자를 가져오려면 아래 메서드들을 사용합니다.

$file = $request->file('avatar');

$originalName      = $file->getClientOriginalName();
$originalExtension = $file->getClientOriginalExtension();

WARNING

getClientOriginalName과 getClientOriginalExtension은 사용자가 제공한 값이므로 신뢰할 수 없습니다. 악의적인 사용자가 파일명과 확장자를 조작할 수 있습니다. 보안이 중요한 경우 hashName과 extension 메서드(실제 MIME 타입 기반) 사용을 권장합니다.

파일 가시성

Laravel의 Flysystem 통합에서 **가시성(visibility)**은 여러 플랫폼에 걸쳐 파일 권한을 추상화한 개념입니다. public과 private 두 가지로 구분됩니다. 파일을 public으로 지정하면 다른 사람이 접근할 수 있음을 의미합니다. 예를 들어 S3에서는 공개 URL이 생성됩니다.

파일 저장 시 가시성을 지정하려면:

use Illuminate\Support\Facades\Storage;

Storage::put('file.jpg', $contents, 'public');

이미 저장된 파일의 가시성을 조회하거나 변경하려면:

$visibility = Storage::getVisibility('file.jpg');

Storage::setVisibility('file.jpg', 'public');

업로드된 파일 처리 시 storePublicly와 storePubliclyAs를 사용하면 가시성을 public으로 설정하며 저장할 수 있습니다.

$path = $request->file('avatar')->storePublicly('avatars', 's3');

$path = $request->file('avatar')->storePubliclyAs(
    'avatars',
    $request->user()->id,
    's3'
);

로컬 파일과 가시성

local 드라이버를 사용할 때 public 가시성은 디렉터리의 경우 0755, 파일의 경우 0644 권한으로 설정됩니다. config/filesystems.php의 permissions 항목에서 이 매핑을 변경할 수 있습니다.

'local' => [
    'driver' => 'local',
    'root'   => storage_path('app'),
    'permissions' => [
        'file' => [
            'public'  => 0644,
            'private' => 0600,
        ],
        'dir' => [
            'public'  => 0755,
            'private' => 0700,
        ],
    ],
    // ...
],

파일 삭제

delete 메서드는 하나 또는 여러 개의 파일을 삭제합니다.

use Illuminate\Support\Facades\Storage;

Storage::delete('file.jpg');
Storage::delete(['file.jpg', 'file2.jpg']);

특정 디스크에서 파일을 삭제하려면:

use Illuminate\Support\Facades\Storage;

Storage::disk('s3')->delete('path/file.jpg');

디렉터리

디렉터리 내 파일 목록 가져오기

files 메서드는 지정한 디렉터리의 파일 목록을 배열로 반환합니다. 하위 디렉터리까지 포함하려면 allFiles 메서드를 사용합니다.

use Illuminate\Support\Facades\Storage;

$files    = Storage::files($directory);
$allFiles = Storage::allFiles($directory);

하위 디렉터리 목록 가져오기

directories 메서드는 지정한 디렉터리의 하위 디렉터리 목록을 반환합니다. 모든 중첩 디렉터리를 포함하려면 allDirectories를 사용합니다.

$directories    = Storage::directories($directory);
$allDirectories = Storage::allDirectories($directory);

디렉터리 생성

makeDirectory 메서드는 필요한 중간 디렉터리를 포함해 지정한 디렉터리를 생성합니다.

Storage::makeDirectory($directory);

디렉터리 삭제

deleteDirectory 메서드는 디렉터리와 그 안의 모든 파일을 삭제합니다.

Storage::deleteDirectory($directory);

테스트

Storage 파사드의 fake 메서드를 사용하면 실제 파일시스템에 영향을 주지 않고 가상(fake) 디스크를 만들어 테스트할 수 있습니다. Illuminate\Http\UploadedFile의 파일 생성 기능과 결합하면 파일 업로드 테스트를 매우 간단하게 작성할 수 있습니다.

<?php

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;

test('프로필 사진을 업로드할 수 있다', function () {
    Storage::fake('avatars');

    $file = UploadedFile::fake()->image('avatar.jpg');

    $this->post('/avatar', ['avatar' => $file]);

    Storage::disk('avatars')->assertExists($file->hashName());
});

파일이 존재하지 않는지 확인하려면:

Storage::disk('avatars')->assertMissing('missing.jpg');

가짜 파일 커스터마이즈

UploadedFile 클래스의 fake 메서드로 파일을 생성할 때 너비, 높이, 크기(킬로바이트)를 지정해 애플리케이션의 유효성 검사 규칙을 더 정밀하게 테스트할 수 있습니다.

UploadedFile::fake()->image('avatar.jpg', $width, $height)->size(100);

이미지 외의 파일은 create 메서드를 사용합니다.

UploadedFile::fake()->create('document.pdf', $sizeInKilobytes);

create 메서드에 MIME 타입을 명시적으로 지정할 수도 있습니다.

UploadedFile::fake()->create(
    'document.pdf',
    $sizeInKilobytes,
    'application/pdf'
);

커스텀 파일시스템

Laravel의 Flysystem 통합은 기본적으로 여러 드라이버를 지원하지만, Flysystem은 이것에 국한되지 않고 다양한 스토리지 시스템용 어댑터를 갖추고 있습니다. Laravel 애플리케이션에서 이런 추가 어댑터를 사용하려면 커스텀 드라이버를 등록해야 합니다.

커스텀 파일시스템을 정의하려면 Flysystem 어댑터가 필요합니다. 예시로 커뮤니티가 관리하는 Dropbox 어댑터를 프로젝트에 추가해 보겠습니다.

composer require spatie/flysystem-dropbox

다음으로, 서비스 프로바이더의 boot 메서드에서 Storage 파사드의 extend 메서드를 사용해 드라이버를 등록합니다. 서비스 프로바이더 안에서 직접 할 수도 있고, 별도의 서비스 프로바이더를 만들어도 됩니다.

<?php

namespace App\Providers;

use Illuminate\Contracts\Foundation\Application;
use Illuminate\Filesystem\FilesystemAdapter;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Filesystem;
use Spatie\Dropbox\Client as DropboxClient;
use Spatie\FlysystemDropbox\DropboxAdapter;

class AppServiceProvider extends ServiceProvider
{
    public function boot(): void
    {
        Storage::extend('dropbox', function (Application $app, array $config) {
            $adapter = new DropboxAdapter(new DropboxClient(
                $config['authorization_token']
            ));

            return new FilesystemAdapter(
                new Filesystem($adapter, $config),
                $adapter,
                $config
            );
        });
    }
}

extend 메서드의 첫 번째 인수는 드라이버 이름이고, 두 번째는 $app과 $config를 받는 클로저입니다. 클로저는 Illuminate\Filesystem\FilesystemAdapter 인스턴스를 반환해야 합니다. $config에는 해당 디스크의 config/filesystems.php 설정값이 전달됩니다.

등록이 완료되면 config/filesystems.php에서 dropbox 드라이버를 사용하는 디스크를 정의해 사용할 수 있습니다.

파일 저장소

소개

Laravel은 Frank de Jonge가 만든 Flysystem PHP 패키지를 기반으로 강력한 파일시스템 추상화 레이어를 제공합니다. Laravel의 Flysystem 통합은 로컬 파일시스템, SFTP, Amazon S3를 손쉽게 다룰 수 있는 드라이버를 제공합니다. 특히 모든 드라이버가 동일한 API를 공유하기 때문에, 로컬 개발 환경과 프로덕션 서버 간에 저장소를 전환하더라도 코드를 거의 변경할 필요가 없습니다.

설정

Laravel의 파일시스템 설정 파일은 config/filesystems.php에 위치합니다. 이 파일에서 파일시스템 "디스크"를 정의할 수 있습니다. 각 디스크는 특정 스토리지 드라이버와 저장 위치를 나타냅니다. 지원되는 드라이버별 예시 설정이 이미 파일에 포함되어 있으므로, 자신의 환경에 맞게 수정해 사용하면 됩니다.

local 드라이버는 Laravel 애플리케이션이 실행되는 서버의 로컬 파일을 다루며, s3 드라이버는 Amazon S3 클라우드 스토리지에 파일을 저장할 때 사용합니다.

NOTE

디스크는 원하는 만큼 자유롭게 정의할 수 있습니다. 같은 드라이버를 사용하는 디스크를 여러 개 만드는 것도 가능합니다.

로컬 드라이버

local 드라이버를 사용하면 모든 파일 작업은 filesystems 설정 파일에 정의된 root 디렉터리를 기준으로 수행됩니다. 기본값은 storage/app/private 디렉터리입니다. 따라서 아래 코드는 storage/app/private/example.txt 파일에 내용을 씁니다.

use Illuminate\Support\Facades\Storage;

Storage::disk('local')->put('example.txt', '파일 내용');

퍼블릭 디스크

filesystems 설정 파일에는 public 디스크가 기본으로 포함되어 있습니다. 이 디스크는 외부에서 공개적으로 접근 가능한 파일을 저장하는 용도로 사용합니다. 기본적으로 public 디스크는 local 드라이버를 사용하며, 파일은 storage/app/public 디렉터리에 저장됩니다.

public 디스크가 local 드라이버를 사용하는 경우, 웹에서 파일에 접근하려면 storage/app/public 디렉터리를 public/storage로 연결하는 심볼릭 링크를 만들어야 합니다.

심볼릭 링크는 아래 Artisan 명령어로 생성할 수 있습니다.

php artisan storage:link

파일을 저장하고 심볼릭 링크를 생성한 뒤에는 asset 헬퍼를 사용해 파일 URL을 만들 수 있습니다.

echo asset('storage/file.txt');

filesystems 설정 파일에서 추가 심볼릭 링크를 정의할 수도 있습니다. 정의된 링크는 모두 storage:link 명령어 실행 시 함께 생성됩니다.

'links' => [
    public_path('storage') => storage_path('app/public'),
    public_path('images') => storage_path('app/images'),
],

반대로, 생성된 심볼릭 링크를 제거하려면 storage:unlink 명령어를 사용합니다.

php artisan storage:unlink

드라이버 사전 준비

S3 드라이버 설정

S3 드라이버를 사용하기 전에 Composer로 Flysystem S3 패키지를 설치해야 합니다.

composer require league/flysystem-aws-s3-v3 "^3.0" --with-all-dependencies

S3 디스크 설정 배열은 config/filesystems.php 파일에 이미 포함되어 있습니다. 일반적으로 아래 환경 변수를 통해 S3 인증 정보를 설정합니다. 이 변수명은 AWS CLI와 동일한 규칙을 따르므로 익숙하게 사용할 수 있습니다.

AWS_ACCESS_KEY_ID=<your-key-id>
AWS_SECRET_ACCESS_KEY=<your-secret-access-key>
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=<your-bucket-name>
AWS_USE_PATH_STYLE_ENDPOINT=false

FTP 드라이버 설정

FTP 드라이버를 사용하기 전에 Composer로 Flysystem FTP 패키지를 설치해야 합니다.

composer require league/flysystem-ftp "^3.0"

Laravel의 Flysystem은 FTP와도 잘 동작하지만, 기본 config/filesystems.php에는 FTP 예시 설정이 포함되어 있지 않습니다. FTP 파일시스템이 필요한 경우 아래 예시를 참고해 설정하세요.

'ftp' => [
    'driver' => 'ftp',
    'host' => env('FTP_HOST'),
    'username' => env('FTP_USERNAME'),
    'password' => env('FTP_PASSWORD'),

    // 선택적 FTP 설정...
    // 'port' => env('FTP_PORT', 21),
    // 'root' => env('FTP_ROOT'),
    // 'passive' => true,
    // 'ssl' => true,
    // 'timeout' => 30,
],

SFTP 드라이버 설정

SFTP 드라이버를 사용하기 전에 Composer로 Flysystem SFTP 패키지를 설치해야 합니다.

composer require league/flysystem-sftp-v3 "^3.0"

FTP와 마찬가지로, 기본 config/filesystems.php에는 SFTP 예시 설정이 포함되어 있지 않습니다. SFTP 파일시스템이 필요한 경우 아래 예시를 참고하세요.

'sftp' => [
    'driver' => 'sftp',
    'host' => env('SFTP_HOST'),

    // 기본 인증 설정...
    'username' => env('SFTP_USERNAME'),
    'password' => env('SFTP_PASSWORD'),

    // SSH 키 기반 인증 설정...
    'privateKey' => env('SFTP_PRIVATE_KEY'),
    'passphrase' => env('SFTP_PASSPHRASE'),

    // 파일 / 디렉터리 권한 설정...
    'visibility' => 'private', // `private` = 0600, `public` = 0644
    'directory_visibility' => 'private', // `private` = 0700, `public` = 0755

    // 선택적 SFTP 설정...
    // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),
    // 'maxTries' => 4,
    // 'passphrase' => env('SFTP_PASSPHRASE'),
    // 'port' => env('SFTP_PORT', 22),
    // 'root' => env('SFTP_ROOT', ''),
    // 'timeout' => 30,
    // 'useAgent' => true,
],

스코프 디스크 및 읽기 전용 디스크

스코프 디스크(Scoped Disk)를 사용하면 모든 경로에 지정한 접두사(prefix)가 자동으로 붙는 파일시스템을 정의할 수 있습니다. 예를 들어, S3 디스크에서 특정 하위 경로만 다루는 디스크를 별도로 만들 때 유용합니다. 스코프 디스크를 사용하려면 먼저 아래 패키지를 설치해야 합니다.

composer require league/flysystem-path-prefixing "^3.0"

scoped 드라이버를 사용하여 기존 디스크의 스코프 인스턴스를 만들 수 있습니다. 아래 예시는 s3 디스크를 특정 경로로 제한한 s3-videos 디스크를 정의합니다. 이 디스크를 통한 모든 파일 작업에는 지정한 경로 접두사가 자동으로 적용됩니다.

's3-videos' => [
    'driver' => 'scoped',
    'disk' => 's3',
    'prefix' => 'path/to/videos',
],

읽기 전용 디스크(Read-Only Disk)는 쓰기 작업을 허용하지 않는 파일시스템 디스크를 만들 때 사용합니다. 이 기능을 사용하려면 먼저 아래 패키지를 설치해야 합니다.

composer require league/flysystem-read-only "^3.0"

설치 후, 원하는 디스크 설정에 read-only 옵션을 추가하면 됩니다.

's3-videos' => [
    'driver' => 's3',
    // ...
    'read-only' => true,
],

Amazon S3 호환 파일시스템

기본 filesystems 설정 파일에는 s3 디스크 설정이 포함되어 있습니다. 이 디스크는 Amazon S3뿐만 아니라 S3 호환 API를 제공하는 다양한 스토리지 서비스에도 사용할 수 있습니다. 호환되는 서비스로는 MinIO, DigitalOcean Spaces, Vultr Object Storage, Cloudflare R2, Hetzner Cloud Storage 등이 있습니다. 국내 환경에서는 NHN Cloud Object Storage나 네이버 클라우드 Object Storage처럼 S3 호환 API를 지원하는 서비스도 동일한 방식으로 연동할 수 있습니다.

사용하려는 서비스의 인증 정보로 디스크 설정을 업데이트한 뒤, endpoint 옵션 값만 해당 서비스의 엔드포인트로 변경하면 됩니다. 이 값은 보통 AWS_ENDPOINT 환경 변수로 지정합니다.

'endpoint' => env('AWS_ENDPOINT', 'https://minio:9000'),

MinIO

MinIO를 사용할 때 Laravel의 Flysystem이 올바른 URL을 생성하려면, AWS_URL 환경 변수를 애플리케이션의 로컬 URL로 설정하고 URL 경로에 버킷 이름을 포함해야 합니다.

AWS_URL=http://localhost:9000/local

WARNING

MinIO를 사용하는 경우, endpoint가 클라이언트에서 접근 불가능한 주소라면 temporaryUrl 메서드를 통한 임시 URL 생성이 정상적으로 동작하지 않을 수 있습니다.

파일 저장소

디스크 인스턴스 가져오기

Storage 파사드를 사용하면 설정된 디스크와 자유롭게 상호작용할 수 있습니다. 예를 들어, put 메서드로 기본 디스크에 아바타 이미지를 저장할 수 있습니다. disk 메서드를 먼저 호출하지 않으면, Storage 파사드의 모든 메서드 호출은 자동으로 기본 디스크에 전달됩니다.

use Illuminate\Support\Facades\Storage;

Storage::put('avatars/1', $content);

여러 디스크를 함께 사용하는 애플리케이션이라면, disk 메서드로 원하는 디스크를 명시적으로 지정할 수 있습니다.

Storage::disk('s3')->put('avatars/1', $content);

런타임 디스크 (On-Demand Disks)

filesystems 설정 파일에 미리 정의하지 않고, 런타임에 동적으로 디스크를 생성해야 할 때는 Storage 파사드의 build 메서드에 설정 배열을 직접 전달하면 됩니다.

use Illuminate\Support\Facades\Storage;

$disk = Storage::build([
    'driver' => 'local',
    'root' => '/path/to/root',
]);

$disk->put('image.jpg', $content);

NOTE

런타임 디스크는 테스트 환경이나 사용자별로 격리된 저장 공간이 필요한 경우처럼, 설정을 미리 고정하기 어려운 상황에 유용합니다.

파일 조회

파일 내용 읽기

get 메서드로 파일의 내용을 읽어올 수 있습니다. 파일의 원시 문자열 내용이 반환됩니다. 모든 파일 경로는 디스크의 "루트" 위치를 기준으로 한 상대 경로로 지정해야 합니다.

$contents = Storage::get('file.jpg');

읽어올 파일이 JSON 형식이라면 json 메서드를 사용하면 파일을 읽는 동시에 내용을 디코딩할 수 있습니다.

$orders = Storage::json('orders.json');

exists 메서드로 디스크에 파일이 존재하는지 확인할 수 있습니다.

if (Storage::disk('s3')->exists('file.jpg')) {
    // ...
}

반대로 missing 메서드를 사용하면 파일이 존재하지 않는지 확인할 수 있습니다.

if (Storage::disk('s3')->missing('file.jpg')) {
    // ...
}

파일 다운로드

download 메서드는 사용자의 브라우저가 지정한 경로의 파일을 강제로 다운로드하도록 하는 응답을 생성합니다. 두 번째 인수로 다운로드 시 사용자에게 표시될 파일 이름을 지정할 수 있으며, 세 번째 인수로 HTTP 헤더 배열을 전달할 수 있습니다.

return Storage::download('file.jpg');

return Storage::download('file.jpg', $name, $headers);

파일 URL

url 메서드를 사용하면 특정 파일의 URL을 가져올 수 있습니다. local 드라이버를 사용하는 경우 일반적으로 지정한 경로 앞에 /storage가 붙어 상대 URL이 반환됩니다. s3 드라이버를 사용하는 경우에는 완전한 형태의 원격 URL이 반환됩니다.

use Illuminate\Support\Facades\Storage;

$url = Storage::url('file.jpg');

local 드라이버를 사용할 때 외부에 공개해야 하는 파일은 storage/app/public 디렉터리에 저장해야 합니다. 또한 public/storage에서 storage/app/public 디렉터리를 가리키는 심볼릭 링크를 생성해야 합니다.

WARNING

local 드라이버를 사용할 때 url의 반환값은 URL 인코딩이 적용되지 않습니다. 따라서 유효한 URL을 만들 수 있는 파일 이름을 사용하는 것을 권장합니다.

URL 호스트 커스터마이징

Storage 파사드를 통해 생성되는 URL의 호스트를 변경하고 싶다면, 디스크 설정 배열에 url 옵션을 추가하거나 수정하면 됩니다.

'public' => [
    'driver' => 'local',
    'root' => storage_path('app/public'),
    'url' => env('APP_URL').'/storage',
    'visibility' => 'public',
    'throw' => false,
],

임시 URL

temporaryUrl 메서드를 사용하면 local 및 s3 드라이버로 저장된 파일에 대한 임시 URL을 생성할 수 있습니다. 이 메서드는 경로와 URL 만료 시점을 나타내는 DateTime 인스턴스를 인수로 받습니다.

use Illuminate\Support\Facades\Storage;

$url = Storage::temporaryUrl(
    'file.jpg', now()->addMinutes(5)
);

로컬 임시 URL 활성화

local 드라이버에 임시 URL 지원이 추가되기 이전부터 개발을 시작한 프로젝트라면, 로컬 임시 URL을 명시적으로 활성화해야 할 수 있습니다. config/filesystems.php의 local 디스크 설정 배열에 serve 옵션을 추가하면 됩니다.

'local' => [

    'driver' => 'local',

    'root' => storage_path('app/private'),

    'serve' => true, //

    'throw' => false,

],

S3 요청 파라미터

추가적인 S3 요청 파라미터를 지정해야 한다면, temporaryUrl 메서드의 세 번째 인수로 요청 파라미터 배열을 전달할 수 있습니다.

$url = Storage::temporaryUrl(
    'file.jpg',
    now()->addMinutes(5),
    [
        'ResponseContentType' => 'application/octet-stream',
        'ResponseContentDisposition' => 'attachment; filename=file2.jpg',
    ]
);

임시 URL 생성 방식 커스터마이징

특정 스토리지 디스크에서 임시 URL을 생성하는 방식을 직접 제어해야 할 때는 buildTemporaryUrlsUsing 메서드를 사용할 수 있습니다. 예를 들어, 일반적으로 임시 URL을 지원하지 않는 디스크에 저장된 파일을 다운로드할 수 있도록 컨트롤러를 구성할 때 유용합니다. 이 메서드는 서비스 프로바이더의 boot 메서드에서 호출하는 것이 일반적입니다.

<?php

namespace App\Providers;

use DateTime;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\URL;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 애플리케이션 서비스를 부트스트랩합니다.
     */
    public function boot(): void
    {
        Storage::disk('local')->buildTemporaryUrlsUsing(
            function (string $path, DateTime $expiration, array $options) {
                return URL::temporarySignedRoute(
                    'files.download',
                    $expiration,
                    array_merge($options, ['path' => $path])
                );
            }
        );
    }
}

임시 업로드 URL

WARNING

임시 업로드 URL 생성 기능은 s3 드라이버에서만 지원됩니다.

클라이언트 측 애플리케이션에서 파일을 직접 업로드할 수 있는 임시 URL이 필요하다면 temporaryUploadUrl 메서드를 사용할 수 있습니다. 이 메서드는 경로와 URL 만료 시점을 나타내는 DateTime 인스턴스를 인수로 받습니다. 반환값은 업로드 URL과 업로드 요청에 포함해야 할 헤더를 담은 연관 배열로, 구조 분해 할당으로 편리하게 사용할 수 있습니다.

use Illuminate\Support\Facades\Storage;

['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(
    'file.jpg', now()->addMinutes(5)
);

이 메서드는 클라이언트가 Amazon S3와 같은 클라우드 스토리지에 직접 파일을 업로드해야 하는 서버리스 환경에서 특히 유용합니다.

파일 메타데이터

Laravel은 파일 내용을 읽고 쓰는 것 외에도 파일 자체에 대한 다양한 정보를 제공합니다.

size 메서드로 파일 크기를 바이트 단위로 가져올 수 있습니다.

use Illuminate\Support\Facades\Storage;

$size = Storage::size('file.jpg');

lastModified 메서드는 파일이 마지막으로 수정된 시점의 UNIX 타임스탬프를 반환합니다.

$time = Storage::lastModified('file.jpg');

mimeType 메서드로 파일의 MIME 타입을 확인할 수 있습니다.

$mime = Storage::mimeType('file.jpg');

파일 경로

path 메서드를 사용하면 파일의 경로를 가져올 수 있습니다. local 드라이버를 사용하는 경우 파일의 절대 경로가 반환되며, s3 드라이버를 사용하는 경우 S3 버킷 내의 상대 경로가 반환됩니다.

use Illuminate\Support\Facades\Storage;

$path = Storage::path('file.jpg');

파일 저장소

파일 저장하기

put 메서드를 사용하면 디스크에 파일 내용을 저장할 수 있습니다. PHP resource를 전달하면 Flysystem의 스트림 기능을 활용하여 저장합니다. 모든 파일 경로는 해당 디스크에 설정된 "루트(root)" 위치를 기준으로 하는 상대 경로로 지정해야 합니다.

use Illuminate\Support\Facades\Storage;

Storage::put('file.jpg', $contents);

Storage::put('file.jpg', $resource);

쓰기 실패 처리

put 메서드(또는 다른 쓰기 작업)가 파일을 디스크에 저장하지 못하면 false를 반환합니다.

if (! Storage::put('file.jpg', $contents)) {
    // 파일을 디스크에 쓸 수 없습니다...
}

쓰기 실패 시 예외를 던지게 하려면, 파일시스템 디스크 설정 배열에 throw 옵션을 추가하면 됩니다. true로 설정하면 put 같은 쓰기 메서드가 실패할 때 League\Flysystem\UnableToWriteFile 예외를 던집니다.

'public' => [
    'driver' => 'local',
    // ...
    'throw' => true,
],

파일 앞뒤에 내용 추가하기

prepend와 append 메서드를 사용하면 파일의 맨 앞이나 맨 끝에 내용을 추가할 수 있습니다.

Storage::prepend('file.log', '앞에 추가할 텍스트');

Storage::append('file.log', '뒤에 추가할 텍스트');

파일 복사 및 이동

copy 메서드는 기존 파일을 디스크의 새 위치로 복사하고, move 메서드는 파일 이름을 바꾸거나 새 위치로 이동시킵니다.

Storage::copy('old/file.jpg', 'new/file.jpg');

Storage::move('old/file.jpg', 'new/file.jpg');

자동 스트리밍

파일을 스트리밍 방식으로 저장하면 메모리 사용량을 크게 줄일 수 있습니다. Laravel이 자동으로 스트리밍을 처리하게 하려면 putFile 또는 putFileAs 메서드를 사용하세요. 이 메서드들은 Illuminate\Http\File 또는 Illuminate\Http\UploadedFile 인스턴스를 받아 지정한 위치로 자동으로 스트리밍합니다.

use Illuminate\Http\File;
use Illuminate\Support\Facades\Storage;

// 파일명을 자동으로 고유 ID로 생성...
$path = Storage::putFile('photos', new File('/path/to/photo'));

// 파일명을 직접 지정...
$path = Storage::putFileAs('photos', new File('/path/to/photo'), 'photo.jpg');

putFile 메서드에서 주의할 점이 있습니다. 파일명이 아닌 디렉터리 이름만 지정한다는 점입니다. 기본적으로 putFile은 고유 ID를 파일명으로 자동 생성하며, 파일 확장자는 MIME 타입을 기반으로 결정됩니다. 반환값은 생성된 파일명을 포함한 전체 경로이므로, 이를 데이터베이스에 저장할 수 있습니다.

putFile과 putFileAs 메서드는 저장할 파일의 "공개 여부(visibility)"를 지정하는 인수도 받습니다. Amazon S3 같은 클라우드 디스크에 저장하면서 파일을 공개 URL로 접근 가능하게 하려면 특히 유용합니다.

Storage::putFile('photos', new File('/path/to/photo'), 'public');

파일 업로드 저장하기

웹 애플리케이션에서 가장 흔한 파일 저장 사례 중 하나는 사용자가 업로드한 사진이나 문서를 저장하는 것입니다. Laravel은 업로드된 파일 인스턴스의 store 메서드를 통해 이 작업을 매우 간단하게 처리할 수 있습니다.

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Http\Request;

class UserAvatarController extends Controller
{
    /**
     * 사용자 아바타를 업데이트합니다.
     */
    public function update(Request $request): string
    {
        $path = $request->file('avatar')->store('avatars');

        return $path;
    }
}

이 예제에서도 마찬가지로 파일명이 아닌 디렉터리 이름만 지정합니다. store 메서드는 고유 ID를 파일명으로 자동 생성하고, MIME 타입을 기반으로 확장자를 결정합니다. 반환된 경로(생성된 파일명 포함)를 데이터베이스에 저장하면 됩니다.

Storage 파사드의 putFile 메서드를 사용해도 위와 동일한 작업을 수행할 수 있습니다.

$path = Storage::putFile('avatars', $request->file('avatar'));

파일명 직접 지정하기

자동으로 생성된 파일명 대신 직접 파일명을 지정하려면 storeAs 메서드를 사용하세요. 인수로 경로, 파일명, 그리고 선택적으로 디스크 이름을 받습니다.

$path = $request->file('avatar')->storeAs(
    'avatars', $request->user()->id
);

Storage 파사드의 putFileAs 메서드로도 동일한 작업을 수행할 수 있습니다.

$path = Storage::putFileAs(
    'avatars', $request->file('avatar'), $request->user()->id
);

WARNING

인쇄 불가능한 문자나 유효하지 않은 유니코드 문자는 파일 경로에서 자동으로 제거됩니다. 따라서 파일 경로를 Laravel 파일 저장 메서드에 전달하기 전에 미리 정제(sanitize)하는 것이 좋습니다. 파일 경로는 League\Flysystem\WhitespacePathNormalizer::normalizePath 메서드를 통해 정규화됩니다.

디스크 지정하기

업로드된 파일의 store 메서드는 기본적으로 기본 디스크를 사용합니다. 다른 디스크를 사용하려면 두 번째 인수로 디스크 이름을 전달하세요.

$path = $request->file('avatar')->store(
    'avatars/'.$request->user()->id, 's3'
);

storeAs 메서드를 사용하는 경우에는 세 번째 인수로 디스크 이름을 전달합니다.

$path = $request->file('avatar')->storeAs(
    'avatars',
    $request->user()->id,
    's3'
);

업로드된 파일 정보 조회

업로드된 파일의 원본 이름과 확장자를 가져오려면 getClientOriginalName과 getClientOriginalExtension 메서드를 사용할 수 있습니다.

$file = $request->file('avatar');

$name = $file->getClientOriginalName();
$extension = $file->getClientOriginalExtension();

단, 이 두 메서드는 보안상 안전하지 않습니다. 악의적인 사용자가 파일명과 확장자를 조작할 수 있기 때문입니다. 따라서 실제 파일 저장 시에는 MIME 타입 기반으로 확장자를 판단하는 hashName과 extension 메서드를 사용하는 것을 권장합니다.

$file = $request->file('avatar');

$name = $file->hashName();      // 고유한 랜덤 이름을 생성...
$extension = $file->extension(); // MIME 타입 기반으로 확장자를 결정...

파일 공개 여부 (Visibility)

Laravel의 Flysystem 통합에서 "공개 여부(visibility)"는 여러 플랫폼에 걸친 파일 접근 권한의 추상화입니다. 파일은 public 또는 private으로 선언할 수 있습니다. public으로 선언한 파일은 외부에서 접근 가능함을 의미합니다. 예를 들어 S3 드라이버를 사용할 때 public 파일의 URL을 조회할 수 있습니다.

put 메서드로 파일을 저장할 때 공개 여부를 함께 설정할 수 있습니다.

use Illuminate\Support\Facades\Storage;

Storage::put('file.jpg', $contents, 'public');

이미 저장된 파일의 공개 여부를 조회하거나 변경하려면 getVisibility와 setVisibility 메서드를 사용하세요.

$visibility = Storage::getVisibility('file.jpg');

Storage::setVisibility('file.jpg', 'public');

업로드된 파일을 public 공개 여부로 저장하려면 storePublicly와 storePubliclyAs 메서드를 사용하세요.

$path = $request->file('avatar')->storePublicly('avatars', 's3');

$path = $request->file('avatar')->storePubliclyAs(
    'avatars',
    $request->user()->id,
    's3'
);

로컬 파일과 공개 여부

local 드라이버를 사용할 때 public 공개 여부는 디렉터리에 대해 0755 권한, 파일에 대해 0644 권한으로 변환됩니다. 이 권한 매핑은 애플리케이션의 filesystems 설정 파일에서 변경할 수 있습니다.

'local' => [
    'driver' => 'local',
    'root' => storage_path('app'),
    'permissions' => [
        'file' => [
            'public' => 0644,
            'private' => 0600,
        ],
        'dir' => [
            'public' => 0755,
            'private' => 0700,
        ],
    ],
    'throw' => false,
],

디렉토리

파일 삭제

delete 메서드에 파일명 하나 또는 파일명 배열을 전달하여 파일을 삭제할 수 있습니다.

use Illuminate\Support\Facades\Storage;

Storage::delete('file.jpg');

Storage::delete(['file.jpg', 'file2.jpg']);

특정 디스크에서 파일을 삭제하려면 disk 메서드를 먼저 호출하세요.

use Illuminate\Support\Facades\Storage;

Storage::disk('s3')->delete('path/file.jpg');

디렉터리

디렉터리 내 모든 파일 조회

files 메서드는 지정한 디렉터리에 있는 모든 파일의 배열을 반환합니다. 하위 디렉터리까지 포함하여 모든 파일을 가져오려면 allFiles 메서드를 사용하세요.

use Illuminate\Support\Facades\Storage;

$files = Storage::files($directory);

$files = Storage::allFiles($directory);

디렉터리 내 모든 하위 디렉터리 조회

directories 메서드는 지정한 디렉터리 안에 있는 모든 하위 디렉터리의 배열을 반환합니다. 중첩된 하위 디렉터리까지 재귀적으로 가져오려면 allDirectories 메서드를 사용하세요.

$directories = Storage::directories($directory);

$directories = Storage::allDirectories($directory);

디렉터리 생성

makeDirectory 메서드는 지정한 디렉터리를 생성합니다. 중간 경로의 디렉터리가 존재하지 않더라도 필요한 상위 디렉터리까지 함께 생성합니다.

Storage::makeDirectory($directory);

디렉터리 삭제

deleteDirectory 메서드는 지정한 디렉터리와 그 안의 모든 파일을 함께 삭제합니다.

Storage::deleteDirectory($directory);

테스트

Storage 파사드의 fake 메서드를 사용하면 가짜 디스크를 손쉽게 만들 수 있습니다. 이를 Illuminate\Http\UploadedFile 클래스의 파일 생성 유틸리티와 함께 사용하면 파일 업로드 테스트를 훨씬 간단하게 작성할 수 있습니다.

Pest

<?php

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;

test('앨범을 업로드할 수 있다', function () {
    Storage::fake('photos');

    $response = $this->json('POST', '/photos', [
        UploadedFile::fake()->image('photo1.jpg'),
        UploadedFile::fake()->image('photo2.jpg')
    ]);

    // 하나 이상의 파일이 저장되었는지 확인...
    Storage::disk('photos')->assertExists('photo1.jpg');
    Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);

    // 하나 이상의 파일이 저장되지 않았는지 확인...
    Storage::disk('photos')->assertMissing('missing.jpg');
    Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);

    // 특정 디렉터리의 파일 수가 예상과 일치하는지 확인...
    Storage::disk('photos')->assertCount('/wallpapers', 2);

    // 특정 디렉터리가 비어 있는지 확인...
    Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');
});

PHPUnit

<?php

namespace Tests\Feature;

use Illuminate\Http\UploadedFile;
use Illuminate\Support\Facades\Storage;
use Tests\TestCase;

class ExampleTest extends TestCase
{
    public function test_앨범을_업로드할_수_있다(): void
    {
        Storage::fake('photos');

        $response = $this->json('POST', '/photos', [
            UploadedFile::fake()->image('photo1.jpg'),
            UploadedFile::fake()->image('photo2.jpg')
        ]);

        // 하나 이상의 파일이 저장되었는지 확인...
        Storage::disk('photos')->assertExists('photo1.jpg');
        Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);

        // 하나 이상의 파일이 저장되지 않았는지 확인...
        Storage::disk('photos')->assertMissing('missing.jpg');
        Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);

        // 특정 디렉터리의 파일 수가 예상과 일치하는지 확인...
        Storage::disk('photos')->assertCount('/wallpapers', 2);

        // 특정 디렉터리가 비어 있는지 확인...
        Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');
    }
}

기본적으로 fake 메서드는 임시 디렉터리의 모든 파일을 삭제합니다. 테스트 후에도 파일을 유지하고 싶다면 persistentFake 메서드를 사용하세요. 파일 업로드 테스트에 대한 더 자세한 내용은 HTTP 테스트 문서의 파일 업로드 섹션을 참고하세요.

WARNING

image 메서드를 사용하려면 PHP의 GD 확장이 설치되어 있어야 합니다.

파일 저장소

커스텀 파일시스템

Laravel의 Flysystem 통합은 기본적으로 여러 "드라이버"를 지원합니다. 하지만 Flysystem은 이에 그치지 않고 다양한 외부 스토리지 시스템을 위한 어댑터를 추가로 제공합니다. 기본 제공 드라이버 외에 다른 어댑터를 사용하고 싶다면, 커스텀 드라이버를 직접 등록할 수 있습니다.

커스텀 파일시스템을 정의하려면 Flysystem 어댑터가 필요합니다. 예시로, 커뮤니티에서 관리하는 Dropbox 어댑터를 프로젝트에 추가해 보겠습니다.

composer require spatie/flysystem-dropbox

패키지를 설치했다면, 애플리케이션의 서비스 프로바이더 중 하나의 boot 메서드에서 드라이버를 등록합니다. Storage 파사드의 extend 메서드를 사용하면 됩니다.

<?php

namespace App\Providers;

use Illuminate\Contracts\Foundation\Application;
use Illuminate\Filesystem\FilesystemAdapter;
use Illuminate\Support\Facades\Storage;
use Illuminate\Support\ServiceProvider;
use League\Flysystem\Filesystem;
use Spatie\Dropbox\Client as DropboxClient;
use Spatie\FlysystemDropbox\DropboxAdapter;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 애플리케이션 서비스를 등록합니다.
     */
    public function register(): void
    {
        // ...
    }

    /**
     * 애플리케이션 서비스를 부트스트랩합니다.
     */
    public function boot(): void
    {
        Storage::extend('dropbox', function (Application $app, array $config) {
            $adapter = new DropboxAdapter(new DropboxClient(
                $config['authorization_token']
            ));

            return new FilesystemAdapter(
                new Filesystem($adapter, $config),
                $adapter,
                $config
            );
        });
    }
}

extend 메서드의 첫 번째 인수는 드라이버 이름이고, 두 번째 인수는 $app과 $config를 받는 클로저입니다. 이 클로저는 반드시 Illuminate\Filesystem\FilesystemAdapter 인스턴스를 반환해야 합니다. $config 변수에는 config/filesystems.php에서 해당 디스크에 대해 정의한 설정값이 담겨 있습니다.

NOTE

extend 호출은 AppServiceProvider의 boot 메서드처럼 애플리케이션 부트스트랩 시점에 실행되어야 합니다. 너무 늦게 등록하면 드라이버가 인식되지 않을 수 있습니다.

드라이버 등록이 완료되면, config/filesystems.php 설정 파일에서 dropbox 드라이버를 디스크로 사용할 수 있습니다.

'disks' => [

    'dropbox' => [
        'driver'              => 'dropbox',
        'authorization_token' => env('DROPBOX_AUTH_TOKEN'),
    ],

],

이제 Storage::disk('dropbox')를 통해 Dropbox 디스크에 접근하면, 기본 로컬 디스크나 S3 디스크와 동일한 방식으로 파일을 읽고 쓸 수 있습니다. 커스텀 드라이버도 FilesystemAdapter를 반환하는 한, Laravel의 모든 파일시스템 API를 그대로 활용할 수 있습니다.