大規格文件的上傳優化

2021-12-23 OSC開源社區

在開發過程中,收到這樣一個問題反饋,在網站上傳 100 MB 以上的文件經常失敗,重試也要等老半天,這就難為需要上傳大規格文件的用戶了。那麼應該怎麼做才能快速上傳,就算失敗了再次發送也能從上次中斷的地方繼續上傳呢?下文為你揭曉答案~

溫馨提示:配合 Demo 源碼[1]一起閱讀效果更佳

整體思路

第一步是結合項目背景,調研比較優化的解決方案。文件上傳失敗是老生常談的問題,常用方案是將一個大文件切片成多個小文件,並行請求接口進行上傳,所有請求得到響應後,在伺服器端合併所有的分片文件。當分片上傳失敗,可以在重新上傳時進行判斷,只上傳上次失敗的部分,減少用戶的等待時間,緩解伺服器壓力。這就是分片上傳文件。

大文件上傳

那麼如何實現大文件分片上傳呢?

流程圖如下:

大文件上傳流程圖

分為以下步驟實現:

1. 文件 MD5 加密—

MD5 是文件的唯一標識,可以利用文件的 MD5 查詢文件的上傳狀態。

根據文件的修改時間、文件名稱、最後修改時間等信息,通過 spark-md5[2] 生成文件的 MD5。需要注意的是,大規格文件需要分片讀取文件,將讀取的文件內容添加到 spark-md5[3] 的 hash 計算中,直到文件讀取完畢,最後返回最終的 hash 碼到 callback 回調函數裡面。這裡可以根據需要添加文件讀取的進度條。

MD5 加密過程

實現方法如下:

// 修改時間+文件名稱+最後修改時間-->MD5
md5File (file) {
  return new Promise((resolve, reject) => {
    let blobSlice =
      File.prototype.slice ||
      File.prototype.mozSlice ||
      File.prototype.webkitSlice
    let chunkSize = file.size / 100
    let chunks = 100
    let currentChunk = 0
    let spark = new SparkMD5.ArrayBuffer()
    let fileReader = new FileReader()
    fileReader.onload = function (e) {
      console.log('read chunk nr', currentChunk + 1, 'of', chunks)
      spark.append(e.target.result) // Append array buffer
      currentChunk++
      if (currentChunk < chunks) {
        loadNext()
      } else {
        let cur = +new Date()
        console.log('finished loading')
        // alert(spark.end() + '---' + (cur - pre)); // Compute hash
        let result = spark.end()
        resolve(result)
      }
    }
    fileReader.onerror = function (err) {
      console.warn('oops, something went wrong.')
      reject(err)
    }
    function loadNext () {
      let start = currentChunk * chunkSize
      let end =
        start + chunkSize >= file.size ? file.size : start + chunkSize
      fileReader.readAsArrayBuffer(blobSlice.call(file, start, end))
    }
    loadNext()
  })
}

2. 查詢文件狀態—

前端得到文件的 MD5 後,從後臺查詢是否存在名稱為 MD5 的文件夾,如果存在,列出文件夾下所有文件,得到已上傳的切片列表,如果不存在,則已上傳的切片列表為空。

// 校驗文件的MD5
checkFileMD5 (file, fileName, fileMd5Value, onError) {
  const fileSize = file.size
  const { chunkSize, uploadProgress } = this
  this.chunks = Math.ceil(fileSize / chunkSize)
  return new Promise(async (resolve, reject) => {
    const params = {
      fileName: fileName,
      fileMd5Value: fileMd5Value,
    }
    const { ok, data } = await services.checkFile(params)
    if (ok) {
      this.hasUploaded = data.chunkList.length
      uploadProgress(file)
      resolve(data)
    } else {
      reject(ok)
      onError()
    }
  })
}

3. 文件分片—

文件上傳優化的核心就是文件分片,Blob 對象中的 slice 方法可以對文件進行切割,File 對象是繼承 Blob 對象的,因此 File 對象也有 slice 方法。

定義每一個分片文件的大小變量為 chunkSize,通過文件大小 FileSize 和分片大小 chunkSize 得到分片數量 chunks,使用 for 循環和 file.slice() 方法對文件進行分片,序號為 0 - n,和已上傳的切片列表做比對,得到所有未上傳的分片,push 到請求列表 requestList。

文件分片
async checkAndUploadChunk (file, fileMd5Value, chunkList) {
  let { chunks, upload } = this
  const requestList = []
  for (let i = 0; i < chunks; i++) {
    let exit = chunkList.indexOf(i + '') > -1
    // 如果已經存在, 則不用再上傳當前塊
    if (!exit) {
      requestList.push(upload(i, fileMd5Value, file))
    }
  }
  console.log({ requestList })
  const result =
    requestList.length > 0
      ? await Promise.all(requestList)
        .then(result => {
          console.log({ result })
          return result.every(i => i.ok)
        })
        .catch(err => {
          return err
        })
      : true
  console.log({ result })
  return result === true
}

