Skip to content

檔案儲存

簡介

Laravel 透過 Frank de Jonge 所開發的優秀 Flysystem PHP 套件,提供了強大的檔案系統抽象層。Laravel 的 Flysystem 整合提供了簡單的驅動,可用於操作本機檔案系統、SFTP 以及 Amazon S3。更棒的是,在本地開發機器與正式伺服器之間切換這些儲存選項非常簡單,因為各系統的 API 完全相同。

設定

Laravel 的檔案系統設定檔位於 config/filesystems.php。在此檔案中,你可以設定所有的檔案系統「磁碟 (disks)」。每個磁碟都代表一個特定的儲存驅動與儲存位置。設定檔中包含了每個支援驅動的範例設定,因此你可以修改這些設定以反映你的儲存偏好設定與憑證。

local 驅動負責與運行 Laravel 應用程式的伺服器本地儲存檔案進行互動,而 sftp 儲存驅動則用於基於 SSH 金鑰的 FTP。s3 驅動則用於寫入 Amazon 的 S3 雲端儲存服務。

📌 備註

你可以依需求設定任意數量的磁碟,甚至可以有多個磁碟使用相同的驅動。

Local 驅動

當使用 local 驅動時,所有的檔案操作都是相對於 filesystems 設定檔中定義的 root 目錄。預設情況下,此值設定為 storage/app/private 目錄。因此,以下方法將會寫入至 storage/app/private/example.txt

php
use Illuminate\Support\Facades\Storage;

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

Public 磁碟

應用程式的 filesystems 設定檔中所包含的 public 磁碟,適用於將公開存取的檔案。預設情況下,public 磁碟使用 local 驅動並將其檔案儲存在 storage/app/public 中。

如果你的 public 磁碟使用 local 驅動,且你希望讓這些檔案可以從網頁存取,你應該建立一個從來源目錄 storage/app/public 指向目標目錄 public/storage 的符號連結:

若要建立符號連結,你可以使用 storage:link Artisan 指令:

shell
php artisan storage:link

當檔案儲存且符號連結建立完成後,你可以使用 asset 輔助函式建立指向該檔案的 URL:

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

你可以在 filesystems 設定檔中設定額外的符號連結。當你執行 storage:link 指令時,將會建立每個已設定的連結:

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

storage:unlink 指令可用於刪除已設定的符號連結:

shell
php artisan storage:unlink

驅動先決條件

S3 驅動設定

在使用 S3 驅動之前,你將需要透過 Composer 套件管理器安裝 Flysystem S3 套件:

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

S3 磁碟設定陣列位於你的 config/filesystems.php 設定檔中。通常,你應該使用由 config/filesystems.php 設定檔引用的以下環境變數來設定你的 S3 資訊與憑證:

ini
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

為了方便起見,這些環境變數與 AWS CLI 所使用的命名慣例一致。

FTP 驅動設定

在使用 FTP 驅動之前,你將需要透過 Composer 套件管理器安裝 Flysystem FTP 套件:

shell
composer require league/flysystem-ftp "^3.0"

Laravel 的 Flysystem 整合與 FTP 配合得很好;然而,框架預設的 config/filesystems.php 設定檔中並未包含範例設定。如果你需要設定 FTP 檔案系統,可以使用下方的設定範例:

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

    // Optional FTP Settings...
    // 'port' => env('FTP_PORT', 21),
    // 'root' => env('FTP_ROOT'),
    // 'passive' => true,
    // 'ssl' => true,
    // 'timeout' => 30,
],

SFTP 驅動設定

在使用 SFTP 驅動之前,你將需要透過 Composer 套件管理器安裝 Flysystem SFTP 套件:

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

Laravel 的 Flysystem 整合與 SFTP 配合得很好;然而,框架預設的 config/filesystems.php 設定檔中並未包含範例設定。如果你需要設定 SFTP 檔案系統,可以使用下方的設定範例:

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

    // Settings for basic authentication...
    'username' => env('SFTP_USERNAME'),
    'password' => env('SFTP_PASSWORD'),

    // Settings for SSH key-based authentication with encryption password...
    'privateKey' => env('SFTP_PRIVATE_KEY'),
    'passphrase' => env('SFTP_PASSPHRASE'),

    // Settings for file / directory permissions...
    'visibility' => 'private', // `private` = 0600, `public` = 0644
    'directory_visibility' => 'private', // `private` = 0700, `public` = 0755

    // Optional SFTP Settings...
    // 'hostFingerprint' => env('SFTP_HOST_FINGERPRINT'),
    // 'maxTries' => 4,
    // 'passphrase' => env('SFTP_PASSPHRASE'),
    // 'port' => env('SFTP_PORT', 22),
    // 'root' => env('SFTP_ROOT', ''),
    // 'timeout' => 30,
    // 'useAgent' => true,
],

