这个包是封装 aliyun-oss-flysystem 到 Laravel 来作为 Storage 使用.
如果需要客户端直传, 可使用 Web服务端签名直传OSS扩展包 aliyun-oss-appserver
版本兼容
| laravel | aliyun-oss-laravel | driver | readme |
|---|
| >=5.5,<9.0 | 3.0 | aliyun | readme |
| >=9.0 | 4.0 | oss | readme |
安装依赖
通过composer管理您的项目依赖，可以在你的项目根目录运行：
composer require alphasnow/aliyun-oss-laravel
然后通过composer install安装依赖。
修改环境配置 .env
OSS_ACCESS_KEY_ID=<必填, 阿里云的AccessKeyId>
OSS_ACCESS_KEY_SECRET=<必填, 阿里云的AccessKeySecret>
OSS_BUCKET=<必填, 对象存储的Bucket>
OSS_ENDPOINT=<必填, 对象存储的Endpoint>
(可选) 修改文件配置 config/filesystems.php
"default" => env("FILESYSTEM_DRIVER", "oss"),
// ...
"disks"=>[
// ...
"oss" => [
"driver" => "oss",
"access_key_id" => env("OSS_ACCESS_KEY_ID"), // 必填, 阿里云的AccessKeyId
"access_key_secret" => env("OSS_ACCESS_KEY_SECRET"), // 必填, 阿里云的AccessKeySecret
"bucket" => env("OSS_BUCKET"), // 必填, 对象存储的Bucket, 示例: my-bucket
"endpoint" => env("OSS_ENDPOINT"), // 必填, 对象存储的Endpoint, 示例: oss-cn-shanghai.aliyuncs.com
"internal" => env("OSS_INTERNAL", null), // 选填, 内网上传地址,填写即启用 示例: oss-cn-shanghai-internal.aliyuncs.com
"domain" => env("OSS_DOMAIN", null), // 选填, 绑定域名,填写即启用 示例: oss.my-domain.com
"prefix" => env("OSS_PREFIX", ""), // 选填, 统一存储地址前缀
"use_ssl" => env("OSS_SSL", false), // 选填, 是否使用HTTPS
"reverse_proxy" => env("OSS_REVERSE_PROXY", false), // 选填, 域名是否使用NGINX代理绑定
"throw" => env("OSS_THROW", false), // 选填, 是否抛出引起错误的异常,默认出现错误时,不抛出异常仅返回false
"options" => [], // 选填, 添加全局配置参数, 示例: [\OSS\OssClient::OSS_CHECK_MD5 => false]
"macros" => [] // 选填, 添加自定义Macro, 示例: [\App\Macros\ListBuckets::class, \App\Macros\CreateBucket::class]
],
// ...
]
快速使用
use Illuminate\Support\Facades\Storage;
$storage = Storage::disk("oss");
写入
Storage::disk("oss")->putFile("dir/path", "/local/path/file.txt");
Storage::disk("oss")->putFileAs("dir/path", "/local/path/file.txt", "file.txt");
Storage::disk("oss")->put("dir/path/file.txt", file_get_contents("/local/path/file.txt"));
$fp = fopen("/local/path/file.txt","r");
Storage::disk("oss")->put("dir/path/file.txt", $fp);
fclose($fp);
Storage::disk("oss")->prepend("dir/path/file.txt", "Prepend Text");
Storage::disk("oss")->append("dir/path/file.txt", "Append Text");
Storage::disk("oss")->put("dir/path/secret.txt", "My secret", "private");
Storage::disk("oss")->put("dir/path/download.txt", "Download content", ["headers" => ["Content-Disposition" => "attachment;filename=download.txt"]]);
读取
Storage::disk("oss")->url("dir/path/file.txt");
Storage::disk("oss")->temporaryUrl("dir/path/file.txt", \Carbon\Carbon::now()->addMinutes(30));
Storage::disk("oss")->get("dir/path/file.txt");
Storage::disk("oss")->exists("dir/path/file.txt");
Storage::disk("oss")->size("dir/path/file.txt");
Storage::disk("oss")->lastModified("dir/path/file.txt");
删除
Storage::disk("oss")->delete("dir/path/file.txt");
Storage::disk("oss")->delete(["dir/path/file1.txt", "dir/path/file2.txt"]);
文件操作
Storage::disk("oss")->copy("dir/path/file.txt", "dir/path/file_new.txt");
Storage::disk("oss")->move("dir/path/file.txt", "dir/path/file_new.txt");
Storage::disk("oss")->rename("dir/path/file.txt", "dir/path/file_new.txt");
文件夹操作
Storage::disk("oss")->makeDirectory("dir/path");
Storage::disk("oss")->deleteDirectory("dir/path");
Storage::disk("oss")->files("dir/path");
Storage::disk("oss")->allFiles("dir/path");
Storage::disk("oss")->directories("dir/path");
Storage::disk("oss")->allDirectories("dir/path");
使用 Macro
Storage::disk("oss")->appendObject("dir/path/news.txt", "The first line paragraph.", 0);
Storage::disk("oss")->appendObject("dir/path/news.txt", "The second line paragraph.", 25);
Storage::disk("oss")->appendObject("dir/path/news.txt", "The last line paragraph.", 51);
Storage::disk("oss")->appendFile("dir/path/file.zip", "dir/path/file.zip.001", 0);
Storage::disk("oss")->appendFile("dir/path/file.zip", "dir/path/file.zip.002", 1024);
Storage::disk("oss")->appendFile("dir/path/file.zip", "dir/path/file.zip.003", 1024);
自定义 Macro
开发 Macro
namespace App\Macros;
use AlphaSnow\LaravelFilesystem\Aliyun\Macros\AliyunMacro;
class ListBuckets implements AliyunMacro
{
// ...
}
参考实例代码: AppendObject.php
修改配置
[
"macros" => [\App\Macros\ListBuckets::class]
]
使用 Macro
Storage::disk("oss")->listBuckets()
使用 OssClient
use AlphaSnow\LaravelFilesystem\Aliyun\OssClientAdapter;
$adapter = new OssClientAdapter(Storage::disk("oss"));
$adapter->client()->appendObject($adapter->bucket(), $adapter->path("dir/path/file.txt"), "contents", 0, $adapter->options(["visibility" => "private"]));
文档
问题
如使用中遇到问题，提交 Issue
许可证
MIT
提供