파일 저장소

업데이트됨

번역일: 2026년 7월 15일

이 페이지는 원문이 업데이트되어 번역이 갱신되었습니다.

원문 수정: 2026년 7월 15일
번역 갱신: 2026년 7월 15일

파일 저장소

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

소개

Laravel은 Frank de Jonge가 만든 강력한 PHP 패키지인 Flysystem을 기반으로 파일 저장소 추상화 레이어를 제공합니다. Laravel의 Flysystem 통합은 로컬 파일시스템, SFTP, Amazon S3 등 다양한 스토리지 백엔드를 일관된 API로 다룰 수 있게 해줍니다. 로컬 환경에서는 로컬 드라이버로 개발하고, 운영 환경에서는 S3로 전환하더라도 코드를 거의 바꾸지 않아도 됩니다.

설정

파일시스템 설정 파일은 config/filesystems.php에 있습니다. 이 파일에서 모든 디스크를 정의합니다. 각 디스크는 특정 스토리지 드라이버와 저장 위치를 나타냅니다. 지원되는 각 드라이버의 예시 설정이 파일에 포함되어 있으니, 필요에 맞게 수정하여 사용하세요.

로컬 드라이버

local 드라이버를 사용하면 모든 파일 작업이 filesystems.php 설정 파일에 정의된 root 디렉터리를 기준으로 처리됩니다. 기본값은 storage/app/private입니다. 예를 들어 아래 코드를 실행하면 storage/app/private/example.txt 파일이 생성됩니다.

use Illuminate\Support\Facades\Storage;

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

퍼블릭 디스크

config/filesystems.php에 정의된 public 디스크는 외부에서 접근 가능한 파일을 위한 디스크입니다. 기본적으로 public 디스크는 local 드라이버를 사용하며 파일을 storage/app/public에 저장합니다.

이 파일들을 웹에서 접근 가능하게 하려면 public/storage에서 storage/app/public으로 향하는 심볼릭 링크를 생성해야 합니다. 이 방식을 사용하면 배포 시에도 public/storage라는 단일 디렉터리만 공개 접근 가능 상태로 유지하면 됩니다.

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

php artisan storage:link

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

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

filesystems.php에 심볼릭 링크를 추가로 설정할 수도 있습니다. 설정된 링크들은 storage:link 명령어를 실행할 때 함께 생성됩니다.

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

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

php artisan storage:unlink

드라이버 사전 요구사항

S3 드라이버

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

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

S3 디스크 설정은 config/filesystems.php에 있습니다. 이 파일에 예시 설정이 포함되어 있으며, 각 설정 값은 보안을 위해 환경 변수로 관리하는 것을 권장합니다. 환경 변수는 AWS CLI의 네이밍 컨벤션을 따릅니다.

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"

Laravel의 Flysystem 통합은 SFTP와도 잘 동작하지만, 기본 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-videos' => [
    'driver' => 'scoped',
    'disk' => 's3',
    'prefix' => 'path/to/videos',
],

읽기 전용 디스크는 쓰기 작업을 허용하지 않는 디스크입니다. read-only 설정 옵션을 사용합니다.

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

Amazon S3 호환 파일시스템

기본적으로 config/filesystems.php의 s3 디스크 설정은 Amazon S3를 사용하도록 구성되어 있습니다. 그러나 이 설정을 응용하면 MinIO, DigitalOcean Spaces, Cloudflare R2, 네이버 클라우드 Object Storage 등 S3 호환 스토리지 서비스에도 연결할 수 있습니다.

NOTE

국내 프로젝트에서는 네이버 클라우드 Object Storage나 KakaoCloud Object Storage 같은 S3 호환 서비스를 사용하는 경우도 많습니다. endpoint와 region만 변경하면 동일한 방식으로 연동할 수 있습니다.

일반적으로 해당 서비스의 자격증명을 맞게 수정하고 endpoint 설정 옵션을 변경하면 됩니다. endpoint는 보통 AWS_ENDPOINT 환경 변수로 정의합니다.

