「擴展包」Laravel-filesystem-oss 2.0 發佈

時間 2021-06-06 標籤 php html 前端 vue nginx laravel git github web shell

GitHub：https://github.com/iiDestiny/...php

最近有時間把以前寫的 oss 擴展包給升級了一下，改動以下html

新增獲取官方 SDK 完整處理能力插件
優化獲取直傳配置方法，新增自定義回調參數
新增直傳回調驗籤插件，讓驗籤變得簡單
修復直傳回調功能，讓 oss 服務器可正常進入應用服務器回調
新增 bucket 切換能力
新增針對「私有 bucket」訪問資源能力
優化 readme 文檔，讓讀者更加容易理解

擴展包要求

PHP >= 7.0

安裝命令

$ composer require "iidestiny/laravel-filesystem-oss" -vvv

配置

將服務提供者 Iidestiny\LaravelFilesystemOss\OssStorageServiceProvider::class 註冊到 config/app.php 文件:

'providers' => [
    // Other service providers...
    Iidestiny\LaravelFilesystemOss\OssStorageServiceProvider::class,
],

Laravel 5.5+ 會自動註冊服務提供者可忽略

在 config/filesystems.php 配置文件中添加你的新驅動

<?php

return [
   'disks' => [
        //...
        'oss' => [
            'driver' => 'oss',
            'root' => '', // 設置上傳時根前綴
            'access_key' => env('OSS_ACCESS_KEY'),
            'secret_key' => env('OSS_SECRET_KEY'),
            'endpoint'   => env('OSS_ENDPOINT'), // 使用 ssl 這裏設置如: https://oss-cn-beijing.aliyuncs.com
            'bucket'     => env('OSS_BUCKET'),
            'isCName'    => env('OSS_IS_CNAME', false), // 若是 isCname 爲 false，endpoint 應配置 oss 提供的域名如：`oss-cn-beijing.aliyuncs.com`，不然爲自定義域名，，cname 或 cdn 請自行到阿里 oss 後臺配置並綁定 bucket
            // 若是有更多的 bucket 須要切換，就添加全部bucket，默認的 bucket 填寫到上面，不要加到 buckets 中
            'buckets'=>[
                'test'=>[
                    'access_key' => env('OSS_ACCESS_KEY'),
                    'secret_key' => env('OSS_SECRET_KEY'),
                    'bucket'     => env('OSS_TEST_BUCKET'),
                    'endpoint'   => env('OSS_TEST_ENDPOINT'),
                    'isCName'    => env('OSS_TEST_IS_CNAME', false),
                ],
                //...
            ],
        ],
        //...
    ]
];

基本使用

<?php

$disk = Storage::disk('oss');

// 上傳
$disk->put('avatars/filename.jpg', $fileContents);

// 檢查文件是否存在
$exists = $disk->has('file.jpg');

// 獲取文件修改時間
$time = $disk->lastModified('file1.jpg');
$time = $disk->getTimestamp('file1.jpg');

// 拷貝文件
$disk->copy('old/file1.jpg', 'new/file1.jpg');

// 移動文件也可更名
$disk->move('old/file1.jpg', 'new/file1.jpg');

// 獲取文件內容
$contents = $disk->read('folder/my_file.txt');

以上方法可在 laravel-filesystem-doc 查閱前端

進階使用

// 獲取文件訪問地址「公共讀的 bucket 才生效」
$url = $disk->getUrl('folder/my_file.txt');

// 設置文件訪問有效期「$timeout 爲多少秒過時」「私有 bucket 纔可看見效果」
$url = $disk->signUrl('cat.png', $timeout, ['x-oss-process' => 'image/circle,r_100']);

// 和 signurl 功能同樣，區別在於 $expiration 是將來過時時間如：2019-05-05 17:50:32 時連接失效
$url = $disk->getTemporaryUrl('file.md', $expiration);

// 可切換其餘 bucket「須要在 config 配置文件中配置 buckets」
$exists = $disk->bucket('test')->has('file.jpg');

獲取官方完整 OSS 處理能力

阿里官方 SDK 可能處理了更多的事情，若是你想獲取完整的功能可經過此插件獲取，
而後你將擁有完整的 oss 處理能力vue

// 獲取完整處理能力
$kernel = $disk->kernel();

// 例如：防盜鏈功能
$refererConfig = new RefererConfig();
// 設置容許空Referer。
$refererConfig->setAllowEmptyReferer(true);
// 添加Referer白名單。Referer參數支持通配符星號（*）和問號（？）。
$refererConfig->addReferer("www.aliiyun.com");
$refererConfig->addReferer("www.aliiyuncs.com");

$kernel->putBucketReferer($bucket, $refererConfig);

更多功能請查看官方 SDK 手冊

前端 web 直傳配置

oss 直傳有三種方式，當前擴展包使用的是最完整的服務端簽名直傳並設置上傳回調方式，擴展包只生成前端頁面上傳所需的簽名參數，前端上傳實現可參考官方文檔中的實例或自行搜索nginx

