文件存储

未匹配的标注
本文档最新版为 10.x,旧版本可能放弃维护,推荐阅读最新版!

文件存储

简介

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

配置

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

local 驱动程序与运行 Laravel 应用程序的服务器上本地存储的文件交互,而 s3 驱动程序则用于写入 Amazon 的 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

为了使这些文件可以从 web 访问,你应该创建一个从 public/storagestorage/app/public 的符号链接。利用这种文件夹约定,将你的公开访问文件保存在一个目录中,在使用 Envoyer 等零停机时间部署系统时,可轻松地跨部署共享这些文件。

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

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

作用域/只读文件系统

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

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

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

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

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

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

接下来,你可以在一个或多个磁盘配置数组中加入 read-only 配置选项:

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

Amazon S3 兼容文件系统

默认情况下,应用程序的 filesystems 配置文件包含 s3 磁盘的磁盘配置。除了使用该磁盘与 Amazon S3 交互外,你还可以使用它与任何兼容 S3 的文件存储服务交互,例如 MinIODigitalOcean Spaces

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

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

分区和只读文件系统

分区磁盘允许你定义一个文件系统,其中所有的路径都自动带有给定的路径前缀。在创建一个分区文件系统磁盘之前,你需要通过 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,
],

Amazon S3 兼容文件系统

默认情况下,你的应用程序的 filesystems 配置文件包含一个 s3 磁盘的磁盘配置。除了使用此磁盘与 Amazon S3 交互外,你还可以使用它与任何兼容 S3 的文件存储服务(如 MinIODigitalOcean 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 Facade 可用于与所有已配置的磁盘进行交互。例如,你可以使用 Facade 中的 put 方法将头像存储到默认磁盘。如果你在未先调用 disk 方法的情况下调用 Storage Facade 中的方法,则该方法将自动传递给默认磁盘:

use Illuminate\Support\Facades\Storage;

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

如果你的应用与多个磁盘进行交互,可使用 Storage Facade 中的 disk 方法对特定磁盘上的文件进行操作:

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

按需配置磁盘

有时你可能希望在运行时使用给定配置创建磁盘,而无需在应用程序的 filesystems 配置文件中实际存在该配置。为了实现这一点,你可以将配置数组传递给 Storage Facade 的 build 方法:

use Illuminate\Support\Facades\Storage;

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

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

检索文件

get 方法可用于检索文件的内容。该方法将返回文件的原始字符串内容。切记,所有文件路径的指定都应该相对于该磁盘所配置的「root」目录:

$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 的 Host

如果你想预定义使用 Storage 门面生成的 URL 的 Host,则可以在磁盘的配置数组中添加一个 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)
);

如果你需要指定额外的 S3 请求参数,你可以将请求参数数组作为第三个参数传递给 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 方法。此方法接受一个路径和一个 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 方法返回上次修改文件时的时间戳:

$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 方法可用于将文件内容存储在磁盘上。你也可以向 put 方法传递一个 PHP resource,它将利用底层的 Flysystem 流支持。请记住,应相对于为磁盘配置的「根」目录指定所有文件路径:

use Illuminate\Support\Facades\Storage;

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

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

写入失败

如果 put 方法(或其他「写入」操作)无法将文件写入磁盘,将返回 false

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

你可以在你的文件系统磁盘的配置数组中定义 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;

// 为文件名自动生成一个唯一的 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 方法返回,因此你可以在数据库中存储路径,包括生成的文件名。

putFile 和 putFileAs 方法还接受一个参数来指定存储文件的「可见性」。这特别有用,如果你正在如 Amazon S3 这样的云磁盘上存储文件,并希望通过生成的 URLs 让文件公开可访问:

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

文件上传

在网络应用程序中,存储文件最常见的用例之一是存储用户上传的文件,如照片和文档。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 facade 上调用 putFile 方法来执行与上述示例相同的文件存储操作:

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

指定文件名

如果你不希望为你存储的文件自动分配一个文件名,你可以使用 storeAs 方法,它接受路径、文件名和(可选的)磁盘作为其参数:

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

你也可以使用 Storage facade 上的 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 集成中,「可见性」是对多个平台的文件权限的抽象。文件可以被声明为 public 或 private。当文件被声明为 public 时,你正在表示该文件通常应该可以被他人访问。例如,当使用 S3 驱动时,你可以检索 public 文件的 URLs。

你可以在写入文件时通过 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'
);

本地文件和可见性

当使用 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 facade 的 fake 方法允许你轻松生成一个假磁盘,当与 Illuminate\Http\UploadedFile 类的文件生成实用程序结合使用时,大大简化了文件上传的测试。例如:

<?php
//译者注:Pest 测试
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
//译者注:PHPUnit 测试
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 测试文档的文件上传.的信息。

注意
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 驱动。

本文章首发在 LearnKu.com 网站上。

本译文仅用于学习和交流目的,转载请务必注明文章译者、出处、和本文链接
我们的翻译工作遵照 CC 协议,如果我们的工作有侵犯到您的权益,请及时联系我们。

原文地址:https://learnku.com/docs/laravel/11.x/fi...

译文地址:https://learnku.com/docs/laravel/11.x/fi...

上一篇 下一篇
《L05 电商实战》
从零开发一个电商项目,功能包括电商后台、商品 & SKU 管理、购物车、订单管理、支付宝支付、微信支付、订单退款流程、优惠券等
《L02 从零构建论坛系统》
以构建论坛项目 LaraBBS 为线索,展开对 Laravel 框架的全面学习。应用程序架构思路贴近 Laravel 框架的设计哲学。
贡献者:7
讨论数量: 0
发起讨论 只看当前版本


暂无话题~