'endpoint' => env('AWS_ENDPOINT', 'https://minio.example.com'),

MinIO

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

AWS_URL=http://localhost:9000/local

WARNING

MinIO를 사용할 때 temporaryUrl 메서드로 임시 스토리지 URL을 생성하는 것은 지원되지 않습니다.

디스크 인스턴스 가져오기

Storage 파사드를 사용하면 설정된 모든 디스크와 상호작용할 수 있습니다. 예를 들어 기본 디스크에 아바타 이미지를 저장하려면 파사드의 put 메서드를 사용합니다. Storage 파사드에서 disk 메서드 호출 없이 메서드를 호출하면, 해당 메서드는 자동으로 기본 디스크에 대해 실행됩니다.

use Illuminate\Support\Facades\Storage;

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

애플리케이션이 여러 디스크를 사용한다면, Storage 파사드의 disk 메서드로 특정 디스크를 지정하여 파일 작업을 할 수 있습니다.

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

온디맨드 디스크

런타임에 동적으로 디스크 설정을 구성하고 싶을 때는 Storage 파사드의 build 메서드에 설정 배열을 전달합니다. config/filesystems.php에 미리 정의하지 않고도 디스크를 생성할 수 있습니다.

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

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

파일 조회

get 메서드로 파일의 내용을 가져올 수 있습니다. 파일 내용이 문자열로 반환됩니다. 모든 파일 경로는 디스크의 root 위치를 기준으로 하는 상대 경로로 지정해야 합니다.

$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 응답을 생성합니다. 두 번째 인수로 사용자에게 표시될 파일명을 지정할 수 있으며, 세 번째 인수로 HTTP 헤더 배열을 전달할 수 있습니다.

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

return Storage::download('file.jpg', '다운로드파일.jpg', $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 메서드를 사용하면 s3 드라이버로 저장된 파일에 대해 유효기간이 있는 임시 URL을 생성할 수 있습니다. 첫 번째 인수는 파일 경로, 두 번째 인수는 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=file2.jpg',
    ]
);

특정 디스크에 대해 임시 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 만료 시각을 받아 업로드 URL과 요청 시 포함해야 할 헤더가 담긴 연관 배열을 반환합니다.

use Illuminate\Support\Facades\Storage;

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

이 기능은 클라이언트가 Amazon S3 같은 클라우드 스토리지에 직접 파일을 업로드해야 하는 서버리스 환경에서 주로 활용됩니다.

파일 메타데이터

파일을 읽고 쓰는 것 외에도, Laravel은 파일 자체에 대한 정보를 제공하는 여러 메서드를 지원합니다.

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 메서드를 사용하면 파일 내용을 디스크에 저장할 수 있습니다. put 메서드에는 PHP resource를 전달할 수도 있으며, 이 경우 Flysystem의 스트림 지원을 활용합니다. 큰 파일을 다룰 때는 스트림 방식을 권장합니다. 모든 파일 경로는 디스크의 root 위치를 기준으로 하는 상대 경로로 지정해야 합니다.

use Illuminate\Support\Facades\Storage;

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

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

저장 실패 처리

파일 저장에 실패했을 때 예외 처리를 원한다면, 디스크 설정에서 throw 옵션을 정의할 수 있습니다.

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

throw 옵션이 false(기본값)이면 저장에 실패해도 put 같은 메서드들은 조용히 false를 반환합니다. true로 설정하면 League\Flysystem\UnableToWriteFile 예외가 발생합니다.

if (! Storage::put('file.jpg', $contents)) {
    // 파일을 저장하지 못했습니다...
}

파일 앞뒤에 내용 추가

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;

// 파일명을 자동으로 고유하게 생성합니다...
$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은 저장된 파일의 경로(파일명 포함)를 반환하므로, 이를 데이터베이스에 저장할 수 있습니다.

putFile과 putFileAs 메서드는 저장되는 파일의 가시성을 지정하는 인수도 받습니다. 이는 Amazon S3처럼 클라우드 디스크에 파일을 저장하면서 공개적으로 접근 가능하게 만들고 싶을 때 특히 유용합니다.

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

