概述
流是一种抽象的数据结构。从键盘输入到应用程序就是标准输入流(stdin)。应用程序把字符一个一个输出到显示器上叫做:标准输出流(stdout)。
流的特点是数据是有序的,而且必须依次读取,或者依次写入,不能像Array那样随机定位。以 Buffer 作为传输单位。
它不像传统的程序那样一次将一个文件读入内存,而是逐块读取数据、处理其内 容,而不是将其全部保存在内存中 。流可以分成三部分:source、 dest、 pipe。
在source和dest之间有一个连接的管道pipe,它的基本语法是source.pipe(dest),source和dest就是通过pipe连接,让数据从source流向了dest,如下图所示:
在 Node.js 中,流也是一个对象,我们只需要响应流的事件就可以了:data
事件表示流的数据已经可以读取了,end
事件表示这个流已经到末尾了,没有数据可以读取了,error
事件表示出错了。
const fs = require('fs');
// 打开一个流:
const rs = fs.createReadStream('./avatar/1.txt', 'utf-8');
// `data`事件可能会有多次,每次传递的`chunk`是流的一部分数据。
// rs.on('data', function (chunk) {
// console.log('DATA:')
// console.log(chunk); // 我是 1.txt 里面的内容
// });
// rs.on('end', function () {
// console.log('END');
// });
// rs.on('error', function (err) {
// console.log('ERROR: ' + err);
// });
// 写入(覆盖写入)文件
const ws1 = fs.createWriteStream('./avatar/1.txt', 'utf-8');
ws1.write('使用Stream写入文本数据...\n');
ws1.write('END.');
ws1.end();
一个Readable
流和一个Writable
流串起来后,所有的数据自动从Readable
流进入Writable
流,这种操作叫pipe
。pipe()
把一个文件流和另一个文件流串起来,这样源文件的所有数据就自动写入到目标文件里了。
const fs = require('fs');
// 以下操作将 1.txt 的内容写入 2.txt
const readstream = fs.createReadStream('./avatar/1.txt')
const writestream = fs.createWriteStream('./avatar/2.txt')
readstream.pipe(writestream)
分类
流的分成四个种类:
- 可写流:可写入数据的流。例如fs.createWriteStream()可以使用流将数据写入文件
- 可读流:可读取数据的流。例如fs.createReadStream()可以从文件读取内容
- 双工流:既可读又可写的流。例如net.Socket
- 转换流:可以在数据写入和读取时修改或转换数据的流。例如,在文件压缩操作中,可以向文件写入压缩数据,并从文件中读取解压数据
在NodeJS中HTTP服务器模块中,request是可读流,response是可写流。还有fs模块,能同时处理可读和可写文件流。
可读流和可写流都是单向的,比较容易理解,而另外两个是双向的。
这里说一下双工流:
const { Duplex } = require('stream');
const myDuplex = new Duplex({
read(size) {
// ...
},
write(chunk, encoding, callback) {
// ...
}
});
然后是转换流:
const { Transform } = require('stream');
const myTransform = new Transform({
transform(chunk, encoding, callback) {
// ...
}
});
转换流的例子除了 压缩解压,还有就是 babel,将 es6 写入,转为 es5 读出。
应用场景
主要应用场景就是 I / O 操作,http 请求和 文件操作 都属于 IO 操作。
常见的场景有:
- get 请求返回文件给客户端
- 文件操作
- 一些打包工具的底层操作
get 请求返回文件给客户端
const server = http.createServer(function (req, res) {
const method = req.method; //
if (method === 'GET') { // get
const fileName = path.resolve(__dirname, 'data.txt');
let stream = fs.createReadStream(fileName);
stream.pipe(res); // res stream dest
}
});
server.listen(8000);
文件操作
const fs = require('fs')
const path = require('path')
// 两个文件名
const fileName1 = path.resolve(__dirname, 'data.txt')
const fileName2 = path.resolve(__dirname, 'data-bak.txt')
// 读取文件的 stream 对象
const readStream = fs.createReadStream(fileName1)
// 写入文件的 stream 对象
const writeStream = fs.createWriteStream(fileName2)
// pipe
readStream.pipe(writeStream)
//
readStream.on('end', function () {
console.log(' ')
})
打包工具
比如 gulp。