JavaScript 实现监控上传和下载进度

作者:异步漫步时间:2026-10-26 01:53:05浏览:262

本文详细解析如何在Web应用中监控文件上传与下载进度。通过对比原生XMLHttpRequest与Axios库的事件机制,展示如何监听progress事件计算百分比,并结合Element UI组件实现完整的上传交互。同时涵盖超时设置、Content-Length限制及分块传输等关键注意事项,帮助开发者优化用户体验。

一、写在前面

网络环境的不稳定性及网速波动,可能导致请求耗时显著增加。若在此过程中缺乏进度反馈,用户无法感知当前状态,将造成极差的使用体验。特别是在文件上传与下载的业务场景中,展示请求进度和加载状态的需求尤为迫切。

下文将从原生XHR请求和Axios库两个维度,深入分析如何实现请求进度的监控以及文件上传下载进度的获取。

提示:上传下载进度的监控,不应仅局限于获取数据传输进度的比例,还需涵盖传输过程中可能出现的各种状态。

二、xhr 监控进度

XHR的出现是Web应用发展史上的里程碑,它让DHTML中的D(动态)更加真实。此外,Ajax和Axios在本质上也是对XHR的封装实现。在JavaScript中,无需依赖第三方插件即可实现异步请求,因为存在XHR(new XMLHttpRequest()),这在某些场景下非常有用。因此,即便项目中较少直接使用XHR,而是使用其封装形式如Axios或Ajax,了解XHR依然具有重要意义。

XHR在监控请求进度方面提供了便捷的API,以下是与XHR进度相关的事件列表:

事件类型说明触发次数
loadstart接收到响应数据时触发。1次
progress当请求接收到更多数据时,周期性地触发0或多次
error当 request 遭遇错误时触发。0或多次
abort当 request 被停止时触发,例如当程序调用 XMLHttpRequest.abort() 时。0或多次
loadXMLHttpRequest请求成功完成时触发。0或多次
loadend当请求结束时触发, 无论请求成功 ( load) 还是失败 (abort 或 error)。1次

上述事件可用于方便地监控请求进度和状态。其中,progress事件更为常用,通常结合进度回调中的event.loaded和event.total来获取进度的百分比。

①使用XHR监控下载进度示例:

  let xhr = new XMLHttpRequest();
  // 要监控请求进度,可以在 xhr 对象上注册进度相关的事件
  // 每个请求,开始都会触发 loadStart,结束都会触发 loadEnd 事件,它们之间,
  // 还可能会触发一个或多个其他事件,有些事件可能会多次触发。
  xhr.addEventListener("progress", updateProgress);
  xhr.addEventListener("load" , transferComplete);
  xhr.addEventListener("error", transferFailed  );
  xhr.addEventListener("abort", transferCanceled);
  xhr.open();
  // 服务端到客户端的传输进程(下载)
  function updateProgress (event) {
    // 如果 `lengthComputable` 属性的值是 false,那么意味着总字节数是未知并且 total 的值为零。
    if (event.lengthComputable) {
      let progress = event.loaded / event.total * 100;
      console.log('加载进度:' + progress + '%') // 一个百分比进度
    } else {
      // 总大小未知时不能计算进度信息
    }
  }
  function transferComplete(event) {
    console.log("传输完成");
  }
  function transferFailed(event) {
    console.log("传输失败");
  }
  function transferCanceled(event) {
    console.log("该请求已经被取消");
  }
  // ...其他内容

提示:注意,必须在调用open()之前添加事件监听,否则progress事件将不会被触发。

②使用XHR监控上传进度示例:

progress事件同时存在于下载和上传的传输过程中。下载进度的监控示例与上述类似,以下是上传相关事件在XMLHttpRequest.upload对象上触发的示例:

    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();
    // 上传进度
    function updateProgress (event) {
      // 如果 `lengthComputable` 属性的值是 false,那么意味着总字节数是未知并且 total 的值为零。
      if (event.lengthComputable) {
        let progress = event.loaded / event.total * 100;
        console.log('上传进度:' + progress + '%') // 一个百分比进度
      } else {
        // 总大小未知时不能计算进度信息
      }
    }
    function transferComplete(event) {
      console.log("上传完成");
    }
    function transferFailed(event) {
      console.log("上传失败");
    }

    function transferCanceled(event) {
      console.log("取消上传");
    }

三、axios 监控进度

Axios提供了便捷的API来获取请求进度:

// `onUploadProgress` 允许为上传处理进度事件
onUploadProgress: function (progressEvent) {
    let num = progressEvent.loaded / progressEvent.total * 100 // 计算进度
    const loadingText = '进度:' + num + '%'
},

// `onDownloadProgress` 允许为下载处理进度事件
onDownloadProgress: function (progressEvent) {
    // 对原生进度事件的处理
    let num = progressEvent.loaded / progressEvent.total * 100 // 计算进度
    const loadingText = '进度:' + num + '%'
},

下面是一个结合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,
          // 请求配置按需配置即可
          headers: {
            'Accept': 'application/json',
            'Content-Type': 'multipart/form-data;boundary=' + new Date().getTime()
          },
          // 上传进度
          onUploadProgress: (progressEvent) => {
            let num = progressEvent.loaded / progressEvent.total * 100 | 0 // 计算进度
            this.loadingText = '进度:' + num + '%'
            file.onProgress({percent: num}) // 进度条
          }
        }).then((res) => {
          res.code === 0 && file.onSuccess(res) // 上传成功(打钩的小图标)
        }).finally(() => {
          this.loading = false
        })
      }

四、写在后面

  • ①XHR未设置默认的超时限制,这意味着理论上请求进度可以无限长。但在实践中,应设置合理的超时限制,并对相应的错误进行处理。
  • ②服务器必须在响应中提供Content-Length(内容长度)首部,才能对传输数据进行进度估算。
  • ③对于分块数据,由于响应总长度未知,因此无法进行数据传输进度的估算。

到此这篇关于JavaScript实现监控上传和下载进度的文章就介绍到这了,更多相关JS监控上传载进度内容请搜索本站以前的文章或继续浏览下面的相关文章希望大家以后多多支持本站!

作者最新文章