luoyy/huawei-obs-storage

华为 obs 文件系统存储,适用于 Laravel 9+

v1.0.4 2023-08-31 09:44 UTC

This package is auto-updated.

Last update: 2024-08-30 01:49:53 UTC


README

需求

  • Laravel 9+
  • cURL 扩展

安装

为了安装华为OBS-storage,只需在 composer.json 中添加

"luoyy/huawei-obs-storage": "^1.0"

。然后运行 composer installcomposer update
或者您可以直接运行以下命令来安装

"composer require luoyy/huawei-obs-storage:^1.0"

然后在您的 config/app.php 中将此行添加到 providers 数组

luoyy\HuaweiOBS\HuaweiObsServiceProvider::class,

配置

app/filesystems.php 中添加以下内容

'disks'=>[
    ...
    'obs' => [
            'driver' => 'obs',
            'access_id' => env('OBS_ACCESS_KEY_ID'),
            'access_key' => env('OBS_ACCESS_KEY_SECRET'),
            'bucket' => env('OBS_BUCKET'),
            'endpoint' => env('OBS_ENDPOINT'), // OBS 外网节点或自定义外部域名
            'endpoint_internal' => env('OBS_ENDPOINT_INTERNAL'), // 如果为空,则默认使用 endpoint 配置
            'cdnDomain' => env('OBS_DOMAIN'), // 如果不为空,getUrl会判断cdnDomain是否设定来决定返回的url,如果cdnDomain未设置,则使用endpoint来生成url,否则使用cdn
            'ssl' => env('OBS_SSL', false), // true to use 'https://' and false to use 'http://'. default is false,
            'prefix' => env('OBS_PREFIX'), // 路径前缀
            'options' => [],
            'throw' => true,
    ],
    ...
]

然后设置 app/filesystems.php 中的默认驱动

'default' => 'obs',

好了,您已经完成了配置。现在可以随意使用华为 OBS 作为存储!

用法

请参阅 Laravel Storage 文档 或您可以在这里学习

首先您必须使用 Storage 门面

use Illuminate\Support\Facades\Storage;

然后您可以使用 Laravel Storage 的所有 API

Storage::disk('obs'); // if default filesystems driver is obs, you can skip this step

//fetch all files of specified bucket(see upond configuration)
Storage::files($directory);
Storage::allFiles($directory);

Storage::put('path/to/file/file.jpg', $contents); //first parameter is the target file path, second paramter is file content
Storage::putFile('path/to/file/file.jpg', 'local/path/to/local_file.jpg'); // upload file from local path

Storage::get('path/to/file/file.jpg'); // get the file object by path
Storage::exists('path/to/file/file.jpg'); // determine if a given file exists on the storage(OBS)
Storage::size('path/to/file/file.jpg'); // get the file size (Byte)
Storage::lastModified('path/to/file/file.jpg'); // get date of last modification

Storage::directories($directory); // Get all of the directories within a given directory
Storage::allDirectories($directory); // Get all (recursive) of the directories within a given directory

Storage::copy('old/file1.jpg', 'new/file1.jpg');
Storage::move('old/file1.jpg', 'new/file1.jpg');
Storage::rename('path/to/file1.jpg', 'path/to/file2.jpg');

Storage::prepend('file.log', 'Prepended Text'); // Prepend to a file.
Storage::append('file.log', 'Appended Text'); // Append to a file.

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

Storage::makeDirectory($directory); // Create a directory.
Storage::deleteDirectory($directory); // Recursively delete a directory.It will delete all files within a given directory, SO Use with caution please.
Storage::url('path/to/img.jpg') // get the file url
Storage::temporaryUrl('path/to/img.jpg', 900) // Get a temporary URL for the file at the given path.

文档

更多开发细节请参阅 华为 OBS 文档

许可证

除 Obs 目录外,源代码在 MIT 许可证下发布。有关更多信息,请阅读许可证文件。Obs 是 Apache License 2.0。