快速带你入门Nodejs的文件操作和stream（流）

243 阅读 0 评论 161 点赞

我是靠谱客的博主冷酷老师，这篇文章主要介绍快速带你入门Nodejs的文件操作和stream（流），现在分享给大家，希望可以做个参考。

本篇文章给大家介绍一下Nodejs中的文件操作（创建和删除目录/文件、重命名、追加内容、读取内容），以及简单聊聊stream（流）。

NodeJS文件操作

NodeJS除了在网络方面大放异彩，它还可以对文件进行操作，按逻辑上来说只要我们合理运用这些api再加上一些数据处理，我们就可以完成本地很多的操作。【推荐学习：《nodejs 教程》】
在上一篇我们知道如果想引用一个模块则需要使用到require，而今天要介绍的主角是fs模块，也就是NodeJS内置的一个文件模块，这个模块有很多的API供我们使用。

创建目录和文件

我们可以使用fs.mkdir fs.writeFile来分别创建目录和文件。
mkdir()可以接收三个参数，第一个是路径，第二个是个可选项代表权限，这个我们一般不需要，第三个参数是一个回调函数，我们可以在这里面做一些处理。

复制代码/* learnNode.js */
let fs = require('fs');
fs.mkdir('js',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('未出错')
  }
})1
2
3
4
5
6
7
8
9
/* learnNode.js */
let fs = require('fs');
fs.mkdir('js',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('未出错')
  }
})
登录后复制

writeFile()可以接收四个参数，第一个是路径，第二个是文件内容，第三个可选项代表权限，第四个是回调函数。

复制代码/* learnNode.js */
let fs = require('fs');
fs.writeFile('./js/newJs.js','console.log("写入这个")',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('没出错')
  }
})1
2
3
4
5
6
7
8
9
/* learnNode.js */
let fs = require('fs');
fs.writeFile('./js/newJs.js','console.log("写入这个")',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('没出错')
  }
})
登录后复制

可以看到我们成功创建了目录并写入了一个文件。

检测文件

我们可以通过fs.stat来检测一个路径的文件是为目录还是文件，进而可以做一些操作。

复制代码/* learnNode.js */
let fs = require('fs');
fs.stat('./js/newJs.js', (error, stats) => {
  if(error) {
    console.log(error);
    return false;
  } else {
    console.log(`是否文件：${stats.isFile()}`); 
    console.log(`是否目录：${stats.isDirectory()}`); 
    return false;
  }
})1
2
3
4
5
6
7
8
9
10
11
12
/* learnNode.js */
let fs = require('fs');
fs.stat('./js/newJs.js', (error, stats) => {
  if(error) {
    console.log(error);
    return false;
  } else {
    console.log(`是否文件：${stats.isFile()}`); 
    console.log(`是否目录：${stats.isDirectory()}`); 
    return false;
  }
})
登录后复制

star()主要接收两个参数第一个是要检测的文件，第二个是一个回调函数，这个回调函数有两个参数，分别是err错误和stats对象，这个对象提供有关文件的信息，我们可以对这个对象信息来进行判断。

删除文件和删除目录

既然我们可以使用NodeJS创建文件那当然我们也可以删除文件，主要使用的是fs.unlink``fs.rmdir这两个API。

复制代码/* learnNode.js */
let fs = require('fs');
fs.unlink('./js/newJs.js', (err) => {
  if (err) throw err;
  console.log('文件已删除');
});
fs.rmdir('./js',(err)=>{
  if (err) throw err;
  console.log('目录已删除');
})1
2
3
4
5
6
7
8
9
10
/* learnNode.js */
let fs = require('fs');
fs.unlink('./js/newJs.js', (err) => {
  if (err) throw err;
  console.log('文件已删除');
});
fs.rmdir('./js',(err)=>{
  if (err) throw err;
  console.log('目录已删除');
})
登录后复制

这两个API都分别接收两个参数是路径和回调函数，执行node learnNode.js可以看到我们文件已经成功删除。

重命名

我们可以使用fs.rename来对文件重命名。

复制代码/* learnNode.js */
let fs = require('fs');
fs.rename('oldJs.js','newJs.js',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('未出错')
  }
})1
2
3
4
5
6
7
8
9
/* learnNode.js */
let fs = require('fs');
fs.rename('oldJs.js','newJs.js',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('未出错')
  }
})
登录后复制

rename()可以接收三个参数第一个是路径第二个是更改的名称，第三个是回调函数，值得注意的是，如果第一个参数和第二个参数对应的文件所在的位置不一样时，他不会重命名之前那个文件而是直接把文件剪切放到另一个地方。

复制代码/* learnNode.js */
let fs = require('fs');
fs.rename('newJs.js','./js/oldJs.js',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('剪切到js文件夹内了')
  }
})1
2
3
4
5
6
7
8
9
/* learnNode.js */
let fs = require('fs');
fs.rename('newJs.js','./js/oldJs.js',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('剪切到js文件夹内了')
  }
})
登录后复制

追加内容

上面我们说到创建文件的时候可以顺便写入东西，那么我们可不可以直接在文件追加文字呢？我们可以使用fs.appendFile。

复制代码/* learnNode.js */
let fs = require('fs');
fs.appendFile('newJs.txt','我是追加的内容',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('追加内容')
  }
})1
2
3
4
5
6
7
8
9
/* learnNode.js */
let fs = require('fs');
fs.appendFile('newJs.txt','我是追加的内容',(err)=>{
  if(err){
    console.log('出错')
  }else{
    console.log('追加内容')
  }
})
登录后复制