限制作用域與唯讀檔案系統

限制作用域的磁碟允許你定義一個自動為所有路徑加上指定路徑前綴的檔案系統。在建立限制作用域的檔案系統磁碟之前,你將需要透過 Composer 套件管理器安裝額外的 Flysystem 套件:

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

你可以透過定義使用 scoped 驅動的磁碟,來為任何現有的檔案系統磁碟建立具路徑作用域的實例。例如,你可以建立一個將現有 s3 磁碟限制在特定路徑前綴的磁碟,接著使用該作用域磁碟的每個檔案操作都將使用指定的前綴:

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

「唯讀」磁碟允許你建立不允許寫入操作的檔案系統磁碟。在使用 read-only 設定選項之前,你將需要透過 Composer 套件管理器安裝額外的 Flysystem 套件:

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

接著,你可以在一個或多個磁碟的設定陣列中加入 read-only 設定選項:

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

相容 Amazon S3 的檔案系統

預設情況下,應用程式的 filesystems 設定檔包含一個 s3 磁碟的磁碟設定。除了使用此磁碟與 Amazon S3 互動之外,你還可以使用它與任何相容於 S3 的檔案儲存服務進行互動,例如 RustFSDigitalOcean SpacesVultr Object StorageCloudflare R2Hetzner Cloud Storage

通常,在更新磁碟憑證以符合你打算使用的服務憑證之後,你只需要更新 endpoint 設定選項的值即可。此選項的值通常透過 AWS_ENDPOINT 環境變數來定義:

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

取得磁碟實例

Storage Facade 可用於與您設定的任何磁碟進行互動。例如,您可以使用該 Facade 上的 put 方法將大頭貼儲存到預設磁碟。如果您在呼叫 Storage Facade 上的方法時沒有先呼叫 disk 方法,該方法將會自動傳遞給預設磁碟:

php
use Illuminate\Support\Facades\Storage;

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

如果您的應用程式與多個磁碟進行互動,您可以使用 Storage Facade 上的 disk 方法來操作特定磁碟上的檔案:

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

隨需磁碟

有時候您可能希望在執行時期使用給定的設定來建立磁碟,而該設定實際上並不存在於應用程式的 filesystems 設定檔中。若要達成此目的,您可以將設定陣列傳遞給 Storage Facade 的 build 方法:

php
use Illuminate\Support\Facades\Storage;

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

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

讀取檔案

get 方法可用於取得檔案的內容。該方法將返回檔案的原始字串內容。請記住,所有檔案路徑都應該相對於為磁碟設定的「根」位置:

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

如果你讀取的檔案包含 JSON,你可以使用 json 方法來取得檔案並解析其內容:

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

exists 方法可用於判斷磁碟上是否存在某個檔案:

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

missing 方法可用於判斷磁碟上是否缺少某個檔案:

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

下載檔案

download 方法可用於產生一個回應,強制使用者的瀏覽器下載指定路徑的檔案。download 方法接受檔案名稱作為第二個引數,這將決定下載檔案的使用者所看到的檔案名稱。最後,你可以傳遞一個 HTTP 標頭陣列作為該方法的第三個引數:

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

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

檔案 URL

你可以使用 url 方法來取得指定檔案的 URL。如果你使用的是 local 驅動,這通常只會在給定路徑前加上 /storage 並返回該檔案的相對 URL。如果你使用的是 s3 驅動,則會返回完整的遠端 URL:

php
use Illuminate\Support\Facades\Storage;

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

當使用 local 驅動時,所有應該要能公開存取的檔案都應該放置在 storage/app/public 目錄中。此外,你應該在 public/storage 建立一個符號連結 指向 storage/app/public 目錄。

⚠️ 警告

當使用 local 驅動時,url 的回傳值不會進行 URL 編碼。因此,我們建議一律使用能建立有效 URL 的名稱來儲存檔案。

URL 主機自訂

