文件系统

文件系统组件集成了 PHP 生态中大名鼎鼎的 League\Flysystem (这也是 Laravel 等诸多知名框架的底层库)。通过合理抽象，程序不必感知存储引擎究竟是本地硬盘还是云服务器，实现解耦。本组件对常用的云存储服务提供了协程化支持。

安装

  1. # 首先执行
  2. composer require hyperf/filesystem
  3. # 使用阿里云 OSS 适配器时执行
  4. composer require xxtime/flysystem-aliyun-oss
  5. # 使用 S3 适配器时执行
  6. composer require league/flysystem-aws-s3-v3
  7. composer require hyperf/guzzle
  8. # 使用七牛云（测试）适配器时执行
  9. composer require overtrue/flysystem-qiniu
  10. # 使用内存适配器时执行
  11. composer require league/flysystem-memory

安装完成后，执行

  1. php bin/hyperf.php vendor:publish hyperf/filesystem

就会生成 config/autoload/file.php 文件。在该文件中设置默认驱动，并配置对应驱动的 access key、access secret 等信息就可以使用了。

使用

通过 DI 注入 League\Flysystem\Filesystem 即可使用。

API 如下：

  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Controller;
  7. class IndexController extends AbstractController
  8. {
  9.     public function example(\League\Flysystem\Filesystem $filesystem)
  10.     {
  11.         // Process Upload
  12.         $file = $this->request->file('upload');
  13.         $stream = fopen($file->getRealPath(), 'r+');
  14.         $filesystem->writeStream(
  15.             'uploads/'.$file->getClientFilename(),
  16.             $stream
  17.         );
  18.         fclose($stream);
  20.         // Write Files
  21.         $filesystem->write('path/to/file.txt', 'contents');
  23.         // Add local file
  24.         $stream = fopen('local/path/to/file.txt', 'r+');
  25.         $result = $filesystem->writeStream('path/to/file.txt', $stream);
  26.         if (is_resource($stream)) {
  27.             fclose($stream);
  28.         }
  30.         // Update Files
  31.         $filesystem->update('path/to/file.txt', 'new contents');
  33.         // Check if a file exists
  34.         $exists = $filesystem->has('path/to/file.txt');
  36.         // Read Files
  37.         $contents = $filesystem->read('path/to/file.txt');
  39.         // Delete Files
  40.         $filesystem->delete('path/to/file.txt');
  42.         // Rename Files
  43.         $filesystem->rename('filename.txt', 'newname.txt');
  45.         // Copy Files
  46.         $filesystem->copy('filename.txt', 'duplicate.txt');
  48.         // list the contents
  49.         $filesystem->listContents('path', false);
  50.     }
  51. }

在某些时候，您会需要同时使用多种存储媒介。这时可以注入 Hyperf\Filesystem\FilesystemFactory 来动态选择使用哪种驱动。

  1. <?php
  3. declare(strict_types=1);
  5. namespace App\Controller;
  7. class IndexController
  8. {
  9.     public function example(\Hyperf\Filesystem\FilesystemFactory $factory)
  10.     {
  11.         $local = $factory->get('local');
  12.         // Write Files
  13.         $local->write('path/to/file.txt', 'contents');
  15.         $s3 = $factory->get('s3');
  17.         $s3->write('path/to/file.txt', 'contents');
  18.     }
  19. }

配置静态资源

如果您希望通过 http 访问上传到本地的文件，请在 config/autoload/server.php 配置中增加以下配置。

  1. return [
  2.     'settings' => [
  3.         ...
  4.         // 将 public 替换为上传目录
  5.         'document_root' => BASE_PATH . '/public',
  6.         'enable_static_handler' => true,
  7.     ],
  8. ];

注意事项

  1. S3 存储请确认安装 hyperf/guzzle 组件以提供协程化支持。阿里云、七牛云存储请开启 Curl Hook来使用协程。因 Curl Hook 的参数支持性问题，请使用 Swoole 4.4.13 以上版本。
  2. minIO, ceph radosgw 等私有对象存储方案均支持 S3 协议，可以使用 S3 适配器。
  3. 使用 Local 驱动时，根目录是配置好的地址，而不是操作系统的根目录。例如，Local 驱动 root 设置为 /var/www, 则本地磁盘上的 /var/www/public/file.txt 通过 flysystem API 访问时应使用 /public/file.txt 或 public/file.txt 。
  4. 以阿里云 OSS 为例，1 核 1 进程读操作性能对比：
  1. ab -k -c 10 -n 1000 http://127.0.0.1:9501/

