文件存储

介绍
配置
获取磁盘实例
- 按需磁盘
检索文件
存储文件
删除文件
目录
自定义文件系统

介绍

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

配置

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

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

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

本地驱动

使用 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 中。

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

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

驱动程序先决条件

S3 驱动程序配置

在使用 S3 驱动程序之前，您需要通过 Composer 包管理器安装 Flysystem S3 包：

shell

composer require league/flysystem-aws-s3-v3 "^3.0"

S3 驱动程序的配置信息位于您的 config/filesystems.php 配置文件中。此文件包含 S3 驱动程序的示例配置数组。您可以自由修改此数组以包含您自己的 S3 配置和凭据。为了方便起见，这些环境变量与 AWS CLI 使用的命名约定相匹配。

FTP 驱动程序配置

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

shell

composer require league/flysystem-ftp "^3.0"

Laravel 的 Flysystem 集成与 FTP 配合得很好；然而，框架的默认 filesystems.php 配置文件中不包含示例配置。如果您需要配置 FTP 文件系统，可以使用下面的配置示例：

php

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

shell

composer require league/flysystem-sftp-v3 "^3.0"

Laravel 的 Flysystem 集成与 SFTP 配合得很好；然而，框架的默认 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'),

    // 可选的 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 配置选项之前，您需要通过 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 兼容的文件存储服务（如 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

使用 temporaryUrl 方法生成临时存储 URL 在使用 MinIO 时不受支持。

获取磁盘实例

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

可以使用 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

您可以使用 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 目录。

使用 local 驱动程序时，url 的返回值未进行 URL 编码。因此，我们建议始终使用创建有效 URL 的名称存储文件。

临时 URL

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

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 Illuminate\Support\Facades\Storage;
use Illuminate\Support\Facades\URL;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * 启动任何应用程序服务。
     *
     * @return void
     */
    public function boot()
    {
        Storage::disk('local')->buildTemporaryUrlsUsing(function ($path, $expiration, $options) {
            return URL::temporarySignedRoute(
                'files.download',
                $expiration,
                array_merge($options, ['path' => $path])
            );
        });
    }
}

URL 主机自定义

如果您希望预定义使用 Storage facade 生成的 URL 的主机，可以将 url 选项添加到磁盘的配置数组中：

php

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

文件元数据

除了读取和写入文件，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,
],

在文件中添加和附加内容

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;

// 自动为文件名生成唯一 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）上，并希望文件通过生成的 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
{
    /**
     * 更新用户的头像。
     *
     * @param  \Illuminate\Http\Request  $request
     * @return \Illuminate\Http\Response
     */
    public function update(Request $request)
    {
        $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'
);

其他上传文件信息

如果您希望获取上传文件的原始名称和扩展名，可以使用 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 驱动程序时，您可以检索 public 文件的 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 方法以 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,
        ],
    ],
],

删除文件

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

自定义文件系统

Laravel 的 Flysystem 集成提供了对几个“驱动程序”的开箱即用支持；然而，Flysystem 并不限于这些，并且有许多其他存储系统的适配器。如果您想在 Laravel 应用程序中使用这些额外的适配器之一，可以创建自定义驱动程序。

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

shell

composer require spatie/flysystem-dropbox

接下来，您可以在应用程序的服务提供者之一的 boot 方法中注册驱动程序。为此，您应该使用 Storage facade 的 extend 方法：

php

<?php

namespace App\Providers;

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
{
    /**
     * 注册任何应用程序服务。
     *
     * @return void
     */
    public function register()
    {
        //
    }

    /**
     * 启动任何应用程序服务。
     *
     * @return void
     */
    public function boot()
    {
        Storage::extend('dropbox', function ($app, $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 驱动程序。

文件存储

介绍

配置

本地驱动

公共磁盘

驱动程序先决条件

S3 驱动程序配置

FTP 驱动程序配置

SFTP 驱动程序配置

作用域和只读文件系统

Amazon S3 兼容文件系统

MinIO

获取磁盘实例

按需磁盘

检索文件

下载文件

文件 URL

临时 URL

URL 主机自定义

文件元数据

文件路径

存储文件

写入失败

在文件中添加和附加内容

复制和移动文件

自动流式传输

文件上传

指定文件名

指定磁盘

其他上传文件信息

文件可见性

本地文件和可见性

删除文件

目录

获取目录中的所有文件

获取目录中的所有目录

创建目录

删除目录

自定义文件系统

文件存储 ​

介绍 ​

配置 ​

本地驱动 ​

公共磁盘 ​

驱动程序先决条件 ​

S3 驱动程序配置 ​

FTP 驱动程序配置 ​

SFTP 驱动程序配置 ​

作用域和只读文件系统 ​

Amazon S3 兼容文件系统 ​

MinIO ​

获取磁盘实例 ​

按需磁盘 ​

检索文件 ​

下载文件 ​

文件 URL ​

临时 URL ​

URL 主机自定义 ​

文件元数据 ​

文件路径 ​

存储文件 ​

写入失败 ​

在文件中添加和附加内容 ​

复制和移动文件 ​

自动流式传输 ​

文件上传 ​

指定文件名 ​

指定磁盘 ​

其他上传文件信息 ​

文件可见性 ​

本地文件和可见性 ​

删除文件 ​

目录 ​

获取目录中的所有文件 ​

获取目录中的所有目录 ​

创建目录 ​

删除目录 ​

自定义文件系统 ​

文件存储

介绍

配置

本地驱动

公共磁盘

驱动程序先决条件

S3 驱动程序配置

FTP 驱动程序配置

SFTP 驱动程序配置

作用域和只读文件系统

Amazon S3 兼容文件系统

MinIO

获取磁盘实例

按需磁盘

检索文件

下载文件

文件 URL

临时 URL

URL 主机自定义

文件元数据

文件路径

存储文件

写入失败

在文件中添加和附加内容

复制和移动文件

自动流式传输

文件上传

指定文件名

指定磁盘

其他上传文件信息

文件可见性

本地文件和可见性

删除文件

目录

获取目录中的所有文件

获取目录中的所有目录

创建目录

删除目录

自定义文件系统