如果你想要修改使用 Storage Facade 產生的 URL 的主機,可以在磁碟的設定陣列中新增或變更 url 選項:

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

暫時性 URL

使用 temporaryUrl 方法,你可以為使用 locals3 驅動儲存的檔案建立暫時性 URL。此方法接受一個路徑和一個指定 URL 何時過期的 DateTime 實例:

php
use Illuminate\Support\Facades\Storage;

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

啟用 Local 暫時性 URL

如果你在 local 驅動支援暫時性 URL 之前就已經開始開發應用程式,你可能需要啟用本機暫時性 URL。為此,請在 config/filesystems.php 設定檔中的 local 磁碟設定陣列中新增 serve 選項:

php
'local' => [
    'driver' => 'local',
    'root' => storage_path('app/private'),
    'serve' => true, 
    'throw' => false,
],

S3 請求參數

如果你需要指定額外的 S3 請求參數,可以將請求參數陣列作為第三個引數傳遞給 temporaryUrl 方法:

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

自訂暫時性 URL

如果你需要為特定儲存磁碟自訂暫時性 URL 的建立方式,可以使用 buildTemporaryUrlsUsing 方法。舉例來說,如果你有一個控制器允許下載透過通常不支援暫時性 URL 的磁碟儲存的檔案,這會很有用。通常,此方法應該在服務提供者的 boot 方法中呼叫:

php
<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap any application services.
     */
    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

⚠️ 警告

產生暫時性上傳 URL 的功能僅由 s3local 驅動支援。

如果你需要產生一個可用於直接從用戶端應用程式上傳檔案的暫時性 URL,可以使用 temporaryUploadUrl 方法。此方法接受一個路徑和一個指定 URL 何時過期的 DateTime 實例。temporaryUploadUrl 方法會返回一個關聯陣列,可解構為上傳 URL 以及上傳請求中應包含的標頭:

php
use Illuminate\Support\Facades\Storage;

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

此方法主要用於無伺服器 (Serverless) 環境,需要用戶端應用程式直接將檔案上傳到 Amazon S3 等雲端儲存系統。

檔案詮釋資料

除了讀取和寫入檔案之外,Laravel 還可以提供有關檔案本身的資訊。例如,size 方法可用於取得檔案的大小(以位元組為單位):

php
use Illuminate\Support\Facades\Storage;

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

lastModified 方法會返回上次修改檔案時的 UNIX 時間戳記:

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

指定檔案的 MIME 類型可以透過 mimeType 方法取得:

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

檔案路徑

你可以使用 path 方法來取得指定檔案的路徑。如果你使用的是 local 驅動,這將返回檔案的絕對路徑。如果你使用的是 s3 驅動,此方法將返回 S3 儲存貯體 (Bucket) 中檔案的相對路徑:

php
use Illuminate\Support\Facades\Storage;

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

儲存檔案

put 方法可用於將檔案內容儲存到磁碟上。您也可以傳遞 PHP resourceput 方法,這將會使用 Flysystem 底層的串流支援。請記住,所有檔案路徑都應該相對於為磁碟設定的「根 (root)」目錄位置來指定:

php
use Illuminate\Support\Facades\Storage;

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

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

寫入失敗

如果 put 方法(或其他「寫入」操作)無法將檔案寫入磁碟,將會回傳 false

php
if (! Storage::put('file.jpg', $contents)) {
    // The file could not be written to disk...
}

如果您願意,可以在檔案系統磁碟的設定陣列中定義 throw 選項。當此選項定義為 true 時,在寫入操作失敗時,像 put 這樣的「寫入」方法將會拋出 League\Flysystem\UnableToWriteFile 的實例:

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

在檔案前置與附加內容

prependappend 方法允許您在檔案的開頭或結尾寫入內容:

php
Storage::prepend('file.log', 'Prepended Text');

Storage::append('file.log', 'Appended Text');

複製與移動檔案

copy 方法可用於將現有檔案複製到磁碟上的新位置,而 move 方法可用於重新命名現有檔案或將其移動到新位置:

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

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

自動串流

將檔案串流至儲存空間可大幅降低記憶體用量。如果您希望 Laravel 自動管理將指定檔案串流到儲存位置,可以使用 putFileputFileAs 方法。此方法接受 Illuminate\Http\FileIlluminate\Http\UploadedFile 實例,並會自動將檔案串流至您想要的位置:

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

