NodeJS使用Range请求实现下载功能的方法示例


Posted in NodeJs onOctober 12, 2018

前言

本篇使用 NodeJS 的 HTTP 服务创建客户端,使用 Range 请求实现下载功能,并通过本篇的 Demo 扩展在业务中实现断点续传等功能的思路。

服务端的实现

我们通过 http 模块创建服务器处理 Range 请求,在服务器代码中我们为了减少回调嵌套使用 async 函数,所以需要将异步的操作方法转换成 Promise,以往我们使用 util 的 promisify 来一个一个转换异步方法,比较麻烦,我们这次使用第三方模块 mz 并直接引入转换好的替代模块。

使用 mz 之前需要先安装:

npm install mz

服务端代码如下:

// 文件:server.js
const http = require("http");
const path = require("path");
const url = require("url");

// 引入 mz 模块转换成 Promise 的 fs 模块
const fs = require("mz/fs");

// 请求处理函数
async function listener(req, res) {
  // 获取 range 请求头,格式为 Range:bytes=0-5
  let range = req.headers["range"];

  // 下载文件路径
  let p = path.resovle(__dirname, url.parse(url, true).pathname);

  // 存在 range 请求头将返回范围请求的数据
  if (range) {
    // 获取范围请求的开始和结束位置
    let [, start, end] = range.match(/(\d*)-(\d*)/);

    // 错误处理
    try {
      let statObj = await fs.stat(p);
    } catch (e) {
      res.end("Not Found");
    }

    // 文件总字节数
    let total = statObj.size;

    // 处理请求头中范围参数不传的问题
    start = start ? ParseInt(start) : 0;
    end = end ? ParseInt(end) : total - 1;

    // 响应客户端
    res.statusCode = 206;
    res.setHeader("Accept-Ranges", "bytes");
    res.setHeader("Content-Range", `bytes ${start}-${end}/${total}`);
    fs.createReadStream(p, { start, end }).pipe(res);
  } else {
    // 没有 range 请求头时将整个文件内容返回给客户端
    fs.createReadStream(p).pipe(res);
  }
}

// 创建服务器
const server = http.createServer(listener);

// 监听端口
server.listen(3000, () => {
  console.log("server start 3000");
});

在上面服务端的代码中,需要兼容 Range 请求和普通请求,两种请求的区别是,如果客户端发送的是 Range 请求,会携带 Range:bytes=0-5 格式的请求头,我们可以通过 req 的 headers 属性获取,在获取请求头时,原本大写字母开头 NodeJS 统一处理成小写,所以获取时应小写。

如果是 Range 请求则通过可读流读取对应的内容返回客户端,如果不是,则通过可读流读取整个文件返回客户端,在响应 Range 请求的过程中需要设置响应状态为 206,需要设置响应头 Accept-Ranges 值为 bytes,需要设置响应头 Content-Range 值为 byte 0-5/100 的格式,0 为返回数据开始的索引,5 为结束的索引(包含),100 为文件的总字节数。

在通过 url 和 path 模块解析和拼接下载文件路径时,应该进行错误检测,如果文件不存在则直接返回客户端 Not Found。

我们可以使用 curl 命令来检测我们的服务端代码,在命令行工具中输入下面命令,在命令窗口查看返回值是否正确。

curl -v --header "Range:bytes=0-5" http://localhost:3000

客户端的实现

在上面使用 curl 命令来访问我们的服务器时,只能请求固定范围的数据,而不是类似于下载功能,每次都下载一个范围的数据,但是想要多次下载并自动维护 Range 的范围需要借助我们自己实现的客户端逻辑。

为了简便,我们的下载客户端是在命令行窗口运行的,通过指令来模拟实际项目中的开始下载、暂停和恢复按钮,当在窗口中输入 s 指令时开始下载,输入 p 指令时暂停下载,输入 r 指令时恢复下载。

// 文件:client.js
const http = require("http");
const fs = require("fs");
const path = require("path");

// 请求配置
let config = {
  host: "localhost",
  port: 3000,
  path: "/download.txt"
};

let start = 0; // 请求初始值
let step = 5; // 每次请求字符个数
let pause = false; // 暂停状态
let total; // 文件总长度

// 创建可写流
let ws = fs.createWriteStream(path.resolve(__dirname, config.path.slice(1)));

// 下载函数
function download() {
  // 配置,每次范围请求 step 个字节
  config.headers = {
    "Range": `bytes=${start}-${start + step - 1}`;
  };

  // 维护下次 start 的值
  start += step;

  // 发送请求
  http.request(config, res => {
    // 获取文件总长度
    if (typeof total !== "number") {
      total = res.headers["content-ranges"].match(/\/(\d*)/)[1];

    }

    // 读取返回数据
    let buffers = [];
    res.on("data", data => buffers.push(data));
    res.on("end", () => {
      // 合并数据并写入文件
      let buf = Buffer.concat(buffers);
      ws.write(buf);

      // 递归进行下一次请求
      if (!pause && start < total) {
        download();
      }
    });
  }).end();
}

// 监控输入
process.stdin.on("data", data => {
  // 获取指令
  let ins = data.toString().match(/(\w*)\/r/)[1];
  switch (ins) {
    case "s":
    case "r":
      pause = false;
      download();
      break;
    case "p":
      pause = true;
      break;
  }
});

