nodejs 读写文件之 Stream

前言

Stream 是一个抽象接口，Node 中有很多对象实现了这个接口。Node.js，Stream 有四种流类型：
- Readable - 可读操作。
- Writable - 可写操作。
- Duplex - 可读可写操作.
- Transform - 操作被写入数据，然后读出结果。
所有的 Stream 对象都是 EventEmitter 的实例。常用的事件有以下几个：
- data - 当有数据可读时触发。
- end - 没有更多的数据可读时触发。
- error - 在接收和写入过程中发生错误时触发。
- finish - 所有数据已被写入到底层系统时触发。

使用

1. 读取文件内容

// 引入模块
const fs = require('fs');
// 定义变量接收读取的数据
let data='';
// 创建流--方法中指定要读取的文件名称
let readerStream = fs.createReadStream('readme.txt');
// 设置编码格式
readerStream.setEncoding('utf-8');
// 开始处理流事件
// 读取流
readerStream.on('data',function(content){
    data += content;
});
// 读取完成
readerStream.on('end',function(){
    console.log(data);
});
// 异常处理
readerStream.on('error',function(err){
    console.log(err.stack);
})
// 结束处理流事件

console.log('执行完毕');

2. 写入（覆盖）

// 引入模块
const fs = require('fs');
// 定义要写入的内容
const data='这是用来写入到文件的内容，但是这些内容会覆盖掉原来的内容，请谨慎使用。';
// 创建一个写入流，方法内指定要写入内容的文件名
const writerStream = fs.createWriteStream('readme.txt');
// 写入数据，注意要指定编码格式
writerStream.write(data,'utf-8');
// 标记文件末尾
writerStream.end();
// 处理流事件
// 写入完成
writerStream.on('finish',function(){
    console.log('写入完成');
});
// 写入异常
writerStream.on('error',function(err){
    console.log(err.stack);
});
console.log('执行完成');

3. 写入（追加） — 这个不是stream的内容，但因为功能类似，故放在这里，方便记忆。

// 引入模块
const fs = require('fs');
// 要追加的文本
let addTxt='我是用来追加的文本';
// 追加文件内容：方法有三个参数：要追加的文件名，要追加的内容，异常处理
fs.appendFile('input.txt',addTxt,(err)=>{
    if (err){
        console.log('err\t',err);
        return;
    };
    console.log('OK');
})

3. 边读边写 —用于读取文件，并把读取的文件写到另一个文件中。

// 引入模块
const fs = require('fs');
// 创建读取流
let readerStream=fs.createReadStream('readme.txt');
// 创建写入流
let writerStream = fs.createWriteStream('input.txt');
// 用流管流将读取的内容写到写入流中
readerStream.pipe(writerStream);

console.log('执行完成');

4. 链式流 --链式是通过连接输出流到另外一个流并创建多个流操作链的机制。链式流一般用于管道操作。比如用管道和链式来压缩和解压文件

// 引入模块
const fs = require('fs');
// 引入模块，注意，有可能要在node中安装zlib模块
const zlib = require('zlib');
// 压缩文件。注意，要带上文件名后缀（readme.txt）压缩，不然解压缩下不知道是什么格式的文件
fs.createReadStream('readme.txt')
  .pipe(zlib.createGzip())
  .pipe(fs.createWriteStream('readme.txt.gz'));

console.log('压缩完成');

5. 链式流 --解压缩

// 引入模块
const fs = require('fs');
// 引入模块，注意，有可能要在node中安装zlib模块
const zlib = require('zlib');
// 创建一个读取流
fs.createReadStream('readme.txt.gz')
    .pipe(zlib.createGunzip())
    // 将解压缩的文件保存到input.txt
    .pipe(fs.createWriteStream('input.txt'));

console.log('压缩完成');

总结

1.读取数据 fs.createReadStream(‘文件’)
2.写入数据（覆盖） fs.createWriteStream(‘文件’)
3.写入数据（追加） fs.appendFile(‘文件’,‘追加的内容’,(err)=>{}）
4.边读边写（管道流） readerStream.pipe(writerStream)