// Automatically generate a unique ID for filename...
$path = Storage::putFile('photos', new File('/path/to/photo'));

// Manually specify a filename...
$path = Storage::putFileAs('photos', new File('/path/to/photo'), 'photo.jpg');

關於 putFile 方法,有幾點需要特別注意。請注意,我們只指定了目錄名稱而不是檔案名稱。預設情況下,putFile 方法會產生一個唯一 ID 作為檔案名稱。副檔名將透過檢查檔案的 MIME 類型來決定。檔案路徑將由 putFile 方法回傳,以便您可以將包含所產生檔名的路徑儲存在資料庫中。

putFileputFileAs 方法也接受一個引數來指定儲存檔案的「能見度 (visibility)」。如果您將檔案儲存在 Amazon S3 等雲端磁碟上,並希望透過產生的 URL 公開存取該檔案,這會特別有用:

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

檔案上傳

在 Web 應用程式中,儲存檔案最常見的使用案例之一就是儲存使用者上傳的檔案,例如相片與文件。Laravel 透過上傳檔案實例上的 store 方法,讓儲存上傳的檔案變得非常容易。呼叫 store 方法並傳入您想要儲存上傳檔案的路徑:

php
<?php

namespace App\Http\Controllers;

use Illuminate\Http\Request;

class UserAvatarController extends Controller
{
    /**
     * Update the avatar for the user.
     */
    public function update(Request $request): string
    {
        $path = $request->file('avatar')->store('avatars');

        return $path;
    }
}

關於這個範例,有幾點需要特別注意。請注意,我們只指定了目錄名稱,而不是檔案名稱。預設情況下,store 方法會產生一個唯一 ID 作為檔案名稱。副檔名將透過檢查檔案的 MIME 類型來決定。檔案路徑將由 store 方法回傳,以便您可以將包含所產生檔名的路徑儲存在資料庫中。

您也可以呼叫 Storage Facade 上的 putFile 方法來執行與上述範例相同的檔案儲存操作:

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

指定檔案名稱

如果您不希望系統自動指派檔案名稱給儲存的檔案,可以使用 storeAs 方法,該方法接收路徑、檔案名稱以及(選填的)磁碟作為其引數:

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

您也可以使用 Storage Facade 上的 putFileAs 方法,這將執行與上述範例相同的檔案儲存操作:

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

⚠️ 警告

無法列印與無效的 Unicode 字元將自動從檔案路徑中移除。因此,在將檔案路徑傳遞給 Laravel 的檔案儲存方法之前,您可能希望先清理您的檔案路徑。檔案路徑會使用 League\Flysystem\WhitespacePathNormalizer::normalizePath 方法進行規格化處理。

指定磁碟

預設情況下,上傳檔案的 store 方法將使用您的預設磁碟。如果您想要指定另一個磁碟,請將磁碟名稱作為第二個引數傳遞給 store 方法:

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

如果您使用的是 storeAs 方法,可以將磁碟名稱作為第三個引數傳遞給該方法:

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

其他上傳檔案資訊

如果您想要取得上傳檔案的原始名稱與副檔名,可以使用 getClientOriginalNamegetClientOriginalExtension 方法:

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

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

然而,請記住 getClientOriginalNamegetClientOriginalExtension 方法被認為是不安全的,因為檔案名稱與副檔名可能會被惡意使用者竄改。基於這個原因,您通常應該優先使用 hashNameextension 方法來取得上傳檔案的名稱與副檔名:

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

$name = $file->hashName(); // Generate a unique, random name...
$extension = $file->extension(); // Determine the file's extension based on the file's MIME type...

檔案能見度

在 Laravel 的 Flysystem 整合中,「能見度 (visibility)」是跨多個平台檔案權限的抽象化概念。檔案可以被宣告為 publicprivate。當檔案被宣告為 public 時,代表您指明該檔案通常可供其他人存取。例如,使用 S3 驅動時,您可以讀取 public 檔案的 URL。

您可以在透過 put 方法寫入檔案時設定能見度:

php
use Illuminate\Support\Facades\Storage;

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

如果檔案已經儲存,可以透過 getVisibilitysetVisibility 方法來讀取與設定其能見度:

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

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

在處理上傳檔案時,您可以使用 storePubliclystorePubliclyAs 方法以 public 能見度儲存上傳的檔案:

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

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

圖片處理

