后盾人

Appearance

文件存储 ​

介绍 ​

Laravel 提供了一个强大的文件系统抽象，这要归功于 Frank de Jonge 精彩的 Flysystem PHP 包。Laravel Flysystem 集成为使用本地文件系统、SFTP 和 Amazon S3 提供了简单的驱动程序。更棒的是，在本地开发计算机和生产服务器之间的这些存储选项之间切换非常简单，因为每个系统的 API 都相同。

介绍 ​

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

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

NOTE

您可以根据需要配置任意数量的磁盘，甚至可以拥有多个使用同一驱动程序的磁盘。

本地驱动 ​

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

php
    use Illuminate\Support\Facades\Storage;

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

公共磁盘 ​

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

要使这些文件可从 Web 访问，您应该创建一个从 public/storage 到 storage/app/public 的符号链接。利用此文件夹约定会将您的可公开访问文件保存在一个目录中，当使用像 Envoy 这样的零停机时间部署系统时，该目录可以在部署之间轻松共享。

要创建符号链接，您可以使用 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 信息和凭证:

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

        // 基本身份验证的设置
        '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 包:

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

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

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

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

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

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

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

Amazon S3 兼容文件系统 ​

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

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

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

MinIO ​

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

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

WARNING

使用 MinIO 时，不支持通过 temporaryUrl 方法生成临时存储 URL。

获取云盘实例 ​

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

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 方法可用于检索文件的内容。该方法将返回文件的原始字符串内容。请记住，所有文件路径都应该相对于磁盘的 “root” 位置指定:

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 方法接受 filename 作为方法的第二个参数，这将确定下载文件的用户看到的文件名。最后，您可以将 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 目录的符号链接。

WARNING

使用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 方法，您可以创建指向使用 s3 驱动程序存储的文件的临时 URL。此方法接受一个 path 和一个 DateTime 实例，指定 URL 的过期时间:

php
    use Illuminate\Support\Facades\Storage;

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

如果您需要指定其他 S3 请求参数，则可以将请求参数数组作为第三个参数传递给 temporaryUrl 方法:

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

如果需要自定义为特定存储磁盘创建临时 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 ​

WARNING

只有 s3 驱动程序支持生成临时上传 URL 的功能。

如果您需要生成一个临时 URL，用于直接从客户端应用程序上传文件，则可以使用 temporaryUploadUrl 方法。此方法接受一个路径和一个 DateTime 实例，用于指定 URL 的过期时间。temporaryUploadUrl 方法返回一个关联数组，该数组可以解构为上传 URL 和应包含在上传请求中的标头:

php
    use Illuminate\Support\Facades\Storage;

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

此方法主要适用于需要客户端应用程序直接将文件上传到云存储系统（如 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 存储桶中文件的相对路径:

php
    use Illuminate\Support\Facades\Storage;

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

存储文件 ​

put 方法可用于在磁盘上存储文件内容。你也可以将 PHP 资源传递给 put 方法，该方法将使用 Flysystem 的底层流支持。请记住，所有文件路径都应相对于为磁盘配置的 “root” 位置指定:

php
    use Illuminate\Support\Facades\Storage;

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

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

写入失败 ​

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

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

如果你愿意，你可以在文件系统磁盘的配置数组中定义 throw 选项。当此选项定义为 true 时，“write” 方法（如 put）将抛出 League\Flysystem\UnableToWriteFile 写入操作失败时的异常:

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

追加和追加到文件 ​

prepend 和 append 方法允许您写入文件的开头或结尾:

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 自动管理将给定文件流式传输到您的存储位置，您可以使用 putFile 或 putFileAs 方法。此方法接受 Illuminate\Http\File 或 Illuminate\Http\UploadedFile 实例，并会自动将文件流式传输到您想要的位置:

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

    // 自动生成 filename...
    $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 公开访问该文件，这将特别有用:

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

文件上传 ​

在 Web 应用程序中，存储文件的最常见用例之一是存储用户上传的文件，例如照片和文档。Laravel 使在上传的文件实例上使用 store 方法存储上传的文件变得非常容易。使用您希望存储上传文件的路径调用 store 方法:

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

WARNING

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

其他上传的文件信息 ​

如果您想获取上传文件的原始名称和扩展名，可以使用 getClientOriginalName 和 getClientOriginalExtension 方法来实现:

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

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

但是，请记住，getClientOriginalName 和 getClientOriginalExtension 方法被视为不安全，因为文件名和扩展名可能会被恶意用户篡改。因此，您通常应该首选 hashName 和 extension 方法来获取给定文件上传的名称和扩展名:

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

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

文件可见性 ​

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

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

php
    use Illuminate\Support\Facades\Storage;

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

如果文件已经存储，则可以通过 getVisibility 和 setVisibility 方法检索和设置其可见性:

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

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

与上传的文件交互时，您可以使用 storePublicly 和 storePubliclyAs 方法来存储上传的文件，使其具有公众可见性:

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 方法允许您轻松生成一个 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')
    ]);

    // 断言已存储一个或多个文件...
    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
<?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 扩展。

自定义文件系统 ​

Laravel 的 Flysystem 集成为多个开箱即用的“驱动程序”提供支持;但是，Flysystem 不仅限于这些，还有适用于许多其他存储系统的适配器。如果您想在 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
    {
        /**
         * 注册任何应用程序服务
         */
        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 驱动程序。

后盾人版权所有 © 2018-2024 创作不易请尊重他人劳动成果，未经授权禁止转载！