laravel
5. 深入探讨
文件存储

介绍

得益于 Frank de Jonge 出色的 Flysystem (opens in a new tab) PHP 包,Laravel 提供了强大的文件系统抽象。Laravel 的 Flysystem 集成提供了用于处理本地文件系统、SFTP 和亚马逊 S3 的简单驱动程序。更妙的是,在本地开发机器和生产服务器之间切换这些存储选项非常简单,因为每个系统的 API 都是相同的。

配置

Laravel 的文件系统配置文件位于 config/filesystems.php。在这个文件中,您可以配置所有的文件系统“磁盘”。每个磁盘代表一个特定的存储驱动程序和存储位置。配置文件中包含了每个支持的驱动程序的示例配置,因此您可以修改配置以反映您的存储偏好和凭据。

local 驱动程序与在运行 Laravel 应用程序的服务器上本地存储的文件进行交互,而 s3 驱动程序用于写入亚马逊的 S3 云存储服务。

[!注意]
您可以根据需要配置任意数量的磁盘,甚至可以有多个使用相同驱动程序的磁盘。

本地驱动程序

当使用 local 驱动程序时,所有文件操作都相对于您在 filesystems 配置文件中定义的 root 目录。默认情况下,此值设置为 storage/app 目录。因此,以下方法将写入 storage/app/example.txt

use Illuminate\Support\Facades\Storage;

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

公共磁盘

您应用程序的 filesystems 配置文件中包含的 public 磁盘旨在用于将可公开访问的文件。默认情况下,public 磁盘使用 local 驱动程序,并将其文件存储在 storage/app/public 中。

为了使这些文件可以从网络访问,您应该从 public/storagestorage/app/public 创建一个符号链接。利用此文件夹约定,当您使用像 Envoyer (opens in a new tab) 这样的零停机部署系统时,可以将您的可公开访问文件保存在一个目录中,以便在部署之间轻松共享。

要创建符号链接,您可以使用 storage:link 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

您的 config/filesystems.php 配置文件中有一个 S3 磁盘配置数组。通常,您应该使用以下由 config/filesystems.php 配置文件引用的环境变量来配置您的 S3 信息和凭据:

AWS_ACCESS_KEY_ID=<您的密钥 ID>
AWS_SECRET_ACCESS_KEY=<您的秘密访问密钥>
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=<您的桶名称>
AWS_USE_PATH_STYLE_ENDPOINT=false

为了方便起见,这些环境变量与 AWS CLI 使用的命名约定相匹配。

FTP 驱动程序配置

在使用 FTP 驱动程序之前,您需要通过 Composer 包管理器安装 Flysystem FTP 包:

composer require league/flysystem-ftp "^3.0"

Laravel 的 Flysystem 集成与 FTP 配合得很好;然而,框架的默认 config/filesystems.php 配置文件中未包含示例配置。如果您需要配置 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' => [
    '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,
],

作用域和只读文件系统

作用域磁盘允许您定义一个文件系统,其中所有路径都会自动以给定的路径前缀作为前缀。在创建作用域文件系统磁盘之前,您需要通过 Composer 包管理器安装一个额外的 Flysystem 包:

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

您可以通过定义一个使用 scoped 驱动程序的磁盘来创建任何现有文件系统磁盘的路径作用域实例。例如,您可以创建一个将现有 s3 磁盘作用域到特定路径前缀的磁盘,然后使用您的作用域磁盘的每个文件操作都将使用指定的前缀:

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

“只读”磁盘允许您创建不允许写入操作的文件系统磁盘。在使用 read-only 配置选项之前,您需要通过 Composer 包管理器安装一个额外的 Flysystem 包:

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

接下来,您可以在一个或多个磁盘的配置数组中包含 read-only 配置选项:

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

与亚马逊 S3 兼容的文件系统

默认情况下,您的应用程序的 filesystems 配置文件包含 s3 磁盘的磁盘配置。除了使用此磁盘与亚马逊 S3 进行交互外,您还可以使用它与任何与 S3 兼容的文件存储服务(如 MinIO (opens in a new tab)DigitalOcean Spaces (opens in a new tab))进行交互。

通常,在更新磁盘的凭据以匹配您计划使用的服务的凭据后,您只需要更新 endpoint 配置选项的值。此选项的值通常通过 AWS_ENDPOINT 环境变量定义:

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

MinIO

为了使 Laravel 的 Flysystem 集成在使用 MinIO 时生成正确的 URL,您应该定义 AWS_URL 环境变量,使其与您的应用程序的本地 URL 匹配,并在 URL 路径中包含桶名称:

AWS_URL=http://localhost:9000/local