파일 업로드

웹 애플리케이션에서 파일 업로드는 가장 일반적인 파일 저장 사례 중 하나입니다. Laravel은 업로드된 파일 인스턴스의 store 메서드를 사용하면 손쉽게 파일을 저장할 수 있습니다. 파일을 저장할 경로를 인수로 전달하여 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 타입을 검사하여 자동으로 결정됩니다. store 메서드는 저장된 파일의 경로(파일명 포함)를 반환하므로, 이를 데이터베이스에 저장할 수 있습니다.

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의 파일 저장 메서드에 전달하기 전에 직접 정제하는 것을 권장합니다. 파일 경로는 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'
);

파일 가시성

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');

업로드된 파일을 다룰 때는 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 파일에서 수정할 수 있습니다.

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

이미지 조작

이미지를 리사이징하거나 변환해야 한다면 Laravel의 공식 이미지 조작 패키지인 Intervention Image를 활용할 수 있습니다. Composer로 설치하고 사용하는 방법은 해당 패키지 문서를 참고하세요.

파일 삭제

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);

$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 클래스의 파일 생성 유틸리티와 함께 사용하면 파일 업로드 테스트가 훨씬 간편해집니다.

<?php

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

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

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

    // 파일이 저장되었는지 확인합니다...
    Storage::disk('photos')->assertExists('photo1.jpg');

    // 파일이 존재하지 않는지 확인합니다...
    Storage::disk('photos')->assertMissing('missing.jpg');
});

<?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', [
            'photo' => UploadedFile::fake()->image('photo1.jpg'),
        ]);

        // 파일이 저장되었는지 확인합니다...
        Storage::disk('photos')->assertExists('photo1.jpg');

        // 파일이 존재하지 않는지 확인합니다...
        Storage::disk('photos')->assertMissing('missing.jpg');
    }
}

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

WARNING

image 메서드를 사용하려면 GD 확장 모듈이 필요합니다.

커스텀 파일시스템

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 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에 정의된 해당 디스크의 설정 값이 담겨 있습니다.

확장 서비스 프로바이더를 만들고 등록했다면, config/filesystems.php에서 dropbox 드라이버를 사용하는 디스크를 정의하면 됩니다.

파일 저장소

소개

Laravel은 Frank de Jonge가 만든 Flysystem PHP 패키지를 기반으로 강력한 파일시스템 추상화 레이어를 제공합니다. 로컬 파일시스템, SFTP, Amazon S3 등 다양한 저장소를 일관된 API로 다룰 수 있으며, 로컬 개발 환경과 프로덕션 서버 간 전환도 코드 변경 없이 설정만으로 처리할 수 있습니다.

설정

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

local 드라이버는 Laravel 애플리케이션이 실행되는 서버의 로컬 파일을 다루고, sftp 드라이버는 SSH 키 기반의 FTP 접속에 사용됩니다. 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=ap-northeast-2
AWS_BUCKET=<your-bucket-name>
AWS_USE_PATH_STYLE_ENDPOINT=false

NOTE

한국 리전을 사용한다면 AWS_DEFAULT_REGION을 ap-northeast-2(서울)로 설정하세요.

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"

Laravel의 Flysystem은 SFTP와도 잘 연동되지만, 기본 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)를 사용하면 모든 경로에 특정 경로 접두사가 자동으로 붙는 파일시스템을 정의할 수 있습니다. 스코프 디스크를 만들기 전에 Composer로 추가 패키지를 설치해야 합니다.

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

scoped 드라이버를 사용하는 디스크를 정의하면 기존 디스크에 경로 접두사를 적용한 인스턴스를 만들 수 있습니다. 예를 들어, 기존 s3 디스크에 특정 경로 접두사를 적용한 디스크를 정의하면, 해당 디스크를 통한 모든 파일 작업에 지정된 접두사가 자동으로 붙습니다.

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