4. 上傳分片—

調用 Promise.all 並發上傳所有的切片,將切片序號、切片文件、文件 MD5 傳給後臺。

後臺接收到上傳請求後,首先查看名稱為文件 MD5 的文件夾是否存在,不存在則創建文件夾,然後通過 fs-extra 的 rename 方法,將切片從臨時路徑移動切片文件夾中,結果如下:

上傳分片

當全部分片上傳成功,通知服務端進行合併,當有一個分片上傳失敗時,提示「上傳失敗」。在重新上傳時,通過文件 MD5 得到文件的上傳狀態,當伺服器已經有該 MD5 對應的切片時,代表該切片已經上傳過,無需再次上傳,當伺服器找不到該 MD5 對應的切片時,代表該切片需要上傳,用戶只需上傳這部分切片,就可以完整上傳整個文件,這就是文件的斷點續傳。

斷點續傳示意圖
// 上傳chunk
upload (i, fileMd5Value, file) {
  const { uploadProgress, chunks } = this
  return new Promise((resolve, reject) => {
    let { chunkSize } = this
    // 構造一個表單,FormData是HTML5新增的
    let end =
      (i + 1) * chunkSize >= file.size ? file.size : (i + 1) * chunkSize
    let form = new FormData()
    form.append('data', file.slice(i * chunkSize, end)) // file對象的slice方法用於切出文件的一部分
    form.append('total', chunks) // 總片數
    form.append('index', i) // 當前是第幾片
    form.append('fileMd5Value', fileMd5Value)
    services
      .uploadLarge(form)
      .then(data => {
        if (data.ok) {
          this.hasUploaded++
          uploadProgress(file)
        }
        console.log({ data })
        resolve(data)
      })
      .catch(err => {
        reject(err)
      })
  })
}

5. 上傳進度—

雖然分片批量上傳比大文件單次上傳會快很多,也還是有一段加載時間,這時應該加上上傳進度的提示,實時顯示文件上傳進度。

原生 Javascript 的 XMLHttpRequest 有提供 progress 事件,這個事件會返回文件已上傳的大小和總大小。項目使用 axios[4] 對 ajax 進行封裝,可以在 config 中增加 onUploadProgress 方法,監聽文件上傳進度。

上傳進度
const config = {
  onUploadProgress: progressEvent => {
    var complete = (progressEvent.loaded / progressEvent.total * 100 | 0) + '%'
  }
}
services.uploadChunk(form, config)

6. 合併分片—

上傳完所有文件分片後,前端主動通知服務端進行合併,服務端接受到這個請求時主動合併切片,通過文件 MD5 在伺服器的文件上傳路徑中找到同名文件夾。從上文可知,文件分片是按照分片序號命名的,而分片上傳接口是異步的,無法保證伺服器接收到的切片是按照請求順序拼接。所以應該在合併文件夾裡的分片文件前,根據文件名進行排序,然後再通過 concat-files 合併分片文件,得到用戶上傳的文件。至此大文件上傳就完成了。

merge合併分片示意圖

Node 端代碼:

// 合併文件
exports.merge = {
  validate: {
    query: {
      fileName: Joi.string()
        .trim()
        .required()
        .description('文件名稱'),
      md5: Joi.string()
        .trim()
        .required()
        .description('文件md5'),
      size: Joi.string()
        .trim()
        .required()
        .description('文件大小'),
    },
  },
  permission: {
    roles: ['user'],
  },
  async handler (ctx) {
    const { fileName, md5, size } = ctx.request.query
    let { name, base: filename, ext } = path.parse(fileName)
    const newFileName = randomFilename(name, ext)
    await mergeFiles(path.join(uploadDir, md5), uploadDir, newFileName, size)
      .then(async () => {
        const file = {
          key: newFileName,
          name: filename,
          mime_type: mime.getType(`${uploadDir}/${newFileName}`),
          ext,
          path: `${uploadDir}/${newFileName}`,
          provider: 'oss',
          size,
          owner: ctx.state.user.id,
        }
        const key = encodeURIComponent(file.key)
          .replace(/%/g, '')
          .slice(-100)
        file.url = await uploadLocalFileToOss(file.path, key)
        file.url = getFileUrl(file)
        const f = await File.create(omit(file, 'path'))
        const files = []
        files.push(f)
        ctx.body = invokeMap(files, 'toJSON')
      })
      .catch(() => {
        throw Boom.badData('大文件分片合併失敗,請稍候重試~')
      })
  },
}

