JavaScript實(shí)現(xiàn)監(jiān)控上傳和下載進(jìn)度
一、寫在前面
網(wǎng)路的不穩(wěn)定性,網(wǎng)速的變化,會(huì)導(dǎo)致有時(shí)一個(gè)請(qǐng)求可能需要很長的的時(shí)間,而這個(gè)過程如果沒有相應(yīng)的提示,讓用戶感知進(jìn)度,這可能是一種糟糕的體驗(yàn)。這在體現(xiàn)請(qǐng)求進(jìn)度,加載進(jìn)度的需求,在文件上傳下載業(yè)務(wù)中,更為強(qiáng)烈。
下面從 XHR 請(qǐng)求和 axios 兩個(gè)角度,分析如何實(shí)現(xiàn)監(jiān)控請(qǐng)求進(jìn)度,獲取文件上傳下載進(jìn)度。
tips:上傳下載進(jìn)度監(jiān)控,不應(yīng)僅僅是數(shù)據(jù)傳輸進(jìn)度比的獲取,還應(yīng)包括傳輸過程可能出現(xiàn)的狀態(tài)。
二、xhr 監(jiān)控進(jìn)度
XHR 的出現(xiàn),在 web應(yīng)用發(fā)展歷史上是具有里程碑意義的,它使得 DHTML 的 D 更加真實(shí)。此外,ajax 和 axios 本質(zhì)上也是一種對(duì) XHR 的封裝實(shí)現(xiàn)。在 js 中我們無須依賴第三方插件,就可以實(shí)現(xiàn)異步請(qǐng)求,因?yàn)橛?XHR(new XMLHttpRequest()),這有時(shí)很有用。所以,幾遍在項(xiàng)目中可能很少再使用 XHR,而是使用它的某種實(shí)現(xiàn),例如 axios 或 ajax,了解 XHR 也是有意義的。
XHR 在監(jiān)控請(qǐng)求進(jìn)度上,其實(shí)提供了方便的API,下面是和 XHR 進(jìn)度相關(guān)的事件:
事件類型 | 說明 | 觸發(fā)次數(shù) |
---|---|---|
loadstart | 接收到響應(yīng)數(shù)據(jù)時(shí)觸發(fā)。 | 1次 |
progress | 當(dāng)請(qǐng)求接收到更多數(shù)據(jù)時(shí),周期性地觸發(fā) | 0或多次 |
error | 當(dāng) request 遭遇錯(cuò)誤時(shí)觸發(fā)。 | 0或多次 |
abort | 當(dāng) request 被停止時(shí)觸發(fā),例如當(dāng)程序調(diào)用 XMLHttpRequest.abort() 時(shí)。 | 0或多次 |
load | XMLHttpRequest請(qǐng)求成功完成時(shí)觸發(fā)。 | 0或多次 |
loadend | 當(dāng)請(qǐng)求結(jié)束時(shí)觸發(fā), 無論請(qǐng)求成功 ( load) 還是失敗 (abort 或 error)。 | 1次 |
上面的事件就可以方便用于監(jiān)控請(qǐng)求進(jìn)度,請(qǐng)求狀態(tài),progress 可能更為常用,這常常結(jié)合進(jìn)度回調(diào)的 event.loaded 和 event.total, 來獲取進(jìn)度的百分比。
①使用 XHR 監(jiān)控下載進(jìn)度示例:
let xhr = new XMLHttpRequest(); // 要監(jiān)控請(qǐng)求進(jìn)度,可以在 xhr 對(duì)象上注冊(cè)進(jìn)度相關(guān)的事件 // 每個(gè)請(qǐng)求,開始都會(huì)觸發(fā) loadStart,結(jié)束都會(huì)觸發(fā) loadEnd 事件,它們之間, // 還可能會(huì)觸發(fā)一個(gè)或多個(gè)其他事件,有些事件可能會(huì)多次觸發(fā)。 xhr.addEventListener("progress", updateProgress); xhr.addEventListener("load" , transferComplete); xhr.addEventListener("error", transferFailed ); xhr.addEventListener("abort", transferCanceled); xhr.open(); // 服務(wù)端到客戶端的傳輸進(jìn)程(下載) function updateProgress (event) { // 如果?`lengthComputable`?屬性的值是 false,那么意味著總字節(jié)數(shù)是未知并且 total 的值為零。 if (event.lengthComputable) { let progress = event.loaded / event.total * 100; console.log('加載進(jìn)度:' + progress + '%') // 一個(gè)百分比進(jìn)度 } else { // 總大小未知時(shí)不能計(jì)算進(jìn)度信息 } } function transferComplete(event) { console.log("傳輸完成"); } function transferFailed(event) { console.log("傳輸失敗"); } function transferCanceled(event) { console.log("該請(qǐng)求已經(jīng)被取消"); } // ...其他內(nèi)容
tips:注意,需要在請(qǐng)求調(diào)用 open() 之前添加事件監(jiān)聽,否則 progress 事件將不會(huì)被觸發(fā)。
②使用 XHR 監(jiān)控上傳進(jìn)度示例:
progress 事件同時(shí)存在于下載和上傳的傳輸。下載進(jìn)度監(jiān)控示例就如同上面的示例, 下面是上傳相關(guān)事件在 XMLHttpRequest.upload 對(duì)象上被觸發(fā)的示例:
let xhr = new XMLHttpRequest(); xhr.upload.addEventListener("progress", updateProgress); xhr.upload.addEventListener("load" , transferComplete); xhr.upload.addEventListener("error", transferFailed ); xhr.upload.addEventListener("abort", transferCanceled); xhr.open(); // 上傳進(jìn)度 function updateProgress (event) { // 如果?`lengthComputable`?屬性的值是 false,那么意味著總字節(jié)數(shù)是未知并且 total 的值為零。 if (event.lengthComputable) { let progress = event.loaded / event.total * 100; console.log('上傳進(jìn)度:' + progress + '%') // 一個(gè)百分比進(jìn)度 } else { // 總大小未知時(shí)不能計(jì)算進(jìn)度信息 } } function transferComplete(event) { console.log("上傳完成"); } function transferFailed(event) { console.log("上傳失敗"); } function transferCanceled(event) { console.log("取消上傳"); }
三、axios 監(jiān)控進(jìn)度
axios 提供了方便的 api 去獲取請(qǐng)求的進(jìn)度:
// `onUploadProgress` 允許為上傳處理進(jìn)度事件 onUploadProgress: function (progressEvent) { let num = progressEvent.loaded / progressEvent.total * 100 // 計(jì)算進(jìn)度 const loadingText = '進(jìn)度:' + num + '%' }, // `onDownloadProgress` 允許為下載處理進(jìn)度事件 onDownloadProgress: function (progressEvent) { // 對(duì)原生進(jìn)度事件的處理 let num = progressEvent.loaded / progressEvent.total * 100 // 計(jì)算進(jìn)度 const loadingText = '進(jìn)度:' + num + '%' },
下面是一個(gè) axios 結(jié)合 element-ui 的 el-upload 組件的使用示例
<el-upload ref="upload" id="upload-box" action="void" :http-request="customUpload" :before-upload="handleBefore" :on-preview="handlePreview" :on-remove="handleRemove" :before-remove="beforeRemove" :on-success="handleSuccess" :with-credentials="true" accept="*" list-type="text" :show-file-list="false" :file-list="fileList"> </el-upload>
customUpload (file) { let FormDatas = new FormData() FormDatas.append('file', file.file) // 封裝過的 axios axios({ method: 'post', url: this.$api.uploadFile, // 接口地址 data: FormDatas, // 請(qǐng)求配置按需配置即可 headers: { 'Accept': 'application/json', 'Content-Type': 'multipart/form-data;boundary=' + new Date().getTime() }, // 上傳進(jìn)度 onUploadProgress: (progressEvent) => { let num = progressEvent.loaded / progressEvent.total * 100 | 0 // 計(jì)算進(jìn)度 this.loadingText = '進(jìn)度:' + num + '%' file.onProgress({percent: num}) // 進(jìn)度條 } }).then((res) => { res.code === 0 && file.onSuccess(res) // 上傳成功(打鉤的小圖標(biāo)) }).finally(() => { this.loading = false }) }
四、寫在后面
- ①XHR 未設(shè)置默認(rèn)的超時(shí)限制,這意味著理論上一個(gè)請(qǐng)求的進(jìn)度可以無限長。但實(shí)踐中,應(yīng)該設(shè)置合理的超時(shí)限制, 并對(duì)相應(yīng)的錯(cuò)誤做處理。
- ②服務(wù)器必須在響應(yīng)中提供 Content-Length(內(nèi)容長度)首部,才能對(duì)傳輸數(shù)據(jù)估算從傳輸進(jìn)度。
- ③對(duì)于分塊數(shù)據(jù),因?yàn)轫憫?yīng)的總長度未知,所以無法進(jìn)行數(shù)據(jù)傳輸進(jìn)度的估算。
到此這篇關(guān)于JavaScript實(shí)現(xiàn)監(jiān)控上傳和下載進(jìn)度的文章就介紹到這了,更多相關(guān)JS監(jiān)控上傳載進(jìn)度內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
- JS實(shí)現(xiàn)批量上傳文件并顯示進(jìn)度功能
- JS插件plupload.js實(shí)現(xiàn)多圖上傳并顯示進(jìn)度條
- js實(shí)現(xiàn)帶進(jìn)度條提示的多視頻上傳功能
- JS實(shí)現(xiàn)上傳文件顯示進(jìn)度條
- JS+html5實(shí)現(xiàn)異步上傳圖片顯示上傳文件進(jìn)度條功能示例
- 基于JS實(shí)現(xiàn)視頻上傳顯示進(jìn)度條
- 原生javascript上傳圖片帶進(jìn)度條【實(shí)例分享】
- 教你3分鐘利用原生js實(shí)現(xiàn)有進(jìn)度監(jiān)聽的文件上傳預(yù)覽組件
- Node.js上傳文件功能之服務(wù)端如何獲取文件上傳進(jìn)度
- Nodejs文件上傳、監(jiān)聽上傳進(jìn)度的代碼
- JavaScript獲取上傳進(jìn)度的幾種方式實(shí)現(xiàn)
相關(guān)文章
javascript實(shí)現(xiàn)模擬時(shí)鐘的方法
這篇文章主要介紹了javascript實(shí)現(xiàn)模擬時(shí)鐘的方法,涉及javascript操作時(shí)間實(shí)時(shí)顯示的相關(guān)技巧,需要的朋友可以參考下2015-05-05JS中的public和private對(duì)象,即static修飾符
先看下面的例子,它將告訴我們?cè)贘S世界中也有C#里的public , private ,及static等2012-01-01JavaScript數(shù)據(jù)類型轉(zhuǎn)換的注意事項(xiàng)
JavaScript是一種無類型語言,但同時(shí)JavaScript提供了一種靈活的自動(dòng)類型轉(zhuǎn)換的處理方式?;疽?guī)則是,如果某個(gè)類型的值用于需要其他類型的值的環(huán)境中,JavaScript就自動(dòng)將這個(gè)值轉(zhuǎn)換成所需要的類型。2016-07-07深入理解JavaScript系列(11) 執(zhí)行上下文(Execution Contexts)
本章我們要講解的是ECMAScript標(biāo)準(zhǔn)里的執(zhí)行上下文和相關(guān)可執(zhí)行代碼的各種類型2012-01-01獲取當(dāng)前點(diǎn)擊按鈕的id用this.id實(shí)現(xiàn)
這篇文章主要介紹了獲取當(dāng)前點(diǎn)擊按鈕的id的方法,,需要的朋友可以參考下2014-03-03一個(gè)特殊的排序需求的javascript實(shí)現(xiàn)代碼
看了之后1是手癢癢,2是覺得樓主的實(shí)現(xiàn)有問題,就動(dòng)手寫了一下,用js,大概用了30-40分鐘。2009-09-09js實(shí)現(xiàn)文本框只允許輸入數(shù)字并限制數(shù)字大小的方法
這篇文章主要介紹了js實(shí)現(xiàn)文本框只允許輸入數(shù)字并限制數(shù)字大小的方法,涉及javascript對(duì)字符串正則判斷及數(shù)值大小判斷的相關(guān)技巧,具有一定參考借鑒價(jià)值,需要的朋友可以參考下2015-08-08