읽기 전용 디스크를 사용하면 쓰기 작업이 허용되지 않는 파일시스템 디스크를 만들 수 있습니다. read-only 옵션을 사용하기 전에 Composer로 추가 패키지를 설치해야 합니다.

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를 제공하는 다양한 스토리지 서비스와도 함께 사용할 수 있습니다. 예를 들어 RustFS, DigitalOcean Spaces, Vultr Object Storage, Cloudflare R2, Hetzner Cloud Storage 등이 이에 해당합니다.

일반적으로 사용할 서비스의 인증 정보로 디스크 설정을 업데이트한 뒤, endpoint 설정 옵션 값만 변경하면 됩니다. 이 값은 보통 AWS_ENDPOINT 환경 변수로 지정합니다.

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

디스크 인스턴스 가져오기

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

use Illuminate\Support\Facades\Storage;

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

애플리케이션에서 여러 디스크를 사용하는 경우, disk 메서드로 특정 디스크를 지정할 수 있습니다:

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

온디맨드 디스크

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()->plus(minutes: 5)
);

로컬 임시 URL 활성화

local 드라이버에 임시 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()->plus(minutes: 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 및 local 드라이버에서만 지원됩니다.

클라이언트 측 애플리케이션에서 파일을 직접 업로드할 수 있는 임시 URL이 필요하다면 temporaryUploadUrl 메서드를 사용합니다. 파일 경로와 URL 만료 시각을 나타내는 DateTime 인스턴스를 인수로 전달하면, 업로드 URL과 함께 요청에 포함해야 할 헤더가 연관 배열로 반환됩니다:

use Illuminate\Support\Facades\Storage;

['url' => $url, 'headers' => $headers] = Storage::temporaryUploadUrl(
    'file.jpg', now()->plus(minutes: 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의 스트림 기능을 활용합니다. 파일 경로는 모두 해당 디스크에 설정된 "루트" 위치를 기준으로 한 상대 경로로 지정해야 합니다.

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');

자동 스트리밍

파일을 스트리밍 방식으로 저장하면 메모리 사용량을 크게 줄일 수 있습니다. putFile 또는 putFileAs 메서드를 사용하면 Laravel이 자동으로 스트리밍을 처리합니다. 이 메서드들은 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 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 메서드는 기본 디스크를 사용합니다. 다른 디스크를 사용하려면 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();

그러나 이 두 메서드는 안전하지 않은 것으로 간주됩니다. 악의적인 사용자가 파일명과 확장자를 조작할 수 있기 때문입니다. 따라서 일반적으로는 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'
);

이미지 조작

업로드된 이미지를 저장하기 전에 크기 조정, 자르기, 포맷 변환 등의 처리가 필요하다면 Laravel의 이미지 조작 기능을 활용할 수 있습니다.

$path = $request->image('avatar')
    ->cover(400, 400)
    ->toWebp()
    ->storePublicly('avatars', 'public');

파일시스템 디스크에 이미 저장된 파일로 이미지 인스턴스를 생성하는 것도 가능합니다.

$image = Storage::disk('public')->image('avatars/photo.jpg');

로컬 파일과 공개 여부

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');

    // 디스크에 파일이 하나도 없는지 확인...
    Storage::disk('photos')->assertEmpty();
});

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');

        // 디스크에 파일이 하나도 없는지 확인...
        Storage::disk('photos')->assertEmpty();
    }
}

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

WARNING

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

파일 저장소

커스텀 파일시스템

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 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

AppServiceProvider 외에 별도의 서비스 프로바이더(예: FilesystemServiceProvider)를 만들어 드라이버 등록 로직을 분리하면, 프로젝트 규모가 커질수록 유지보수가 훨씬 쉬워집니다.

확장 드라이버를 서비스 프로바이더에 등록했다면, 이제 config/filesystems.php 설정 파일에서 dropbox 드라이버를 디스크로 지정해 사용할 수 있습니다.

// config/filesystems.php

'disks' => [

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

],

이후에는 다른 디스크와 동일하게 Storage::disk('dropbox') 형태로 접근하면 됩니다.