appendFile()可以接收三个参数，第一个是路径，第二个是内容，第三个是回调函数，执行node learnNode.js即可。

读取文件和读取目录

以上都是对文件进行增删改的操作，我们现在还需要掌握一下读取内容，我们可以使用fs.readFile和fs.readdir分别读取文件和读取目录。

复制代码/* learnNode.js */
let fs = require('fs');
fs.readFile('newJs.txt', (err, data) => {
  if(err) {
    console.log('出错');
  } else {
    console.log("读取文件成功！");
    console.log(data);
  }
})1
2
3
4
5
6
7
8
9
10
/* learnNode.js */
let fs = require('fs');
fs.readFile('newJs.txt', (err, data) => {
  if(err) {
    console.log('出错');
  } else {
    console.log("读取文件成功！");
    console.log(data);
  }
})
登录后复制

复制代码/* learnNode.js */
let fs = require('fs');
fs.readdir('./', (err, data) => {
  if(err) {
    console.log('出错');
  } else {
    console.log("读取目录成功！");
    console.log(data);
  }
})1
2
3
4
5
6
7
8
9
10
/* learnNode.js */
let fs = require('fs');
fs.readdir('./', (err, data) => {
  if(err) {
    console.log('出错');
  } else {
    console.log("读取目录成功！");
    console.log(data);
  }
})
登录后复制

可以看到我们两个API都是接收两个参数，第一个是路径，第二个是回调函数，这个回调函数也有两个参数里面包含了data信息，我们可以打印这个data信息来获取内容。

stream(流)

最后我们来简单聊聊stream,翻译过来就是流的意思，提到流你会想到什么，河流，水流，都是从一个源头到另一个源头，就像水龙头从开关到流到地面，stream也是这样一个过程。
Stream 有四种流类型：
- Readable - 可读操作。
- Writable - 可写操作。
- Duplex - 可读可写操作.
- Transform - 操作被写入数据，然后读出结果。
在stream的过程中，我们也有事件可以使用，比如检测到错误触发的error，有数据时触发的data。
- data - 当有数据可读时触发。
- end - 没有更多的数据可读时触发。
- error - 在接收和写入过程中发生错误时触发。
- finish - 所有数据已被写入到底层系统时触发。
接下来简单举个例子理解一下吧。

读取流

复制代码var fs = require("fs");
var data = '';
// 创建可读流
var readerStream = fs.createReadStream('newJs.txt');
// 设置编码为 utf8。
readerStream.setEncoding('UTF8');
// 处理流事件 遇到有数据时执行这个
readerStream.on('data', function(chunk) {
  data += chunk;
  console.log(chunk,'流遇到数据了')
});
// 处理流事件 流结束时执行这个
readerStream.on('end',function(){
  console.log(data,'流结束了');
});
 // 处理流事件 流报错时执行这个
readerStream.on('error', function(err){
  console.log(err.stack);
});
console.log("程序执行完毕");1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
var fs = require("fs");
var data = '';
// 创建可读流
var readerStream = fs.createReadStream('newJs.txt');
// 设置编码为 utf8。
readerStream.setEncoding('UTF8');
// 处理流事件 遇到有数据时执行这个
readerStream.on('data', function(chunk) {
  data += chunk;
  console.log(chunk,'流遇到数据了')
});
// 处理流事件 流结束时执行这个
readerStream.on('end',function(){
  console.log(data,'流结束了');
});
 // 处理流事件 流报错时执行这个
readerStream.on('error', function(err){
  console.log(err.stack);
});
console.log("程序执行完毕");
登录后复制

我们一开始可以创建一个可读流fs.createReadStream()，参数是你要读的文件路径。
当遇到了数据时会执行readerStream.on('data',callback()),如下图所示。
当流结束时会执行readerStream.on('end',callback()),如下图所示。

写入流

我们上面演示了如何通过流读取一个文件，接下来我们试试通过流写入文件。

复制代码var fs = require("fs");
var data = '我是小卢，我再写入流';
// 创建一个可以写入的流，写入到文件 newJs.txt 中
var writerStream = fs.createWriteStream('newJs.txt');
// 使用 utf8 编码写入数据
writerStream.write(data,'UTF8');
// 标记文件末尾
writerStream.end();
// 处理流事件 完成和报错时执行
writerStream.on('finish', function() {
    console.log("写入完毕");
});
writerStream.on('error', function(err){
   console.log(err.stack);
});
console.log("程序执行完毕");1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
var fs = require("fs");
var data = '我是小卢，我再写入流';
// 创建一个可以写入的流，写入到文件 newJs.txt 中
var writerStream = fs.createWriteStream('newJs.txt');
// 使用 utf8 编码写入数据
writerStream.write(data,'UTF8');
// 标记文件末尾
writerStream.end();
// 处理流事件 完成和报错时执行
writerStream.on('finish', function() {
    console.log("写入完毕");
});
writerStream.on('error', function(err){
   console.log(err.stack);
});
console.log("程序执行完毕");
登录后复制

我们首先创建一个流，然后将data数据写入newJs.txt文件中。
当流写入完毕时会执行readerStream.on('finish',callback()),如下图所示。

可以看到该newJs.txt文件中已经存在了我们写入的数据。

写在最后

总的来说NodeJS提供了fs文件操作模块，这个模块有很多的API,上面只是简单的展示了一下，还有很多有趣的API大家只需要用到的时候去官网查就好了，因为NodeJS能操作文件，小至文件查找，大至代码编译。换个角度讲，几乎也只需要一些数据处理逻辑，再加上一些文件操作，就能够编写出大多数前端工具。