开启掘金成长之旅！这是我参与「掘金日新计划 · 2 月更文挑战」的第 6 天，点击查看活动详情

stream 也就是流，可以理解为一连串的字节像水流那样的存在。按照官方文档的解释：

A stream is an abstract interface for working with streaming data in Node.js.

流是用于在 Node.js 中处理流数据，也就是连续字节的抽象接口。 流有 4 种基本类型，本篇文章主要介绍其中两种 —— 可读流和可写流。

可读的（Readable）

我们可以通过 fs.createReadStream() 创建一个可读流 readableStream，第 1 个参数可以是要读取的文件路径，比如现有文件 test.txt 内容为：

hello juejin

第 2 个参数（可选）可以传入一个选项对象，用来控制读取数据的起止位置等：

const fs = require('fs')

const readableStream = fs.createReadStream('./test.txt', {
  start: 6,
  end: 11
})

注意，读取的数据是包括了 start 和 end 的。 在之前介绍 events 模块时说过，所有的流都是 EventEmitter 的实例。所以获取数据是通过监听 'data' 事件：

readableStream.on('data', data => {
  console.log(data)
  console.log(data.toString())
})

打印结果如下，默认是 Buffer 对象，可以通过 toString() 方法转为字符串：

注意，读取数据时一次最多读取 64 * 1024 字节，如果想改变该数值，可以通过 highWaterMark 选项更改。另外还可以使用 pause() 进行暂停操作，使用 resume() 继续读取：

const readableStream = fs.createReadStream('./test.txt', {
  start: 6,
  end: 11,
  highWaterMark: 2 // 默认为 64 * 1024
})

readableStream.on('data', data => {
  console.log(data)
  console.log(data.toString())
  readableStream.pause() // 暂停读取
  setTimeout(() => {
    readableStream.resume() // 恢复读取
  }, 2000)
})

执行结果如下：

除了 'data' 事件，可读流还有其它一些事件，比如监听文件被打开的 'open'（回调会被传入 fd 参数），监听文件读取到 end（默认为读取到最后）的 'end'，监听文件关闭的 'close'（文件读取完会自动关闭）：

readableStream.on('data', data => console.log(data))
readableStream.on('open', fd => console.log(`${fd}文件打开了`))
readableStream.on('end', () => console.log('文件读取到 end 位置了'))
readableStream.on('close', () => console.log('文件已关闭'))

打印结果如下：

可写的（Writable）

使用 fs.createWriteStream() 可以创建可写流，第 1 个参数传入要写入的文件，第 2 个同样是用于配置的可选参数，这里我们将 flags 由表示覆盖写入的 'w' 改为 'a'，即追加写入（如果还指定了写入的起始位置 start，则为了兼容 windows 系统， flags 应该写成 'r+'）：

const writableStream = fs.createWriteStream('test.txt', {
  flags: 'a'
})

writableStream.write('养成', err => console.log(`错误信息：${err}`)) // 错误信息：undefined
writableStream.write('写作的')
writableStream.end('好习惯')

写入数据是通过 write 方法，上方代码执行的结果就是在原本的 "hello juejin" 后添加上了 "养成写作的好习惯"。最后一次写入可以使用 end 方法，这样就能监听到可写流的 'close' 事件了：

writableStream.on('close', () => {
  console.log('关闭')
})

否则，可写流需要手动 writableStream.close() 关闭才能监听到 'close' 事件。如果写入成功，则作为 write()/end() 的第 2 个参数传入的回调的 err 就为 undefined。

可读流还有另外一些事件，比如文件打开时的 'open' 事件，当 close() 或 end() 被调用后文件写入完成的 'finish' 事件。

可读流与可写流的连接

可读流与可写流可以通过 pipe 方法进行连接，实现对文件的复制：

const readableStream = fs.createReadStream('./test.txt')
const writableStream = fs.createWriteStream('./copy.txt')

readableStream.pipe(writableStream)

如此，便能将 ./test.txt 内的文本复制到 ./copy.txt 中。

开启掘金成长之旅！这是我参与「掘金日新计划 · 2 月更文挑战」的第 6 天，点击查看活动详情