jameskid/ali-oss-storage

laravel 5+ 的阿里云 OSS 文件系统存储

2.1.6 2020-08-17 10:03 UTC

This package is auto-updated.

Last update: 2024-09-17 19:31:24 UTC


README

Scrutinizer Code Quality Build Status Latest Stable Version Total Downloads Latest Unstable Version License

阿里云 OSS 文件系统存储适配器用于 laravel 5。您可以使用 Aliyun OSS 如同使用 Laravel Storage 一样。
借鉴了一些优秀的代码,综合各方,同时做了更多优化,将会添加更多完善的接口和插件,打造 Laravel 最佳的 OSS Storage 扩展。

如果您觉得本项目对您有帮助且愿意花时间一起维护,欢迎通过 Issues 给我留言,我将把您添加为协作者。

灵感来源

要求

  • Laravel 5+
  • cURL 扩展

之前 fork 的 jacobcyl/Aliyun-oss-storage ,自 2.1.1 版本开始,增加新功能,更改 composer 包名称为:summergeorge/ali-oss-storage

安装

为了安装 AliOSS-storage,只需将以下内容添加到您的 composer.json 中。

"summergeorge/ali-oss-storage": "^2.1"

然后运行 composer installcomposer update
或者,您可以简单地运行以下命令来安装:

"composer require summergeorge/ali-oss-storage:^2.1"

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

Jacobcyl\AliOSS\AliOssServiceProvider::class,

配置

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

'disks'=>[
    ...
    'oss' => [
            'driver'        => 'oss',
            'access_id'     => '<Your Aliyun OSS AccessKeyId>',
            'access_key'    => '<Your Aliyun OSS AccessKeySecret>',
            'bucket'        => '<OSS bucket name>',
            'endpoint'      => '<the endpoint of OSS, E.g: oss-cn-hangzhou.aliyuncs.com | custom domain, E.g:img.abc.com>', // OSS 外网节点或自定义外部域名
            //'endpoint_internal' => '<internal endpoint [OSS内网节点] 如:oss-cn-shenzhen-internal.aliyuncs.com>', // v2.0.4 新增配置属性,如果为空,则默认使用 endpoint 配置(由于内网上传有点小问题未解决,请大家暂时不要使用内网节点上传,正在与阿里技术沟通中)
            'cdnDomain'     => '<CDN domain, cdn域名>', // 如果isCName为true, getUrl会判断cdnDomain是否设定来决定返回的url,如果cdnDomain未设置,则使用endpoint来生成url,否则使用cdn
            'ssl'           => <true|false> // true to use 'https://' and false to use 'http://'. default is false,
            'isCName'       => <true|false> // 是否使用自定义域名,true: 则Storage.url()会使用自定义的cdn或域名生成文件url, false: 则使用外部节点生成url
            'debug'         => <true|false>
    ],
    ...
]

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

'default' => 'oss',

好了,配置完成。现在您可以自由地使用 Aliyun OSS 如同使用 Storage 一样了!

用法

查看 Laravel 文档中的 Storage 或在此处学习。

首先您必须使用 Storage 门面

use Illuminate\Support\Facades\Storage;

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

Storage::disk('oss'); // if default filesystems driver is oss, 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(OSS)
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.

// upgrade logs
// new plugin for v2.0 version
Storage::putRemoteFile('target/path/to/file/jacob.jpg', 'http://example.com/jacob.jpg'); //upload remote file to storage by remote url
// new function for v2.0.1 version
Storage::url('path/to/img.jpg') // get the file url
// new function for v2.1.1 version
Storage::signUrl('path/to/img.jpg',$timeout) //(请使用新的temporaryUrl方法) get the file url with signature,default timeout = 600
// new function for v2.1.4 version
Storage::temporaryUrl('path/to/img.jpg',$timeout) // get the file url with signature,default timeout = 600

// new function for v2.1.2 version
// 阿里云 oss 帮助文档:https://help.aliyun.com/document_detail/44688.html?spm=a2c4g.11186623.6.1199.40572e934MoHWu
// getProcessUrl(图片在 oss 中的路径,操作名称(例如:resize),参数(key => value 形式的数组));
Storage::getProcessUrl('path/to/img.jpg','resize', ['m' => 'fixed','h' => '100','w' => '100']) // picture processing,处理图片,支持 oss 图片处理的功能

文档

更多开发详情请查看 阿里云 OSS DOC

许可

源代码在 MIT 许可下发布。阅读 LICENSE 文件获取更多信息。