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 文件上传文件上传,要点: 前台: ...

随机推荐

ES6——新增数据结构Set与Map的用法
ES6 提供了新的数据结构 Set以及Map,下面我们来一一讲解. 一.Set 特性似于数组,但它的一大特性就是所有元素都是唯一的,没有重复. 我们可以利用这一唯一特性进行数组的去重工作. 1.单一 ...
【DP合集】背包 bound
N 种物品,第 i 种物品有 s i 个,单个重量为 w i ,单个价值为 v i .现有一个限重为 W 的背包,求能容纳的物品的最大总价值. Input 输入第一行二个整数 N , W ( N ≤ ...
Spring Security 动态url权限控制（三）
一.前言本篇文章将讲述Spring Security 动态分配url权限,未登录权限控制,登录过后根据登录用户角色授予访问url权限基本环境 spring-boot 2.1.8 mybatis-p ...
Java之微信公众号开发
这次以文本回复作为案例来讲解Java相关得微信公众号开发. 首先必须要有一个个人微信公众号个人微信公众号相关的接口权限有限,不过用于个人学习体验一下足够了,如图: 然后进入微信公众后台,点击基本配置 ...
阿里云 RDS 数据库又发 CPU 近 100% 的“芯脏病”
最近云界发生了2件事,一件是大事,一件是小事,大事是阿里云与微软合作推出了开放应用模型 Open Application Model(OAM),小事是由于微软 SQL Server 在阿里云上水土不服 ...
drf框架中所有视图及用法
0909自我总结 drf框架中所有视图及用法一.drf框架中的所有视图类 from django.views import View from rest_framework import views ...
零基础：如何快速学习JavaScript，html+css技术
前端开发要学的知识内容涉及的会很宽泛,虽然说主要是HTML.CSS和JavaScript这些基础知识点,但达妹今天想强调一下,学前端开发除了要学这些基础知识外,学员还要在这之上进行延伸和深入的去学,而 ...
PHP7源码之array_unique函数分析
以下源码基于 PHP 7.3.8 array array_unique ( array $array [, int $sort_flags = SORT_STRING ] ) (PHP 4 >= ...
luogu P3380 【模板】二逼平衡树（分块实现）
题目描述您需要写一种数据结构(可参考题目标题),来维护一个有序数列,其中需要提供以下操作: 查询 $k$ 在区间内的排名查询区间内排名为 $k$ 的值修改某一位值上的数值查询 \(k\ ...
Cocos2d-x 学习笔记(11.3) JumpBy JumpTo
1. JumpBy JumpTo JumpBy,边跳边平移,不只做垂直向上的抛物动作,同时还在向终点平移.JumpTo是JumpBy的子类. 1.1 成员变量 create方法 JumpBy: Vec ...

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