Skip to content

檔案儲存

簡介

Laravel 藉由 Frank de Jonge 開發的 Flysystem 這個優秀的 PHP 套件,提供了一個強大的檔案系統抽象層。Laravel 的 Flysystem 整合為處理本地檔案系統、SFTP 和 Amazon S3 提供了簡單的驅動程式。更棒的是,在您的本地開發機器和生產伺服器之間切換這些儲存選項變得異常簡單,因為它們的 API 對於每個系統都保持一致。

設定

Laravel 的檔案系統設定檔位於 config/filesystems.php。在此檔案中,您可以設定所有檔案系統的「磁碟」。每個磁碟代表一個特定的儲存驅動程式和儲存位置。組態檔中包含了每個支援驅動程式的範例設定,因此您可以修改設定以反映您的儲存偏好和憑證。

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

📌 備註

您可以設定任意數量的磁碟,甚至可以有多個使用相同驅動程式的磁碟。

本地端驅動程式

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

php
use Illuminate\Support\Facades\Storage;

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

公開磁碟

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

如果您的 public 磁碟使用 local 驅動程式,且您希望將這些檔案從網路上存取,您應該建立一個從原始目錄 storage/app/public 到目標目錄 public/storage 的符號連結:

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

shell
php artisan storage:link

儲存檔案並建立符號連結後,您可以使用 asset 輔助函式建立檔案的網址:

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 設定檔中。通常,您應該使用下列環境變數來設定您的 S3 資訊和憑證,這些變數會被 config/filesystems.php 設定檔所引用:

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 配合良好;不過,Laravel 預設的 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 配合良好;不過,Laravel 預設的 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 相容的檔案儲存服務互動,例如 MinIODigitalOcean SpacesVultr Object StorageCloudflare R2Hetzner Cloud Storage

通常,在更新磁碟的認證以匹配您計劃使用的服務的認證後,您只需要更新 endpoint 設定選項的值。此選項的值通常透過 AWS_ENDPOINT 環境變數定義:

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

MinIO

為了讓 Laravel 的 Flysystem 整合在使用 MinIO 時能產生正確的網址,您應該定義 AWS_URL 環境變數,使其符合您應用程式的本地網址,並將儲存桶名稱包含在網址路徑中:

ini
AWS_URL=http://localhost:9000/local

⚠️ 警告

當使用 MinIO 時,若 endpoint 無法由用戶端存取,透過 temporaryUrl 方法產生的暫存儲存網址可能無法正常運作。

取得磁碟實例

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

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 方法來取得指定檔案的網址。如果您使用的是 local 驅動程式,這通常只會在給定路徑前加上 /storage 並返回檔案的相對網址。如果您使用的是 s3 驅動程式,則會返回完整的遠端網址:

php
use Illuminate\Support\Facades\Storage;

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

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

⚠️ 警告

當使用 local 驅動程式時,url 的返回值不會進行 URL 編碼。因此,我們建議您始終使用能夠生成有效網址的名稱來儲存檔案。

網址主機自訂

如果您想修改使用 Storage facade 所生成的網址主機,您可以在磁碟的設定陣列中新增或變更 url 選項:

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

暫存網址

使用 temporaryUrl 方法,您可以為儲存在 locals3 驅動程式中的檔案建立暫存網址。此方法接受一個路徑和一個 DateTime 實例,指定網址何時過期:

php
use Illuminate\Support\Facades\Storage;

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

啟用本地端暫存網址

如果您在 local 驅動程式支援暫存網址之前就已開始開發應用程式,您可能需要啟用本地端暫存網址。為此,請在 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',
    ]
);

自訂暫存網址

如果您需要自訂特定儲存磁碟的暫存網址建立方式,您可以使用 buildTemporaryUrlsUsing 方法。例如,如果您有一個控制器允許您下載儲存在通常不支援暫存網址的磁碟上的檔案,這將非常有用。通常,這個方法應該從服務提供者的 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])
                );
            }
        );
    }
}

暫存上傳網址

⚠️ 警告

s3 驅動程式支援生成暫存上傳網址的功能。

如果您需要生成一個可用於從用戶端應用程式直接上傳檔案的暫存網址,您可以使用 temporaryUploadUrl 方法。此方法接受一個路徑和一個 DateTime 實例,指定網址的到期時間。temporaryUploadUrl 方法返回一個關聯陣列,可以將其解構為上傳網址和上傳請求應包含的標頭:

php
use Illuminate\Support\Facades\Storage;

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

此方法主要用於需要用戶端應用程式直接將檔案上傳到像 Amazon S3 這樣的雲端儲存系統的無伺服器環境。

檔案中繼資料

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

php
use Illuminate\Support\Facades\Storage;

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

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

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

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

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

檔案路徑

您可以使用 path 方法來取得指定檔案的路徑。如果您使用的是 local 驅動程式,這將返回檔案的絕對路徑。如果您使用的是 s3 驅動程式,此方法將返回檔案在 S3 儲存桶中的相對路徑:

php
use Illuminate\Support\Facades\Storage;

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

儲存檔案

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

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)) {
    // 檔案無法寫入磁碟...
}

如果您願意,可以在檔案系統磁碟的設定陣列中定義 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 方法也接受一個參數來指定已儲存檔案的「可見性」。如果您正在將檔案儲存到像 Amazon S3 這樣的雲端磁碟,並且希望該檔案能透過產生的網址公開存取,這點特別有用:

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

檔案上傳

在網頁應用程式中,儲存檔案最常見的用途之一是儲存使用者上傳的檔案,例如相片和文件。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 整合中,「可見性」是對多個平台檔案權限的一種抽象。檔案可以宣告為 publicprivate。當檔案宣告為 public 時,您表示該檔案通常應可供他人存取。例如,在使用 S3 驅動程式時,您可以擷取 public 檔案的網址。

您可以在透過 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'
);

本機檔案與可見性

使用 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');
});
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');
    }
}

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

⚠️ 警告

image 方法需要 GD 擴充套件

自訂檔案系統

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

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

shell
composer require spatie/flysystem-dropbox

接下來,您可以在您應用程式其中一個 服務提供者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 驅動程式了。