[!警告]
如果客户端无法访问 endpoint,则在使用 MinIO 时通过 temporaryUrl 方法生成临时存储 URL 可能不起作用。

获取磁盘实例

可以使用 Storage 外观来与您配置的任何磁盘进行交互。例如,您可以在外观上使用 put 方法将头像存储在默认磁盘上。如果您在未先调用 disk 方法的情况下在 Storage 外观上调用方法,该方法将自动传递到默认磁盘:

use Illuminate\Support\Facades\Storage;

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

如果您的应用程序与多个磁盘进行交互,您可以在 Storage 外观上使用 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);

检索文件

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 方法可用于生成一个强制用户浏览器下载给定路径文件的响应。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 目录。

[!警告]
当使用 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 请求参数 (opens in a new tab),您可以将请求参数数组作为 temporaryUrl 方法的第三个参数传递:

$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

[!警告]
生成临时上传 URL 的功能仅由 s3 驱动程序支持。

如果您需要生成一个可用于从客户端应用程序直接上传文件的临时 URL,您可以使用 temporaryUploadUrl 方法。此方法接受一个路径和一个指定 URL 应何时过期的 DateTime 实例。temporaryUploadUrl 方法返回一个关联数组,该数组可以解构为上传 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');

给定文件的 MIME 类型可以通过 mimeType 方法获得:

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

文件路径

您可以使用 path 方法获取给定文件的路径。如果您使用的是 local 驱动程序,这将返回文件的绝对路径。如果您使用的是 s3 驱动程序,此方法将返回文件在 S3 桶中的相对路径:

use Illuminate\Support\Facades\Storage;
 
$path = Storage::path('file.jpg');

存储文件

put 方法可用于将文件内容存储在磁盘上。您还可以将 PHP resource 传递给 put 方法,这将使用 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,
],

在文件开头和结尾添加内容

prependappend 方法允许您在文件的开头或结尾写入内容:

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 自动管理将给定文件流式传输到您的存储位置,您可以使用 putFileputFileAs 方法。此方法接受 Illuminate\Http\FileIlluminate\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 方法将返回文件的路径,因此您可以将路径(包括生成的文件名)存储在数据库中。

putFileputFileAs 方法还接受一个参数来指定存储文件的“可见性”。如果您将文件存储在云磁盘(如 Amazon S3)上,并希望文件通过生成的 URL 公开访问,这将非常有用:

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

文件上传

在 Web 应用程序中,存储文件的最常见用例之一是存储用户上传的文件,如照片和文档。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]
不可打印和无效的 Unicode 字符将自动从文件路径中删除。因此,在将文件路径传递给 Laravel 的文件存储方法之前,您可能希望对其进行清理。文件路径使用 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'
);

其他上传文件信息

如果您想获取上传文件的原始名称和扩展名,可以使用 getClientOriginalNamegetClientOriginalExtension 方法:

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

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

但是,请记住,getClientOriginalNamegetClientOriginalExtension 方法被认为是不安全的,因为文件名和扩展名可能会被恶意用户篡改。因此,您通常应该更喜欢使用 hashNameextension 方法来为给定的文件上传获取名称和扩展名:

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

$name = $file->hashName(); // 生成一个唯一的随机名称...
$extension = $file->extension(); // 根据文件的 MIME 类型确定文件的扩展名...

文件可见性

在 Laravel 的 Flysystem 集成中,“可见性”是跨多个平台的文件权限的抽象。文件可以声明为 public(公共)或 private(私有)。当文件被声明为 public 时,表示该文件通常应该对其他人可访问。例如,当使用 S3 驱动程序时,您可以为 public 文件检索 URL。

您可以在通过 put 方法写入文件时设置可见性:

use Illuminate\Support\Facades\Storage;

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

如果文件已经存储,其可见性可以通过 getVisibilitysetVisibility 方法进行检索和设置:

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

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

当与上传的文件进行交互时,您可以使用 storePubliclystorePubliclyAs 方法以 public 可见性存储上传的文件:

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

如有必要,您可以指定应从哪个磁盘删除文件:

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('albums can be uploaded', 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')->assertDirectoryEmpty('/wallpapers');
});
<?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')
        ]);
 
        // 断言一个或多个文件已存储...
        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')->assertDirectoryEmpty('/wallpapers');
    }
}

默认情况下,fake 方法将删除其临时目录中的所有文件。如果您希望保留这些文件,可以使用 "persistentFake" 方法代替。有关测试文件上传的更多信息,您可以查阅 HTTP 测试文档中关于文件上传的信息

[!WARNING]
image 方法需要 GD 扩展 (opens in a new tab)

自定义文件系统

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 驱动程序。