未开启 CURL HOOK：

  1. Concurrency Level:      10
  2. Time taken for tests:   202.902 seconds
  3. Complete requests:      1000
  4. Failed requests:        0
  5. Keep-Alive requests:    1000
  6. Total transferred:      146000 bytes
  7. HTML transferred:       5000 bytes
  8. Requests per second:    4.93 [#/sec] (mean)
  9. Time per request:       2029.016 [ms] (mean)
  10. Time per request:       202.902 [ms] (mean, across all concurrent requests)
  11. Transfer rate:          0.70 [Kbytes/sec] received

开启 CURL HOOK 后：

  1. Concurrency Level:      10
  2. Time taken for tests:   9.252 seconds
  3. Complete requests:      1000
  4. Failed requests:        0
  5. Keep-Alive requests:    1000
  6. Total transferred:      146000 bytes
  7. HTML transferred:       5000 bytes
  8. Requests per second:    108.09 [#/sec] (mean)
  9. Time per request:       92.515 [ms] (mean)
  10. Time per request:       9.252 [ms] (mean, across all concurrent requests)
  11. Transfer rate:          15.41 [Kbytes/sec] received

详细配置

  1. return [
  2.     // 选择storage下对应驱动的键即可。
  3.     'default' => 'local',
  4.     'storage' => [
  5.         'local' => [
  6.             'driver' => \Hyperf\Filesystem\Adapter\LocalAdapterFactory::class,
  7.             'root' => __DIR__ . '/../../runtime',
  8.         ],
  9.         'ftp' => [
  10.             'driver' => \Hyperf\Filesystem\Adapter\FtpAdapterFactory::class,
  11.             'host' => 'ftp.example.com',
  12.             'username' => 'username',
  13.             'password' => 'password',
  15.             /* optional config settings */
  16.             'port' => 21,
  17.             'root' => '/path/to/root',
  18.             'passive' => true,
  19.             'ssl' => true,
  20.             'timeout' => 30,
  21.             'ignorePassiveAddress' => false,
  22.         ],
  23.         'memory' => [
  24.             'driver' => \Hyperf\Filesystem\Adapter\MemoryAdapterFactory::class,
  25.         ],
  26.         's3' => [
  27.             'driver' => \Hyperf\Filesystem\Adapter\S3AdapterFactory::class,
  28.             'credentials' => [
  29.                 'key' => env('S3_KEY'),
  30.                 'secret' => env('S3_SECRET'),
  31.             ],
  32.             'region' => env('S3_REGION'),
  33.             'version' => 'latest',
  34.             'bucket_endpoint' => false,
  35.             'use_path_style_endpoint' => false,
  36.             'endpoint' => env('S3_ENDPOINT'),
  37.             'bucket_name' => env('S3_BUCKET'),
  38.         ],
  39.         'minio' => [
  40.             'driver' => \Hyperf\Filesystem\Adapter\S3AdapterFactory::class,
  41.             'credentials' => [
  42.                 'key' => env('S3_KEY'),
  43.                 'secret' => env('S3_SECRET'),
  44.             ],
  45.             'region' => env('S3_REGION'),
  46.             'version' => 'latest',
  47.             'bucket_endpoint' => false,
  48.             'use_path_style_endpoint' => true,
  49.             'endpoint' => env('S3_ENDPOINT'),
  50.             'bucket_name' => env('S3_BUCKET'),
  51.         ],
  52.         'oss' => [
  53.             'driver' => \Hyperf\Filesystem\Adapter\AliyunOssAdapterFactory::class,
  54.             'accessId' => env('OSS_ACCESS_ID'),
  55.             'accessSecret' => env('OSS_ACCESS_SECRET'),
  56.             'bucket' => env('OSS_BUCKET'),
  57.             'endpoint' => env('OSS_ENDPOINT'),
  58.             // 'timeout'        => 3600,
  59.             // 'connectTimeout' => 10,
  60.             // 'isCName'        => false,
  61.             // 'token'          => '',
  62.         ],
  63.         'qiniu' => [
  64.             'driver' => \Hyperf\Filesystem\Adapter\QiniuAdapterFactory::class,
  65.             'accessKey' => env('QINIU_ACCESS_KEY'),
  66.             'secretKey' => env('QINIU_SECRET_KEY'),
  67.             'bucket' => env('QINIU_BUCKET'),
  68.             'domain' => env('QINIU_DOMAIN'),
  69.         ],
  70.     ],
  71. ];