文件系统与云存储

简介

Laravel 强大的文件抽象层得力于 Frank de Jonge 的 Flysystem 扩展包。Laravel 的 flysystem 集成提供了可给本地端磁盘系统、Amazon S3、以及 Rackspace 云存储使用的各种驱动（driver）。并且能像使用 API 一样，轻易的切换这些存储方式来应对各式系统。

设置

文件系统配置文件位于 config/filesystems.php。该文件能让你设置所有的「磁盘（disk）」。每个磁盘代表一个唯一的存储驱动以及存储位置。各种支持驱动的例子已包含其中，仅需要简单的根据你的偏好配置及凭证设置进行修改即可。

当然，你也可以设置多组磁盘，甚至在多个磁盘使用相同的驱动。

本地端驱动

当使用 local 驱动时，所有的操作都是相对于配置文件的 root 目录设置进行的。该目录默认是 storage/app。因此下列方法将把文件保存在 storage/app/file.txt：

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

其它驱动的预先需求

在使用 S3 或 Rackspace 驱动之前，你需要通过 Composer 安装适当扩展包：

  • Amazon S3: league/flysystem-aws-s3-v3 ~1.0
  • Rackspace: league/flysystem-rackspace ~1.0

基本用法

获得磁盘实例

Storage facade 用于对任何已设置的磁盘进行交互。举例来说，你可以使用 facade 的 put 方法将一张头像保存到默认磁盘上。当使用 Storage facade 调用了方法却未先调用 disk 方法时，默认磁盘将被自动传递给该方法。

  1. <?php
  3. namespace App\Http\Controllers;
  5. use Storage;
  6. use Illuminate\Http\Request;
  7. use App\Http\Controllers\Controller;
  9. class UserController extends Controller
  10. {
  11.     /**
  12.      * 更新指定用户的头像。
  13.      *
  14.      * @param  Request  $request
  15.      * @param  int  $id
  16.      * @return Response
  17.      */
  18.     public function updateAvatar(Request $request, $id)
  19.     {
  20.         $user = User::findOrFail($id);
  22.         Storage::put(
  23.             'avatars/'.$user->id,
  24.             file_get_contents($request->file('avatar')->getRealPath())
  25.         );
  26.     }
  27. }

当使用多个磁盘时，你可以通过 Storage facade 的 disk 方法访问特定磁盘。当然，你也可以使用链式调用（chain methods）对磁盘使用各种执行方法。

  1. $disk = Storage::disk('s3');
  3. $contents = Storage::disk('local')->get('file.jpg')

提取文件

get 方法提取指定文件的内容，该文件的原始字符串内容将通过该方法获取：

  1. $contents = Storage::get('file.jpg');

has 方法可以用于判定指定的文件是否存在于磁盘上：

  1. $exists = Storage::disk('s3')->has('file.jpg');

文件信息

size 方法获取文件的大小并以 bytes 显示：

  1. $size = Storage::size('file1.jpg');

lastModified 方法返回文件的最后修改时间并以 UNIX 时间戳显示：

  1. $time = Storage::lastModified('file1.jpg');

保存文件

put 方法保存单个文件于磁盘上。你能同时传递 PHP 的 resource 给 put 方法，它将使用文件系统底层的 stream 支持。强烈建议使用 stream 处理大型文件。

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

copy 方法用于复制一个已存在的文件到磁盘的新位置。

  1. Storage::copy('old/file1.jpg', 'new/file1.jpg');

move 方法用于重命名或是移动一个已存在的文件到新位置。

  1. Storage::move('old/file1.jpg', 'new/file1.jpg');

插入到文件

prepend 及 append 方法允许你轻易的将内容插入到一个文件的开头或结尾：

  1. Storage::prepend('file.log', 'Prepended Text');
  3. Storage::append('file.log', 'Appended Text');

删除文件

delete 方法接受一个文件名称或文件名称数组，用以移除磁盘上的文件：

  1. Storage::delete('file.jpg');
  3. Storage::delete(['file1.jpg', 'file2.jpg']);

目录

获取单个目录内的所有文件

files 方法返回指定目录下的文件数组。如果你希望返回包含指定目录下所有子目录的文件，则可以使用 allFiles 方法。

  1. $files = Storage::files($directory);
  3. $files = Storage::allFiles($directory);

获取单个目录内所有目录

directories 方法返回指定目录下的目录数组。另外，你也可以使用 allDirectories 方法获取指定目录下的子目录以及子目录所包含的目录。

  1. $directories = Storage::directories($directory);
  3. // 递归...
  4. $directories = Storage::allDirectories($directory);

创建目录

makeDirectory 方法将创建指定的目录，包括任何所需的子目录。

  1. Storage::makeDirectory($directory);

删除目录

最后，deleteDirectory 方法能移除磁盘上的单个目录以及所包含的全部文件。

  1. Storage::deleteDirectory($directory);

自定义文件系统

Laravel 集成的 Flysystem 提供许多默认驱动；然而 Flysystem 本身不仅仅提供了这些，还包括其它保存系统的接口（adapter）。你能在 Laravel 的应用当中通过创建新的驱动使用这些额外的接口。

为了建构一个自定义的磁盘系统，你将需要创建一个像是 DropboxServiceProvider 的 服务提供者。并在该提供者的 boot 方法使用 Storage facade 的 extend 方法自定义你的驱动。

  1. <?php
  3. namespace App\Providers;
  5. use Storage;
  6. use League\Flysystem\Filesystem;
  7. use Dropbox\Client as DropboxClient;
  8. use Illuminate\Support\ServiceProvider;
  9. use League\Flysystem\Dropbox\DropboxAdapter;
  11. class DropboxServiceProvider extends ServiceProvider
  12. {
  13.     /**
  14.      * 运行服务注册后的启动进程。
  15.      *
  16.      * @return void
  17.      */
  18.     public function boot()
  19.     {
  20.         Storage::extend('dropbox', function($app, $config) {
  21.             $client = new DropboxClient(
  22.                 $config['accessToken'], $config['clientIdentifier']
  23.             );
  25.             return new Filesystem(new DropboxAdapter($client));
  26.         });
  27.     }
  29.     /**
  30.      * 在容器注册绑定。
  31.      *
  32.      * @return void
  33.      */
  34.     public function register()
  35.     {
  36.         //
  37.     }
  38. }

extend 方法的第一个参数是你的驱动名称，第二个参数则是一个接受 $app 及 $config 变量的闭包。该闭包必须返回 League\Flysystem\Filesystem 实例。$config 变量包含了定义在 config/filesystems.php 对指定磁盘的设置。

当你通过创建服务提供者注册该扩展后，你便能在 config/filesystem.php 配置文件中使用 dropbox 驱动。

{note} 欢迎任何形式的转载，但请务必注明出处，尊重他人劳动共创开源社区。

转载请注明：本文档由 Laravel China 社区 [laravel-china.org] 组织翻译。

文档永久地址： http://d.laravel-china.org