代码拉取完成，页面将自动刷新
Loading...
English | 简体中文
Aliyun OSS Laravel
这个包是封装 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-laravelcomposer install安装依赖。 - 修改环境配置
.envOSS_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 "is_cname" => env("OSS_CNAME", false), // 选填, 若Endpoint为自定义域名，此项要为true，见：https://github.com/aliyun/aliyun-oss-php-sdk/blob/572d0f8e099e8630ae7139ed3fdedb926c7a760f/src/OSS/OssClient.php#L113C1-L122C78 "prefix" => env("OSS_PREFIX", ""), // 选填, 统一存储地址前缀 "use_ssl" => env("OSS_SSL", false), // 选填, 是否使用HTTPS "throw" => env("OSS_THROW", false), // 选填, 是否抛出引起错误的异常,默认出现错误时,不抛出异常仅返回false "signatureVersion" => env("OSS_SIGNATURE_VERSION", "v1"), // 选填, 选择使用v1或v4签名版本 "region" => env("OSS_REGION", ""), // 选填, 仅在使用v4签名版本时启用, 示例: cn-shanghai "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方法
写入
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);
Storage::disk("oss")->processObject("dir/path/image.jpg", "image/resize,l_1000");
自定义 Macro
- 开发 Macro
参考实例代码: AppendObject.php
namespace App\Macros; use AlphaSnow\LaravelFilesystem\Aliyun\Macros\AliyunMacro; class ListBuckets implements AliyunMacro { // ... }
- 修改配置
[ "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
贡献者
Star
授权
The MIT License (MIT)
Copyright (c) 2016 AlphaSnow
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
举报
请认真填写举报原因，尽可能描述详细。
请选择举报类型
误判申诉
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
发行版
暂无发行版
开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：
1. 开源生态
- 生产力：来评估开源项目输出软件制品和开源价值的能力。
- 创新力：用于评估开源软件及其生态系统的多样化程度。
- 稳健性：用于评估开源项目面对多变的发展环境，抵御内外干扰并自我恢复的能力。
2. 协作、人、软件
- 协作：代表了开源开发行为中协作的程度和深度。
- 人：观察开源项目核心人员在开源项目中的影响力，并通过第三方视角考察用户和开发者对开源项目的评价。
- 软件：从开源项目对外输出的制品评估其价值最终落脚点。也是开源评估最“古老”的主流方向之一“开源软件” 的具体表现。
3. 评估模型
-
基于“开源生态”与“协作、人、软件”的维度，找到与该目标直接或间接相关的可量化指标，对开源项目健康与生态进行量化评估，最终形成开源评估指数。
贡献者
全部近期动态
编辑仓库简介
简介内容
主页
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化