stream 是提供流数据操作的抽象接口,Stream模块提供了许多实现steam 接口的API。
在nodejs中 许多对象实现了stream interface,比如HTTP中的request,和stdout等。
流可以是可读的,可写的,或者两者兼有。所有流都是EventEmitter的实例。
Stream.png
- 流类型
-
Writable
:可写(eg:fs.createWriteStream()
) -
Readable
:可读(eg:fs.createReadStream
) -
Duplex
:可读可写(eg:net.Socket
) -
Transform
:可读可写可操作(zlib.createDeflate()
)
-
- 流模式
根据操作数据分为一般模式和对象模式- 一般模式:操作string或Buffer对象
*对象模式:其他js类型
Nodejs API 创建的流只能操作string或者Buffer对象 。当然其他js类型也可以实现流接口(null除外,因为 null在流中有特殊用途),这样的流被认为是在“对象模式”下操作的。可读流
- 一般模式:操作string或Buffer对象
示例
1. 可读流
const fs = require('fs');
let data = '';
//创建可读流,并设置编码
let reader = fs.createReadStream('input.txt', { encoding: 'utf-8' });
//处理流事件
reader.on('data', (chunk) => {
data += chunk;
})
reader.on('error', (err) => {
console.log(err.stack)
})
reader.on('end', () => {
console.log(data)
})
2. 写入流
const fs = require('fs');
let data = '2342323323';
let writer = fs.createWriteStream('output.txt');
writer.write(data, 'utf-8');
// 标记文件末尾,调用end之后再调用write会报错,不调用end不会触发finish事件
writer.end();
// 处理流事件 --> finish、error
writer.on('finish', function () {
console.log("写完啦~");
});
writer.on('error', function (err) {
console.log(err.stack);
});
console.log("程序执行完毕");
//程序执行打印:
//程序执行完毕
//写完啦~
3. 管道流
管道联通可读流和可写流,并将可读流的数据传递到可写流
const fs = require('fs');
let reader = fs.createReadStream('input.txt', { encoding: 'utf-8' });
let writer = fs.createWriteStream('output.txt');
//管道操作,读取input文件并将内容覆盖写入到output
reader.pipe(writer);
4. 链式流
可以在单个可读流上绑定多个可写流。
const zlib = require('zlib');
const fs = require('fs');
const r = fs.createReadStream('input.txt');
const z = zlib.createGzip();
const w = fs.createWriteStream('output.txt.gz');
r.pipe(z).pipe(w);
注意:
- 可读流的 API 贯穿了多个 Node.js 版本,且提供了多种方法来消费流数据。 开发者通常应该选择其中一种方法来消费数据,不要在单个流使用多种方法来消费数据。 混合使用 on('data')、on('readable')、pipe() 或异步迭代器,会导致不明确的行为。
- 默认情况下,当来源可读流触发
'end'
事件时,目标可写流也会调用stream.end()
结束写入。 若要禁用这种默认行为,end
选项应设为false
,这样目标流就会保持打开:
reader.pipe(writer, { end: false });
reader.on('end', () => {
writer.end('结束');
});