在上面代码中下载的文件通过 config 中的 path 属性配置,每次调用 download 函数下载时都会重新计算当前范围请求的初始位置和结束位置,并设置 Range 请求头,下一次请求靠递归 download 来实现。

在执行时需先启动我们的服务器,在通过命令行输入 node client.js 来启动客户端,在命令窗口输入对应的指令进行开始下载、暂停下载和恢复下载操作。

总结

相信现在已经了解什么是范围请求,范围请求客户端和服务端需要做些什么,其实说白了就是对应的请求头和响应头的使用,需要注意的是范围请求的响应状态码为 206,这样的需求在一些上传、下载资源的网站也很常见,其目的就是为了让我们实现断点续传,不至于一次没有上传或下载完成的资源文件,在下一次的做同样操作时需要重新来过,可以接着上次的位置继续,范围请求在视频网站上也广泛应用,边请求边观看,不至于一次加载整个视频资源,节省流量,节省时间。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

NodeJs 相关文章推荐
用nodejs访问ActiveX对象,以操作Access数据库为例。
Dec 15 NodeJs
nodejs win7下安装方法
May 24 NodeJs
windows系统下简单nodejs安装及环境配置
Jan 08 NodeJs
Windows系统下使用Sublime搭建nodejs环境
Apr 13 NodeJs
用nodejs的实现原理和搭建服务器(动态)
Aug 10 NodeJs
nodejs处理图片的中间件node-images详解
May 08 NodeJs
nodejs制作爬虫实现批量下载图片
May 19 NodeJs
用nodejs实现json和jsonp服务的方法
Aug 25 NodeJs
nodejs判断文件、文件夹是否存在及删除的方法
Nov 10 NodeJs
NodeJS实现自定义流的方法
Aug 01 NodeJs
nodejs 使用http进行post或get请求的实例(携带cookie)
Jan 03 NodeJs
nodejs读取图片返回给浏览器显示
Jul 25 NodeJs
nodejs实现范围请求的实现代码
Oct 12 #NodeJs
NodeJS搭建HTTP服务器的实现步骤
Oct 12 #NodeJs
NodeJS服务器实现gzip压缩的示例代码
Oct 12 #NodeJs
nodejs aes 加解密实例
Oct 10 #NodeJs
nodejs读取本地中文json文件出现乱码解决方法
Oct 10 #NodeJs
nodejs require js文件入口,在package.json中指定默认入口main方法
Oct 10 #NodeJs
nodejs更新package.json中的dependencies依赖到最新版本的方法
Oct 10 #NodeJs
You might like
PHP生成静态页面详解
2006/11/19 PHP
PHP用身份证号获取星座和生肖的方法
2013/11/07 PHP
PHP页面跳转实现延时跳转的方法
2016/12/10 PHP
php查询及多条件查询
2017/02/26 PHP
利用laravel搭建一个迷你博客实战教程
2017/08/13 PHP
jQuery 使用手册(三)
2009/09/23 Javascript
jQuery 学习第五课 Ajax 使用说明
2010/05/17 Javascript
判断对象是否Window的实现代码
2012/01/10 Javascript
jQuery弹性滑动导航菜单实现思路及代码
2013/05/02 Javascript
js 为label标签和div标签赋值的方法
2013/08/08 Javascript
jQuery插件实现控制网页元素动态居中显示
2015/03/24 Javascript
JS与jQ读取xml文件的方法
2015/12/08 Javascript
JavaScript代码生成PDF文件的方法
2016/02/26 Javascript
限制只能输入数字的实现代码
2016/05/16 Javascript
JavaScript定义函数的三种实现方法
2017/09/23 Javascript
vue 设置proxyTable参数进行代理跨域
2018/04/09 Javascript
官方推荐react-navigation的具体使用详解
2018/05/08 Javascript
nuxt.js写项目时增加错误提示页面操作
2020/11/05 Javascript
python缩进区别分析
2014/02/15 Python
python实现获取客户机上指定文件并传输到服务器的方法
2015/03/16 Python
Python中的高级函数map/reduce使用实例
2015/04/13 Python
Python 中开发pattern的string模板(template) 实例详解
2017/04/01 Python
python保存数据到本地文件的方法
2018/06/23 Python
Python实现定时自动关闭的tkinter窗口方法
2019/02/16 Python
python字典改变value值方法总结
2019/06/21 Python
keras 多任务多loss实例
2020/06/22 Python
Python如何批量生成和调用变量
2020/11/21 Python
Python爬虫之Selenium实现关闭浏览器
2020/12/04 Python
如何给HTML标签中的文本设置修饰线
2019/11/18 HTML / CSS
html5视频自动横过来自适应页面且点击播放功能的实现
2020/06/03 HTML / CSS
大学生最常用的自我评价
2013/12/07 职场文书
高中运动会广播稿
2014/01/21 职场文书
爱情保证书大全
2014/04/29 职场文书
办公室主任四风问题对照检查材料思想汇报
2014/09/28 职场文书
教师自荐信范文
2015/03/06 职场文书
物资采购管理制度
2015/08/06 职场文书