Laravel 檔案系統擴充套件包 + 檔案管理系統
適配阿里雲OSS,七牛雲
簡介
通用檔案管理器,支援阿里雲OSS,七牛雲直傳
安裝
composer require telstatic/rakan
使用
Model user.php
<?php
namespace App\Models\User;
use TELstatic\Rakan\Traits\Rakan;
...
class User {
use Rakan;
}
Controller FileController.php
<?php
namespace App\Http\Controller\User;
use App\Models\User;
use Illuminate\Http\Request;
class FileController {
public $user;
public function __constract(){
$this->user =User::find(1);
}
public function getFiles(Request $request){
return $this->user->prefix('rakan')->module('default')->->getFiles($request);
}
public function getPolicy(){
return $this->user->getPolicy();
}
public function createFolder(Request $request){
return $this->user->createFolder($request->pid,$request->name);
}
public function deleteFiles(Request $request){
return $this->user->deleteFiles($request->ids);
}
public function checkFile(Request $request){
return $this->checkFile($request->path);
}
}
屬性
name | type | require | default | memo |
---|---|---|---|---|
prefix | string | true | rakan | 目錄字首 |
module | string | true | default | 模組 |
gateway | string | true | oss | 閘道器 |
expire | int | false | 3600 | 策略有效時間 |
配置
name | default | memo |
---|---|---|
OSS_HOST | null | OSS上傳地址 |
OSS_BUCKET | null | OSS bucket |
OSS_AK | null | OSS access_key |
OSS_SK | null | OSS secret_key |
OSS_ENDPOINT | null | OSS endpoint |
OSS_EXPIRE | 3600 | 策略有效時間 單位: s |
QINIU_AK | null | 七牛 access_key |
QINIU_SK | null | 七牛 secret_key |
QINIU_HOST | null | 七牛外鏈域名 |
QINIU_BUCKET | null | 七牛 bucket |
QINIU_EXPIRE | 3600 | 策略有效時間 單位: s |
方法
- gateway 設定閘道器
引數
name | type | require | default | memo |
---|---|---|---|---|
gateway | string | false | oss | 閘道器 oss,qiniu 預設oss |
- prefix 設定目錄字首
引數
name | type | require | default | memo |
---|---|---|---|---|
prefix | string | false | rakan | 目錄字首 |
- module 設定模組
引數
name | type | require | default | memo |
---|---|---|---|---|
module | string | false | default | 模組名 |
- getFiles 獲取檔案及目錄
引數
name | type | require | default | memo |
---|---|---|---|---|
pid | string | false | 0 | 父級目錄ID |
返回
形如:
{
"parent": {
"id": "1",
"path": "platform/q47G4R",
"name": "Root",
"type": "folder",
"pid": 0,
"module": "admin",
"target_id": 1,
"sort": 255,
"updated_at": "2018-08-21 20:07:39",
"created_at": "2018-08-21 20:07:39",
"url": null,
"checked": false
},
"children": {
"current_page": 1,
"data": [
{
"id": "2",
"pid": "1",
"path": "platform/q47G4R/test1",
"name": "test1",
"module": "admin",
"target_id": 1,
"type": "folder",
"sort": 255,
"updated_at": "2018-08-23 09:12:15",
"created_at": "2018-08-23 09:12:15",
"url": null,
"checked": false
}
],
"first_page_url": "http://www.test.local/admin?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://www.test.local/admin?page=1",
"next_page_url": null,
"path": "http://www.test.local/admin",
"per_page": 50,
"prev_page_url": null,
"to": 1,
"total": 1
}
}
- createFolder 建立目錄
引數
name | type | require | default | memo |
---|---|---|---|---|
pid | string | true | null | 父級目錄ID |
name | string | true | null | 目錄名稱 |
返回
狀態碼 + 錯誤提示
形如:
{
status:500,
msg:'目錄已存在'
}
{
status:200,
msg:'目錄建立成功'
}
- checkFile 檢查檔案是否存在
注意閘道器設定
引數
name | type | require | default | memo |
---|---|---|---|---|
path | string | true | null | 檔案路徑 |
返回
狀態碼 + 錯誤提示
形如
{
status :500,
msg : '檔案已存在'
}
{
status :200,
msg : ''
}
- deleteFiles 刪除檔案及目錄
注意閘道器設定
引數
name | type | require | default | memo |
---|---|---|---|---|
ids | array | true | null | 檔案或目錄ID集合 |
返回
狀態 + 錯誤提示
形如
{
status:200,
msg:'刪除成功'
}
{
status:500,
msg:'目錄 test 不為空'
}
- getPolicy 獲取上傳策略
注意閘道器設定
返回
形如
{
"data": {
"OSSAccessKeyId": "{your-access_key}",
"Policy": "eyleHBpcmF0aW9uIjoiMjAxOS0wMS0wM1QwMzozNTo1OFoiLCJjb25kaXRpb25zIjpbWyJjb250ZW50LWxlbmd0aC1yYW5nZSIsMCwxMDQ4NTc2MDAwXV19",
"Signature": "oeE36A1SsWWBZJ6iWx3rSeSBWSQ=",
"success_action_status": 200,
"key": ""
},
"expire": "3600"
}
{
"data": {
"token": "JQ4aZNe87tA2FG-I01lxp7kJArP6opY_renx7MU:Tg8Zrx5XIVNY4fwhHK9nX200UcM=:eyJzY29wZSI6InRlbHN0YXRpYyIsImRlYWRsaW5lIjoxNTQ2NDg2NjE4fQ==",
"key": ""
},
"expire": "3600"
}
回撥路由
路由名稱: rakan.callback
Tip: 將路由 rakan.callback 加入白名單
VerifyCsrfToken.php
protected $except = [
'rakan/callback/*'
];
檔案系統
Storage::disk('qiniu')->putFileAs('avatars', new File($file), 'avatar3.jpg'); //指定檔名上傳檔案
Storage::disk('qiniu')->put('avatars/avatar1.jpg', file_get_contents($file));//不指定檔名上傳檔案
Storage::disk('qiniu')->prepend('file.log', 'Prepended Text');//檔案頭部追加
Storage::disk('qiniu')->append('file.log', 'Appended Text');//檔案尾部追加
Storage::disk('qiniu')->copy('avatars/avatar1.jpg', 'faces/avatar1.jpg');//複製檔案
Storage::disk('qiniu')->move('avatars/avatar3.jpg', 'avatars/avatar5.jpg');//移動檔案
$visibility = Storage::disk('oss')->getVisibility('avatars/avatar5.jpg');//獲取檔案可見性,不支援七牛
Storage::disk('oss')->setVisibility('avatars/avatar5.jpg', 'public');//設定檔案可見性,不支援七牛
Storage::disk('qiniu')->delete('avatars/avatar1.jpg'); //刪除檔案
Storage::disk('qiniu')->delete(['avatars/avatar5.jpg', 'faces/avatar1.jpg']);//刪除多個檔案
Storage::disk('qiniu')->makeDirectory('avatars/test'); //建立目錄
Storage::disk('qiniu')->deleteDirectory('avatars/test'); //刪除目錄及該目錄下其他檔案
Storage::disk('qiniu')->files('/'); //獲取指定目錄下檔案
Storage::disk('qiniu')->allFiles('/'); //獲取全部檔案
Storage::disk('qiniu')->directories('/'); //獲取指定目錄下目錄
Storage::disk('qiniu')->allDirectories('/'); //獲取全部目錄
Storage::disk('qiniu')->exists('file.log'); //判斷檔案是否存在
Storage::disk('qiniu')->get('file.log'); //獲取檔案內容
Storage::disk('qiniu')->url('Pairs.jpg'); //獲取檔案訪問地址
Storage::disk('qiniu')->size('test/Paris.jpg');//獲取檔案大小
Storage::disk('qiniu')->lastModified('test/Paris.jpg');//獲取檔案最後修改時間
TODO
1. 雲適配
騰訊COS,又拍雲,etc.
2. 多檔案型別適配
根據不同MineType型別返回不同圖示
TIPS
- 配套前臺 https://github.com/TELstatic/xayah
- 測試程式碼 https://github.com/TELstatic/RakanDemo
3.線上DEMO http://rakan.static.ink/home
感謝開源
參考資料
本作品採用《CC 協議》,轉載必須註明作者和本文連結