Stream
在构建较复杂的系统时,通常将其拆解为功能独立的若干部分。这些部分的接口遵循一定的规范,通过某种方式相连,以共同完成较复杂的任务。譬如,shell通过管道|连接各部分,其输入输出的规范是文本流。
在Node.js中,内置的Stream模块也实现了类似功能,各部分通过.pipe()连接。
Stream提供了以下四种类型的流:
1var Stream = require('stream')23var Readable = Stream.Readable4var Writable = Stream.Writable5var Duplex = Stream.Duplex6var Transform = Stream.Transform
使用Stream可实现数据的流式处理,如:
1var fs = require('fs')2// `fs.createReadStream`创建一个`Readable`对象以读取`bigFile`的内容,并输出到标准输出3// 如果使用`fs.readFile`则可能由于文件过大而失败4fs.createReadStream(bigFile).pipe(process.stdout)
Readable
创建可读流。
实例:流式消耗迭代器中的数据。
1'use strict'2const Readable = require('stream').Readable34class ToReadable extends Readable {5 constructor(iterator) {6 super()7 this.iterator = iterator8 }910 // 子类需要实现该方法11 // 这是生产数据的逻辑12 _read() {13 const res = this.iterator.next()14 if (res.done) {15 // 数据源已枯竭,调用`push(null)`通知流16 return this.push(null)17 }18 setTimeout(() => {19 // 通过`push`方法将数据添加到流中20 this.push(res.value + '\n')21 }, 0)22 }23}2425module.exports = ToReadable
实际使用时,new ToReadable(iterator)会返回一个可读流,下游可以流式的消耗迭代器中的数据。
1const iterator = function (limit) {2 return {3 next: function () {4 if (limit--) {5 return { done: false, value: limit + Math.random() }6 }7 return { done: true }8 }9 }10}(1e10)1112const readable = new ToReadable(iterator)1314// 监听`data`事件,一次获取一个数据15readable.on('data', data => process.stdout.write(data))1617// 所有数据均已读完18readable.on('end', () => process.stdout.write('DONE'))
执行上述代码,将会有100亿个随机数源源不断地写进标准输出流。
创建可读流时,需要继承Readable,并实现_read方法。
- _read方法是从底层系统读取具体数据的逻辑,即生产数据的逻辑。
- 在_read方法中,通过调用push(data)将数据放入可读流中供下游消耗。
- 在_read方法中,可以同步调用push(data),也可以异步调用。
- 当全部数据都生产出来后,必须调用push(null)来结束可读流。
- 流一旦结束,便不能再调用push(data)添加数据。
可以通过监听data事件的方式消耗可读流。
- 在首次监听其data事件后,readable便会持续不断地调用_read(),通过触发data事件将数据输出。
- 第一次data事件会在下一个tick中触发,所以,可以安全地将数据输出前的逻辑放在事件监听后(同一个tick中)。
- 当数据全部被消耗时,会触发end事件。
上面的例子中,process.stdout代表标准输出流,实际是一个可写流。下小节中介绍可写流的用法。
Writable
创建可写流。
前面通过继承的方式去创建一类可读流,这种方法也适用于创建一类可写流,只是需要实现的是_write(data, enc, next)方法,而不是_read()方法。
有些简单的情况下不需要创建一类流,而只是一个流对象,可以用如下方式去做:
1const Writable = require('stream').Writable23const writable = Writable()4// 实现`_write`方法5// 这是将数据写入底层的逻辑6writable._write = function (data, enc, next) {7 // 将流中的数据写入底层8 process.stdout.write(data.toString().toUpperCase())9 // 写入完成时,调用`next()`方法通知流传入下一个数据10 process.nextTick(next)11}1213// 所有数据均已写入底层14writable.on('finish', () => process.stdout.write('DONE'))1516// 将一个数据写入流中17writable.write('a' + '\n')18writable.write('b' + '\n')19writable.write('c' + '\n')2021// 再无数据写入流时,需要调用`end`方法22writable.end()
- 上游通过调用writable.write(data)将数据写入可写流中。write()方法会调用_write()将data写入底层。
- 在_write中,当数据成功写入底层后,必须调用next(err)告诉流开始处理下一个数据。
- next的调用既可以是同步的,也可以是异步的。
- 上游必须调用writable.end(data)来结束可写流,data是可选的。此后,不能再调用write新增数据。
- 在end方法调用后,当所有底层的写操作均完成时,会触发finish事件。
Duplex
创建可读可写流。
Duplex实际上就是继承了Readable和Writable的一类流。 所以,一个Duplex对象既可当成可读流来使用(需要实现_read方法),也可当成可写流来使用(需要实现_write方法)。
1var Duplex = require('stream').Duplex23var duplex = Duplex()45// 可读端底层读取逻辑6duplex._read = function () {7 this._readNum = this._readNum || 08 if (this._readNum > 1) {9 this.push(null)10 } else {11 this.push('' + (this._readNum++))12 }13}1415// 可写端底层写逻辑16duplex._write = function (buf, enc, next) {17 // a, b18 process.stdout.write('_write ' + buf.toString() + '\n')19 next()20}2122// 0, 123duplex.on('data', data => console.log('ondata', data.toString()))2425duplex.write('a')26duplex.write('b')27duplex.write('x')282930duplex.end()
上面的代码中实现了_read方法,所以可以监听data事件来消耗Duplex产生的数据。 同时,又实现了_write方法,可作为下游去消耗数据。
因为它既可读又可写,所以称它有两端:可写端和可读端。 可写端的接口与Writable一致,作为下游来使用;可读端的接口与Readable一致,作为上游来使用。
Transform
在上面的例子中,可读流中的数据(0, 1)与可写流中的数据(’a’, ‘b’)是隔离开的,但在Transform中可写端写入的数据经变换后会自动添加到可读端。 Tranform继承自Duplex,并已经实现了_read和_write方法,同时要求用户实现一个_transform方法。
1'use strict'23const Transform = require('stream').Transform45class Rotate extends Transform {6 constructor(n) {7 super()8 // 将字母移动`n`个位置9 this.offset = (n || 13) % 2610 }1112 // 将可写端写入的数据变换后添加到可读端13 _transform(buf, enc, next) {14 var res = buf.toString().split('').map(c => {15 var code = c.charCodeAt(0)16 if (c >= 'a' && c <= 'z') {17 code += this.offset18 if (code > 'z'.charCodeAt(0)) {19 code -= 2620 }21 } else if (c >= 'A' && c <= 'Z') {22 code += this.offset23 if (code > 'Z'.charCodeAt(0)) {24 code -= 2625 }26 }27 return String.fromCharCode(code)28 }).join('')2930 // 调用push方法将变换后的数据添加到可读端31 this.push(res)32 // 调用next方法准备处理下一个33 next()34 }3536}3738var transform = new Rotate(3)39transform.on('data', data => process.stdout.write(data))40transform.write('hello, ')41transform.write('world!')42transform.end()
数据类型
前面几节的例子中,经常看到调用data.toString()。这个toString()的调用是必需的吗?
在shell中,用管道(|)连接上下游。上游输出的是文本流(标准输出流),下游输入的也是文本流(标准输入流)
对于可读流来说,push(data)时,data只能是String或Buffer类型,而消耗时data事件输出的数据都是Buffer类型。对于可写流来说,write(data)时,data只能是String或Buffer类型,_write(data)调用时传进来的data都是Buffer类型。
也就是说,流中的数据默认情况下都是Buffer类型。产生的数据一放入流中,便转成Buffer被消耗;写入的数据在传给底层写逻辑时,也被转成Buffer类型。
但每个构造函数都接收一个配置对象,有一个objectMode的选项,一旦设置为true,就能出现“种瓜得瓜,种豆得豆”的效果。
- Readable未设置objectMode时:
1const Readable = require('stream').Readable23const readable = Readable()45readable.push('a')6readable.push('b')7readable.push(null)89readable.on('data', data => console.log(data))
- Readable设置objectMode后:
1const Readable = require('stream').Readable23const readable = Readable({ objectMode: true })45readable.push('a')6readable.push('b')7readable.push({})8readable.push(null)910readable.on('data', data => console.log(data))
可见,设置objectMode后,push(data)的数据被原样地输出了。此时,可以生产任意类型的数据。