/**
 * 1. 前綴如：'images/'
 * 2. 回調服務器 url
 * 3. 回調自定義參數，oss 回傳應用服務器時會帶上
 * 4. 當前直傳配置連接有效期
 */
$config = $disk->signatureConfig($prefix = '/', $callBackUrl = '', $customData = [], $expire = 30);

直傳回調驗籤

當設置了直傳回調後，能夠經過驗籤插件，驗證並獲取 oss 傳回的數據文檔laravel

注意事項：git

若是沒有 Authorization 頭信息致使驗籤失敗須要先在 apache 或者 nginx 中設置 rewrite
以 apache 爲例，修改 httpd.conf 在 DirectoryIndex index.php 這行下面增長「RewriteEngine On」「RewriteRule .* - [env=HTTP_AUTHORIZATION:%{HTTP:Authorization},last]」

// 驗籤，就是如此簡單
// $verify 驗簽結果，$data 回調數據
list($verify, $data) = $disk->verify();
// [$verify, $data] = $disk->verify(); // php 7.1 +

if (!$verify) {
    // 驗證失敗處理，此時 $data 爲驗籤失敗提示信息
}

// 注意必定要返回 json 格式的字符串，由於 oss 服務器只接收 json 格式，不然給前端報 CallbackFailed
return response()->json($data);

直傳回調驗籤後返回給前端的數據「包括自定義參數」，例如github

{
    "filename": "user/15854050909488182.png",
    "size": "56039",
    "mimeType": "image/png",
    "height": "473",
    "width": "470",
    "custom_name": "zhangsan",
    "custom_age": "24"
}

這其實要看你回調通知方法具體怎麼返回，若是直接按照文檔給的方法返回是這個樣子

前端直傳組件分享「vue + element」

<template>
  <div>
    <el-upload
      class="avatar-uploader"
      :action="uploadUrl"
      :on-success="handleSucess"
      :on-change="handleChange"
      :before-upload="handleBeforeUpload"
      :show-file-list="false"
      :data="data"
      :on-error="handleError"
      :file-list="files"
    >
      <img v-if="dialogImageUrl" :src="dialogImageUrl" class="avatar">
      <i v-else class="el-icon-plus avatar-uploader-icon" />
    </el-upload>
  </div>
</template>

<script>
import { getOssPolicy } from '@/api/oss' // 這裏就是獲取直傳配置接口

export default {
  name: 'Upload',
  props: {
    url: {
      type: String,
      default: null
    }
  },
  data() {
    return {
      uploadUrl: '', // 上傳提交地址
      data: {}, // 上傳提交額外數據
      dialogImageUrl: '', // 預覽圖片
      files: [] // 上傳的文件
    }
  },
  computed: {},
  created() {
    this.dialogImageUrl = this.url
  },
  methods: {
    handleChange(file, fileList) {
      console.log(file, fileList)
    },
    // 上傳以前處理動做
    async handleBeforeUpload(file) {
      const fileName = this.makeRandomName(file.name)
      try {
        const response = await getOssPolicy()

        this.uploadUrl = response.host

        // 組裝自定義參數「若是要自定義回傳參數這段代碼不能省略」
        if (Object.keys(response['callback-var']).length) {
          for (const [key, value] of Object.entries(response['callback-var'])) {
            this.data[key] = value
          }
        }

        this.data.policy = response.policy
        this.data.OSSAccessKeyId = response.accessid
        this.data.signature = response.signature
        this.data.host = response.host
        this.data.callback = response.callback
        this.data.key = response.dir + fileName
      } catch (error) {
        this.$message.error('獲取上傳配置失敗')
        console.log(error)
      }
    },
    // 文件上傳成功處理
    handleSucess(response, file, fileList) {
      const fileUrl = this.uploadUrl + this.data.key
      this.dialogImageUrl = fileUrl
      this.$emit('update:url', fileUrl)
      this.files.push({
        name: this.data.key,
        url: fileUrl
      })
    },
    // 上傳失敗處理
    handleError() {
      this.$message.error('上傳失敗')
    },
    // 隨機名稱
    makeRandomName(name) {
      const randomStr = Math.random().toString().substr(2, 4)
      const suffix = name.substr(name.lastIndexOf('.'))
      return Date.now() + randomStr + suffix
    }
  }

}
</script>

<style>
.avatar-uploader .el-upload {
    border: 1px dashed #d9d9d9;
    border-radius: 6px;
    cursor: pointer;
    position: relative;
    overflow: hidden;
  }
  .avatar-uploader .el-upload:hover {
    border-color: #409EFF;
  }
  .avatar-uploader-icon {
    font-size: 28px;
    color: #8c939d;
    width: 150px;
    height: 150px;
    line-height: 150px;
    text-align: center;
  }
  .avatar {
    width: 150px;
    height: 150px;
    display: block;
  }
</style>

擴展包確定還有不足之處，最後歡迎各位 PR 以帶來更好的功能。😝