0. 系列文章

项目源码请猛戳这里!!!

1. 前言

有时候我们在页面中往往会让用户上传或下载某个东西，当用户点击了上传或下载按钮，页面随即开始进行相关操作，此时用户便处于等待状态，即等待上传完成或下载完成，一般来说，这里通常会加一个loading图，提示用户“文件正在上传/下载中。。。”，这样虽然一定程度上优化了一点用户体验，但是用户还处于漫无目的的等待，而我们更希望的是提供给用户一个上传或下载的实时进度，这样用户体验就大大提高了。

要实现上述的需求，这就要求我们发送了上传或下载请求后能够监控到实时的进度信息，在官方axios中的请求配置对象config就为我们提供了关于文件上传下载进度监控的属性，分别是：onDownloadProgress 和 onUploadProgress，我们可以通过这两个属性来实现对下载进度和上传进度的监控。

接下来，我们也要为我们实现的axios添加这两个属性并且能够实时监控上传和下载的进度信息。其实，实现起来并不难，因为浏览器已经帮我们做好了，对于下载进度监控，XMLHttpRequest对象提供了一个progress事件，我们只需监听该事件就能获得当前数据下载的进度；而对于上传进度的监控，XMLHttpRequest.ipload对象提供了一个progress事件，我们只需监听该事件就能获得当前数据上传的进度；

OK，这就是实现思路，有了思路以后我们着手实现吧。

2. 向请求配置对象添加属性

请求配置对象config中添加 onDownloadProgress 和 onUploadProgress这两个属性之前，我们需要先在src/types/index.ts中的配置对象的接口类型定义AxiosRequestConfig上添加该属性的定义，如下：

export interface AxiosRequestConfig {

  // 新增

  onDownloadProgress?: (e: ProgressEvent) => void;

  onUploadProgress?: (e: ProgressEvent) => void;

}

添加好以后，我们只需在发送请求之前判断用户是否配置了这两个属性，如果配置了就把该属性挂载到XMLHttpRequest对象上即可。

3. 把属性添加到XMLHttpRequest上

我们只需在发送请求之前判断用户是否配置了这两个属性，如果配置了就把该属性挂载到XMLHttpRequest对象上即可，如下：

const {

   // 新增

   onDownloadProgress,

   onUploadProgress

} = config;

if (onDownloadProgress) {

    request.onprogress = onDownloadProgress;

}

if (onUploadProgress) {

    request.upload.onprogress = onUploadProgress;

}

4. 潜在问题

这里有一个潜在的问题：由于我们之前给请求头headers设置了"Content-Type": "application/x-www-form-urlencoded"，但是当我们通过 FormData 上传文件的时候，这个Content-Type 字段就不能用了，就需要让浏览器自动根据请求数据设置 Content-Type，所以我们需要在添加请求头之前加一个判断，判断请求发送的数据data是不是 FormData 类型，是的话就要删除掉之前配置的Content-Type 字段，让浏览器自己去加。

首先，我们先在src/helpers/util.ts中来创建一个工具函数isisFormData，用来判断请求数据data是否为FormData类型，如下：

export function isFormData(val: any): boolean {

  return typeof val !== "undefined" && val instanceof FormData;

}

然后将判断逻辑加入到添加请求头之前，如下：

// src/core/xhr.ts

if (isFormData(data)) {

    delete headers["Content-Type"];

}

OK，这样我们就把文件上传下载监控属性就添加到我们的axios上了，接下里我们就编写demo来测试下效果。

5. demo编写

在 examples 目录下创建 progressMonitor目录，在 progressMonitor目录下创建 index.html:

<!DOCTYPE html>

<html lang="en">

  <head>

    <meta charset="UTF-8" />

    <title>progressMonitor demo</title>

  </head>

  <body>

    <h1>文件下载</h1>

    <div>

      <button id="download" class="btn btn-primary">Download</button>

    </div>

    <h1>文件上传</h1>

    <form role="form" class="form" onsubmit="return false;">

      <input id="file" type="file" class="form-control" />

      <button id="upload" type="button" class="btn btn-primary">Upload</button>

    </form>

    <script src="/__build__/progressMonitor.js"></script>

  </body>

</html>

接着再创建 app.ts 作为入口文件：

import axios from "../../src/axios";

const instance = axios.create({

  onDownloadProgress: function(ProgressEvent) {

    const load = ProgressEvent.loaded;

    const total = ProgressEvent.total;

    const progress = (load / total) * 100;

    console.log(progress);

  },

  onUploadProgress: function(ProgressEvent) {

    const load = ProgressEvent.loaded;

    const total = ProgressEvent.total;

    const progress = (load / total) * 100;

    console.log(progress);

  }

});

const downloadBtn = document.getElementById("download");

downloadBtn!.onclick = function() {

  instance.get("/api/downloadFile");

};

const uploadBtn = document.getElementById("upload");

uploadBtn!.onclick = function() {

  const data = new FormData();

  const file = document.getElementById("file") as HTMLInputElement;

  if (file.files) {

    data.append("file", file.files[0]);

    instance.post("/api/uploadFile", data);

  }

};

