3分钟短文：用Laravel的方式管理服务器的文件们

程序员小助手

发布于 2020-09-21 15:34:13

1.4K0

发布于 2020-09-21 15:34:13

文章被收录于专栏：程序员小助手程序员小助手

引言

如果我们的应用程序接收用户提交的许多静态文件，文档，图片等等，需要将其上传到服务器并进行有效地管理。

然而，文件类型繁多，文件用途不同；还有可能我们使用第三方的对象存储服务，需要像访问本地文件一样地读取远端的文件。

如果有一套统一的API，或者操作风格，那样会节省很多不必要的差异化代码。laravel提供的Storage文档存储管理正式因此产生的，本期我们就来说一说。

代码时间

首先在配置文件内声明各个磁盘配置，可以设置驱动，配置目录等差异化信息。在 config/filesystem.php 文件内添加如下配置代码：

'disks' => [
    'local' => [
        'driver' => 'local',
        'root' => storage_path('app'),
    ],
    'public' => [
        'driver' => 'local',
        'root' => storage_path('app/public'),
        'visibility' => 'public',
    ],
    's3' => [
        'driver' => 's3',
        'key' => 'your-key',
        'secret' => 'your-secret',
        'region' => 'your-region',
        'bucket' => 'your-bucket',
    ],
],

其中 driver 为 local 时，表示本地的文件系统驱动。

如果要把 storage 目录下的公用目录 public 公开到网络可访问位置，我们为其创建一个软连接：

php artisan storage:link

这样就把目录 public 指向了 storage/app/public 目录。那么位于该目录下的所有文件，可通过web服务器的根目录直接访问。

文件操作

laravel提供的Storage文件操作类，封装了非常方便的文件读写和高级的功能操作。比如读取一个文件的内容：

Storage::disk('s3')->get('file.jpg');

上述代码，读取s3服务上的一个图片文件。

覆盖性写入一个文件，或者创建一个新的不存在的文件，使用 put 方式：

Storage::disk('local')->put('file.jpg', $contentsOrStream)

或者把上传的文件，直接放入到某个指定的目录：

Storage::putFile('myDir', $file)

其中 $file 是一个 Illuminate\Http\File or Illuminate\Http\UploadedFile 对象的实例。我们通过表单上传的file字段文件，可以使用

request()->file('file_field')

方便地获取。还有常用的判断文件是否存在：

Storage::exists('file.jpg')

避免了我们写 file_exists 这样还有传入绝对路径，或者相对路径的麻烦，使用对象方法操作，使得代码风格更为统一。

还有常用的一些方法，我们不一一解释了，罗列在下方：

文件复制 copy('file.jpg', 'newfile.jpg')
文件重命名 move('file.jpg', 'newfile.jpg')
文件头部追加内容 prepend('my.log', 'log text')
文件尾部追加内容 append('my.log', 'log text')
删除文件 delete('file.jpg')

等等等等，读者可以自定查看文档或在源码中研读。

如果我们引入了一个第三方的文件存储服务，且有其一套API操作方式，而laravel系统并未提供该服务的驱动，能否自定义一套呢？完全可以。

框架的文件系统驱动使用了 Flysystem 库用于统一化管理。我们只需要扩展Storage，并将第三方的驱动API实现Storage接口方法即可在程序内无差别地使用了。

在 AppServiceProvider 的 boot 方法内实现该扩展。比如我们引入 dropbox 存储服务：

Storage::extend('dropbox', function ($app, $config) {
    $client = new DropboxClient(
        $config['accessToken'], $config['clientIdentifier']
    );
    return new Filesystem(new DropboxAdapter($client));
});

我们使用Dropbox公司提供的 PHP SDK，或者使用composer安装相关包，在扩展方法中注册该驱动引擎即可。