文件存储

介绍

Laravel 提供了强大的文件系统抽象，得益于 Frank de Jonge 的 【Flysystem】 PHP 包。Laravel 的 Flysystem 集成提供了简单的驱动程序，用于处理本地文件系统、SFTP 和 Amazon S3。更棒的是，切换本地开发机和生产服务器之间的存储选项非常简单，因为每个系统的 API 保持一致。

配置

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

local 驱动程序用于与运行 Laravel 应用程序的服务器上存储的文件进行交互，而 s3 驱动程序则用于写入 Amazon 的 S3 云存储服务。

您可以配置任意数量的磁盘，甚至可以有多个磁盘使用相同的驱动程序。

本地驱动

当使用本地驱动（local driver）时，所有文件操作都是相对于你在文件系统配置文件中定义的 root 目录进行的。默认情况下，这个值设置为 storage/app 目录。因此，以下方法将写入 storage/app/example.txt：

use Illuminate\Support\Facades\Storage;

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

公共磁盘

应用程序的文件系统配置文件中包含的 public 驱动程序是为将公开访问的文件设计的。默认情况下，public 驱动程序使用 local 驱动程序，并将文件存储在 storage/app/public 目录中。

为了使这些文件可以通过 Web 访问，您应该创建一个符号链接，将源目录 storage/app/public 链接到目标目录 public/storage。使用这种文件夹约定可以将公开访问的文件集中存放在一个目录中，并且在使用如 Envoyer 这样的零停机部署系统时，能够方便地跨部署共享这些文件。

要创建符号链接，您可以使用 storage:link Artisan 命令：

php artisan storage:link

一旦文件被存储并且符号链接已经创建，您可以使用 asset 辅助函数创建文件的 URL：

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

您可以在文件系统配置文件中配置其它符号链接。每个配置的链接将在您运行 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 信息和凭证，这些变量在 config/filesystems.php 配置文件中引用：

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

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

作用域和只读文件系统

范围磁盘 (Scoped Disks)

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

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

您可以通过定义一个使用范围驱动程序的磁盘来创建任何现有文件系统磁盘的路径范围实例。例如，您可以创建一个磁盘，将现有的 S3 磁盘限定到特定的路径前缀，然后每次使用该范围磁盘执行文件操作时，都会使用指定的前缀：

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

只读磁盘 (Read-only Disks)

"只读" 磁盘允许您创建不允许写入操作的文件系统磁盘。在使用只读配置选项之前，您需要通过 Composer 包管理器安装额外的 Flysystem 包：

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

接下来，您可以在一个或多个磁盘的配置数组中包含只读配置选项：

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

兼容 Amazon S3 的文件系统

默认情况下，您的应用程序的文件系统配置文件包含一个用于 S3 磁盘的磁盘配置。除了使用该磁盘与 Amazon S3 交互外，您还可以使用它与任何兼容 S3 的文件存储服务进行交互，如 MinIO 或 DigitalOcean Spaces。

通常，在更新磁盘的凭据以匹配您打算使用的服务的凭据之后，您只需要更新 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

如果端点无法被客户端访问，那么在使用 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);

按需磁盘

有时您可能希望在运行时使用给定的配置创建一个磁盘，而该配置并未实际出现在应用程序的 filesystems.php 配置文件中。为了实现这一点，您可以将配置数组传递给 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。如果使用的是本地驱动程序，通常会在给定路径前加上 /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 facade 生成的 URL 的主机，您可以在磁盘的配置数组中添加或更改 url 选项：

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

临时 URL

您可以使用 temporaryUrl 方法为使用本地和 S3 驱动程序存储的文件创建临时 URL。该方法接受文件路径和一个 DateTime 实例，指定 URL 应该在何时过期：

use Illuminate\Support\Facades\Storage;

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

启用本地临时 URL

如果您在支持临时 URL 引入之前开始开发应用程序，您可能需要启用本地临时 URL。为此，您需要在 config/filesystems.php 配置文件中为本地磁盘配置添加 serve 选项：

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

S3 请求参数

如果您需要指定额外的 【S3 请求参数】，可以将请求参数数组作为第三个参数传递给 temporaryUrl 方法：

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

自定义临时 URL

如果您需要自定义为特定存储磁盘创建临时 URL 的方式，可以使用 buildTemporaryUrlsUsing 方法。例如，如果您的控制器允许您下载通过不支持临时 URL 的磁盘存储的文件，这个方法将非常有用。通常，应该在服务提供者的 boot 方法中调用此方法：

<?php

namespace App\Providers;

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

class AppServiceProvider extends ServiceProvider
{
    /**
     * 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 的功能仅在 S3 驱动程序中受支持。

如果您需要生成一个临时 URL，使客户端应用程序能够直接上传文件，您可以使用 temporaryUploadUrl 方法。该方法接受一个文件路径和一个 DateTime 实例，指定 URL 应该在何时过期。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');

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

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

文件路径

您可以使用 path 方法来获取给定文件的路径。如果您使用的是 local 驱动程序，它将返回文件的绝对路径。如果您使用的是 S3 驱动程序，则该方法将返回文件在 S3 存储桶中的相对路径：

use Illuminate\Support\Facades\Storage;

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

存储文件

put 方法可用于将文件内容存储到磁盘。您还可以将一个 PHP 资源传递给 put 方法，这将使用 Flysystem 的底层流支持。请记住，所有文件路径应相对于磁盘配置中的 "root" 位置来指定：

use Illuminate\Support\Facades\Storage;

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

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

写入失败

如果 put 方法（或其它“写入”操作）无法将文件写入磁盘，则将返回 false：

if (! Storage::put('file.jpg', $contents)) {
    // 文件无法写入磁盘...
}

如果需要，您可以在文件系统磁盘的配置数组中定义 throw 选项。当此选项设置为 true 时，像 put 这样的“写入”方法在写入操作失败时将抛出 League\Flysystem\UnableToWriteFile 实例：

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

向文件前后追加和添加内容

prepend 和 append 方法允许您分别将内容写入文件的开头或结尾：

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

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

复制和移动文件

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 这样的云磁盘上，并希望文件通过生成的 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
);

不可打印和无效的 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'
);

其它上传文件信息

如果你想获取上传文件的原始名称和扩展名，可以使用 getClientOriginalName 和 getClientOriginalExtension 方法：

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

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

但是，请注意，getClientOriginalName 和 getClientOriginalExtension 方法被认为是不安全的，因为文件名和扩展名可能会被恶意用户篡改。因此，通常建议使用 hashName 和 extension 方法来获取给定文件上传的名称和扩展名：

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

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

文件可见性

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

本地文件和可见性

在使用本地驱动时，公开可见性对应于目录的 0755 权限和文件的 0644 权限。你可以在应用的文件系统配置文件中修改这些权限映射：

'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 类的文件生成工具，可以大大简化文件上传的测试。例如：

  • Pest

  • PHPUint

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

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 并不限于这些，它为许多其它存储系统提供适配器。如果你希望在 Laravel 应用中使用这些额外的适配器，可以创建一个自定义驱动。

为了定义一个自定义文件系统，你需要一个 Flysystem 适配器。让我们将一个社区维护的 Dropbox 适配器添加到项目中：

composer require spatie/flysystem-dropbox

接下来，你可以在应用的【服务提供者】的 boot 方法中注册驱动。为此，你应使用 Storage facade 的 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 驱动。