總結

本文講述了大規格文件上傳優化的一些做法,總結為以下 4 點:

Blob.slice 將文件切片,並發上傳多個切片,所有切片上傳後告知伺服器合併,實現大文件分片上傳;原生 XMLHttpRequest 的 onprogress 對切片上傳進度的監聽,實時獲取文件上傳進度;spark-md5 根據文件內容算出文件 MD5,得到文件唯一標識,與文件上傳狀態綁定;分片上傳前通過文件 MD5 查詢已上傳切片列表,上傳時只上傳未上傳過的切片,實現斷點續傳。

參照 Demo 源碼[5] 可快速上手上述功能,希望本文能對你有所幫助,感謝閱讀 ❤️

參考資料[1]

Demo 源碼: https://github.com/jiaozitang/fileUploadDemo

[2]

spark-md5: https://www.npmjs.com/package/spark-md5

[3]

spark-md5: https://www.npmjs.com/package/spark-md5

[4]

axios: https://www.kancloud.cn/yunye/axios/234845

[5]

Demo 源碼: https://github.com/jiaozitang/fileUploadDemo

相關焦點

  • 常用圖片文件下載上傳方法
    本文整理了前端常用的下載文件以及上傳文件的方法。以vue+element ui+axios為例,不使用el封裝好的上傳組件,這裡自行進行封裝實現,完整demo可以查看【閱讀原文】上傳文件以圖片為例,文件上傳可以省略預覽圖片功能圖片上傳可以使用2種方式:文件流和base64;1.文件流上傳+預覽:
  • 文件上傳
    this.success({}, '文件上傳成功');}背景2任何問題,量級比較小的情況下,都比較簡單,比如說你做增刪改查沒問題,但是比方說你想做高並發、高流量、分布式就會比較難文件上傳其實很簡答,但是比方說我們要上傳1個G的文件或者2個G的文件件,你該怎麼做?
  • input file文件上傳與批量上傳
    ### 文件上傳- 利用 input 標籤設置 type="file" 打開本地的資源管理器;- input 標籤的 accept 屬性可以設置上傳什麼類型的文件;accept 屬性並不會驗證選中文件的類型.
  • 功能強大的 JS 文件上傳庫:FilePond
    作者:HelloGitHub-kalifun這是 HelloGitHub 推出的《講解開源項目》[1]系列,今天給大家推薦一個 JavaScript 開源的文件上傳庫項目——FilePond一、介紹 1.1 FilePond它是一個 JavaScript 文件上傳庫。
  • 基於 Laravel + Vue 組件實現文件異步上傳
    我們在上一篇教程中已經演示了如何通過 Request 請求實例獲取各種文本輸入數據,但是還有一種輸入數據我們沒有涉及到,那就是文件上傳。我們可以通過 Request 請求實例提供的 file 方法獲取用戶上傳文件,並將其保存到指定目錄從而完成文件上傳,接下來,我們將從前端到後端實現一個完整的用戶上傳文件功能,包括視圖、路由、控制器部分代碼。
  • 如何使用Node.js上傳文件
    我們將在下面簡要討論上下文,然後我將以自己的方式結束您上傳帶節點的文件。問題:信息過載搜索「JavaScript文件上傳」將產生大量結果,但乍看之下很難說出哪些實際示例針對您的特定需求。上傳文件當我們說「上傳」時,我們在談論什麼?「向上」和「向下」的概念分別暗示伺服器和客戶端存儲。我們正在獲取源文件並將其從一個存儲位置移動到另一個存儲位置。當我們在前端構建時,很明顯用戶的客戶端是「向下」位置,並且上傳會將用戶文件的副本從其客戶端「向上」移動到伺服器,雲或CDN。
  • Wish如何上傳我的CSV文件? Wish上傳CSV文件操作流程
    你可以通過如Microsoft Excel或Google Drive表格等方式創建CSV文件。本質上,CSV文件是一張每個單元格均有對應屬性的電子表格。下面,Wish將會展示如何通過Google Drive表格建立CSV文件,並上傳到商戶後臺。   創建CSV文件 1)  為你的產品創建一個電子表格吧,這裡有一個模板供你參考。
  • JavaScript文件上傳詳解
    demo4 moxie文件上傳,進度提示 demo5 使用plupload實現了圖片上傳demo6 斷點續傳 demo7 plupload ui widget的示例 本教程包含7個 demo ,它們循序漸進、由淺入深地講解文件上傳。
  • PHP上傳文件和下載
    >在 B/S 程序中文件上傳已經成為一個常用功能。1.2 在伺服器端通過 PHP 處理上傳上傳文件的接收和處理是通過 PHP 腳本來處理的,具體需要通過以下三個方面信息:1)設置 PH 配置文件中的指令:用於精細地調節 PHP 的文件上傳功能。2)$FILES 多維數組:用於存儲各種與上傳文件有關的信息,其他數據還是使用 $_POST 獲取。
  • Python之Django文件上傳
    一、目標學習在Django下做個文件上傳的頁面、學習創建文件上傳目錄及設定二、試驗平臺windows7 , python3.7,Django2.1.5,三、概述本例較為簡單,僅介紹主要代碼,四、在項目根目錄創建靜態文件夾
  • XSS姿勢——文件上傳XSS
    0x01 簡單介紹一個文件上傳點是執行XSS應用程式的絕佳機會。
  • PHP編碼安全:上傳文件安全
    1、文件上傳漏洞以下是一個不安全的上傳代碼示例,即文件上傳PHP接收代碼upload.php。<?" value="上傳"></form>這是一個簡單的上傳文件功能,其中由用戶上傳文件,如果上傳成功,保存文件的路徑為http://伺服器路徑/uploads/文件名稱。
  • 國產高強度大規格鏈條破題
    廠房內一臺臺大型生產設備,將成人食指粗的鐵條打彎、連結、焊接,形成一條條大規格的鏈條。人眼看上去除了粗大看不出與普通鏈條的差別,專業設備檢測的數值卻能顯示出,硬度及抗拉強度甚至高於進口產品。  說起華海基業,實際上是經開區的「土著」,2005年在區內註冊成立後,先後成為首家將海外高端製造鏈條、鏈輪、刮板等機備件和變頻一體式電機技術、大流量泵站技術引進中國的企業。
  • 滲透測試中文件上傳技巧
    <上傳文件名fuzz字典根據語言、解析漏洞、中間件、系統特性以及一些繞過WAF的方法:黑名單、大小寫、ADS流、截斷、空格、長度、htaccess等生存文件名字典。A0上傳文件時如果轉換時比如轉成PDF等文件,嘗試在上傳文件中加入payload進行SSRF<iframe src="file:///etc/passwd" width=400height=400/><iframe src="file:///c:/windows/win.ini
  • 從建站打拿站 -- PHP(文件上傳)
    李白寫過那麼多詩,他自己會背麼?
  • 《雲班課》上傳音頻文件教程
    但是很多小夥伴都還不太清楚該如何上傳錄音文件,怎麼提交音頻文件?下面小編為大家帶來了雲班課上傳錄音文件的詳細教程,一起來看看。 雲班課怎麼上傳錄音文件? 超過2分鐘的錄音文件上傳方法: 1、在文件管理裡找到錄音機,然後找到那個需要上傳的音頻; 2、點編輯,再複製,把這個文件隨便粘貼到一個有名字的文件夾裡;
  • 前端本地文件操作與上傳
    如果需要限制上傳文件的大小就可以通過判斷size屬性有沒有超,單位是字節,而要判斷是否為圖片文件就可以通過type類型是否以image開頭。通過判斷文件名的後綴可能會不準,而通過這種判斷會比較準。/form-data" method="post">    <input type="file" name="fileContent"></form>如果xhr.send的是FormData類型話,它會自動設置enctype,如果你用默認表單提交上傳文件的話就得在form上面設置這個屬性,因為上傳文件只能使用POST的這種編碼。
  • 大規格瓷磚鋪貼也很簡單
    2018,大規格瓷磚成為行業熱門新寵,緹香將其應用於背景牆,大面積能承載更多設計元素,從視覺角度更趨於完美。那麼,大規格瓷磚在安裝上會不會更棘手,不怕,跟著緹香小編一起來,你會發現其實很簡單:大板鋪貼流程01.準備輔助神器:02.鋪貼前必須清理施工現場,保證基面乾燥。
  • 拆解 UI 組件 el-upload 文件上傳
    :是否支持選擇多個文件;limit:最大允許選擇的文件個數;auto-upload:選擇完文件是否自動開始上傳;disable:是否阻止用戶選擇文件;on-exceed:當用戶選擇的文件個數,超出 limit 屬性定義的值時觸發的回調;第二部分:上傳服務選擇完文件即可進行上傳處理
  • jQuery實現異步上傳一個或多個文件
    本文實例為大家分享了jQuery實現異步上傳一個或多個文件的具體代碼,供大家參考,具體內容如下首先使用SpringMvc文件上傳,需要引入第三方上傳文件的jar:<dependency> <groupId>commons-fileupload</groupId> <artifactId