在本demo中，我们分别创建了文件下载和上传的两个场景，然后在axios请求配置对象中配置了 onDownloadProgress 和 onUploadProgress这两个属性，并且在属性内部打印了进度信息。

接着在 server/server.js 添加新的接口路由：

// 文件下载

router.get("/api/downloadFile", function(req, res) {

  res.sendFile(__dirname + "/1.mp4");

});

此处没有编写文件上传的路由接口，我们主要是想观察是否能够监控到上传进度，至于能否上传成功不是我们关心的。

最后在根目录下的index.html中加上启动该demo的入口：

<li><a href="examples/progressMonitor">progressMonitor</a></li>

OK,我们在命令行中执行：

# 同时开启客户端和服务端

npm run server | npm start

接着我们打开 chrome 浏览器，访问 http://localhost:8000/ 即可访问我们的 demo 了，我们点击 progressMonitor，就可以看到我们写好的上传下载场景了，分别点击上传和下载按钮，在控制台就可以看到打印出来的实时进度。

OK，以上就是文件上传下载进度监控的功能实现。

(完)

使用Typescript重构axios(二十五)——文件上传下载进度监控的更多相关文章

使用Typescript重构axios(二十)——请求取消功能：实现第一种使用方式
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十二)——请求取消功能：收尾
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十四)——防御XSRF攻击
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十六)——添加HTTP授权auth属性
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十八)——自定义序列化请求参数
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
使用Typescript重构axios(二十九)——添加baseURL
0. 系列文章 1.使用Typescript重构axios(一)--写在最前面 2.使用Typescript重构axios(二)--项目起手,跑通流程 3.使用Typescript重构axios(三) ...
salesforce 零基础学习（四十二）简单文件上传下载
项目中,常常需要用到文件的上传和下载,上传和下载功能实际上是对Document对象进行insert和查询操作.本篇演示简单的文件上传和下载,理论上文件上传后应该将ID作为操作表的字段存储,这里只演示文 ...
JavaWeb学习 (二十八)————文件上传和下载
在Web应用系统开发中,文件上传和下载功能是非常常用的功能,今天来讲一下JavaWeb中的文件上传和下载功能的实现. 对于文件上传,浏览器在上传的过程中是将文件以流的形式提交到服务器端的,如果直接使用 ...
JavaWeb 后端 <十四> 文件上传下载
1.文件上传与下载案例: 注册表单/保存商品等相关模块! --à 注册选择头像 / 商品图片 (数据库:存储图片路径 / 图片保存到服务器中指定的目录) 1.1 文件上传文件上传,要点: 前台: ...

随机推荐

Joomla 3.0.0 -3.4.6远程代码执行(RCE)漏洞复现
Joomla 3.0.0 -3.4.6远程代码执行(RCE)漏洞复现一.漏洞描述 Joomla是一套内容管理系统,是使用PHP语言加上MYSQL数据库所开发的软件系统,最新版本为3.9.12,官网: ...
mysql 分页offset过大性能问题解决思路
在公司干活一般使用sqlserver数据库.rownumber分页贼好用. 但是晚上下班搞自己的事情就不用sqlserver了.原因就是自己的渣渣1核2g的小服务器完全扛不住sqlserver那么大的 ...
03 python基础作业（一）
1.将['alex','eric',’rain’]用下划线拼接成字符串.(['alex','eric',123]呢?) li=['alex','eric','rain'] v='_'.join(li) ...
bootstrap-table 页脚总计(自定义统计总数)
•首先给table添加属性: showFooter: footer js代码如下: //初始化bootstrapTableinitBootstrapTable: function () { var o ...
一文掌握在Word中快速编写公式
在使用Word编写文章时,总会遇到书写数学公式的情况.使用Word的公式输入工具需要频繁地使用鼠标,因而编写公式会显得繁琐麻烦,那么有什么办法可以优雅地在Word中书写公式呢?其实Word早在Word ...
VMware workstation Windows 10虚拟机安装步骤
1. 在首页点击创建新的虚拟机 2. 选择典型,下一步 3.选择稍后安装操做系统,下一步. 4. 选择第一个Microsoft Windows,版本选择如图. 5. 选择安装位置,我放在D盘. 7. ...
Docker 学习入门
一.Docker 简介 1.什么是 Docker Docker 是使用最广泛的开源容器引擎,它彻底释放了计算虚拟化的威力,极大提高了应用的运行效率,降低了云计算资源供应的成本! 使用 Docker,可 ...
python中函数调用---可变对象以及不可变对象
# 定义函数 def demo(obj): print("原值: ",obj) obj += obj #调用函数 print("========值传递=======&qu ...
如何用js做关灯游戏
编辑器 Sublime Text 3 <!DOCTYPE html><html lang="en"><head> <meta chars ...
opencv::霍夫圆变换
霍夫圆检测原理从平面坐标到极坐标转换三个参数假设平面坐标的任意一个圆上的点,转换到极坐标中: 处有最大值,霍夫变换正是利用这个原理实现圆的检测. cv::HoughCircles 因为霍夫圆检测对 ...

使用Typescript重构axios(二十五)——文件上传下载进度监控