若您在上傳圖片並儲存之前需要調整大小、裁切或轉換格式,可以使用 Laravel 的圖片處理功能

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

您也可以從已儲存在其中一個檔案系統磁碟上的檔案建立圖片實例:

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

本地檔案與能見度

使用 local 驅動時,public 能見度 會轉換為目錄的 0755 權限與檔案的 0644 權限。您可以在應用程式的 filesystems 設定檔中修改這些權限對應關係:

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

刪除檔案

delete 方法接受單一檔名或要刪除的檔案陣列:

php
use Illuminate\Support\Facades\Storage;

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

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

如有需要,您可以指定應從哪個磁碟刪除檔案:

php
use Illuminate\Support\Facades\Storage;

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

目錄

取得目錄內的所有檔案

files 方法會回傳指定目錄內所有檔案的陣列。如果您想要取得指定目錄內包含子目錄的所有檔案清單,可以使用 allFiles 方法:

php
use Illuminate\Support\Facades\Storage;

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

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

取得目錄內的所有目錄

directories 方法會回傳指定目錄內所有目錄的陣列。如果您想要取得指定目錄內包含子目錄的所有目錄清單,可以使用 allDirectories 方法:

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

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

建立目錄

makeDirectory 方法將會建立指定的目錄,包含任何所需的子目錄:

php
Storage::makeDirectory($directory);

刪除目錄

最後,deleteDirectory 方法可用於移除一個目錄及其所有檔案:

php
Storage::deleteDirectory($directory);

測試

Storage Facade 的 fake 方法讓您可以輕鬆產生一個模擬磁碟,結合 Illuminate\Http\UploadedFile 類別的檔案產生工具後,能大幅簡化檔案上傳的測試。例如:

php
<?php

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

test('albums can be uploaded', function () {
    Storage::fake('photos');

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

    // Assert one or more files were stored...
    Storage::disk('photos')->assertExists('photo1.jpg');
    Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);

    // Assert one or more files were not stored...
    Storage::disk('photos')->assertMissing('missing.jpg');
    Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);

    // Assert that the number of files in a given directory matches the expected count...
    Storage::disk('photos')->assertCount('/wallpapers', 2);

    // Assert that a given directory is empty...
    Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');

    // Assert that the disk contains no files...
    Storage::disk('photos')->assertEmpty();
});
php
<?php

namespace Tests\Feature;

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

class ExampleTest extends TestCase
{
    public function test_albums_can_be_uploaded(): void
    {
        Storage::fake('photos');

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

        // Assert one or more files were stored...
        Storage::disk('photos')->assertExists('photo1.jpg');
        Storage::disk('photos')->assertExists(['photo1.jpg', 'photo2.jpg']);

        // Assert one or more files were not stored...
        Storage::disk('photos')->assertMissing('missing.jpg');
        Storage::disk('photos')->assertMissing(['missing.jpg', 'non-existing.jpg']);

        // Assert that the number of files in a given directory matches the expected count...
        Storage::disk('photos')->assertCount('/wallpapers', 2);

        // Assert that a given directory is empty...
        Storage::disk('photos')->assertDirectoryEmpty('/wallpapers');

        // Assert that the disk contains no files...
        Storage::disk('photos')->assertEmpty();
    }
}

預設情況下,fake 方法會刪除其暫存目錄中的所有檔案。如果您想要保留這些檔案,可以改用 "persistentFake" 方法。如需更多關於測試檔案上傳的資訊,您可以參考 HTTP 測試文件中關於檔案上傳的資訊

⚠️ 警告

image 方法需要 GD 擴充功能

自訂檔案系統

Laravel 的 Flysystem 整合開箱即提供數種「驅動」支援;然而,Flysystem 並不限於這些,它還擁有許多適用於其他儲存系統的介接器 (Adapters)。如果您想在 Laravel 應用程式中使用這些額外的介接器,可以建立自訂驅動。

為了定義自訂檔案系統,您需要一個 Flysystem 介接器。讓我們將社群維護的 Dropbox 介接器新增至專案中:

shell
composer require spatie/flysystem-dropbox

接著,您可以在應用程式的某個服務提供者(Service Providers)boot 方法中註冊該驅動。為此,您應該使用 Storage Facade 的 extend 方法:

php
<?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
{
    /**
     * Register any application services.
     */
    public function register(): void
    {
        // ...
    }

    /**
     * Bootstrap any application services.
     */
    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 驅動了。