对fs异步读取文件的理解

Posted 2023-05-03

参考技术A 在nodejs的API文档中可以看到大部分的文件或者文件夹的读取操作都有异步和同步两种操作。

有这样一个需求，读取某个文件夹下面的所有文件，因为有文件夹的嵌套，所以需要使用递归来实现这一功能。

首先使用同步的方法，很简单的可以实现：

同步的逻辑很简单，每一个步骤都等上一步执行完再执行，没多大问题。

那么使用异步如何实现呢？

首先我想到的是，使用async/await去控制异步读取fs.readdir()的执行。

duang～报错～

这里报错的原因是：nodejs的fs模块的方法都没有返回promise。当然不能使用async/await进行处理。

在nodejs的fs模块的源码中，如下：

fs模块的readdir()和readdirSync()方法的核心区别是：readdirSync()方法直接返回的是通过binding.readdir()方法读取的结果。而readdir()方法则未返回任何值，只是将callback作为FSReqCallback对象onComplete方法，表示再读取成功之后再执行callback方法，从何获取到返回的读取内容。

可以看到fs.readdir()方法并没有返回promise，直接用await去修饰fs.readdir()方法，并不会同步化该方法中通过I/O去异步读取文件信息的操作，这样的做法毫无意义。

所以，如何正确的使用异步读取的方法？

通过将fs.readdir()方法的返回promise化，这样就可以使用async/await了。

使用async/await事实上将后续的操作阻塞了，需要等到readDir执行完之后再进行其他操作，那么这里的和同步没有实质上的区别，反而还多了很多操作，所以单单就readDir这里来说，将其promise化再使用async/await是无意义的。

但是这里在读取到files进行map的时候，里面的fs.stat()异步化，使用async/await是有意义的。这样可以不必等到操作完了在进入下一次遍历，有利于提升效率。

node同步读取readFileSync和异步读取readFile的区别

先结论：异步读取文件的时候由操作系统在后台进行读取，不会阻碍下面的代码执行。同步读取的时候会阻碍下面的代码执行。

再案例：

test.js

var fs = require(‘fs‘);                //引入fs模块
console.log(‘start async read‘);        //异步读取开始
fs.readFile(‘test2.js‘,function(error,date){    //读取文件，回调函数第一个参数表示错误信息，第二个参数为读取的文本内容
    if(error){
        console.log(error);
    }else{
        console.log(‘end async read‘);    //异步读取结束
    }
});


console.log(‘start sync read‘); //同步读取开始
var date = fs.readFileSync(‘log.txt‘,‘utf-8‘); //date为文本内容
console.log(‘end sync read‘);    //同步读取结束

结果：

看出是按这个顺序执行的：异步读取开始---------->同步读取开始---------->同步读取结束---------->异步读取结束

异步读取没有结束，同步读取就完成了。

结论：异步读取没有阻塞下面代码的执行。

调换一下代码就更明显了

var fs = require(‘fs‘);                //引入fs模块

console.log(‘start sync read‘); //同步读取开始
var date = fs.readFileSync(‘log.txt‘,‘utf-8‘); //date为读取的文本内容
console.log(‘end sync read‘);    //同步读取结束


console.log(‘start async read‘);        //异步读取开始
fs.readFile(‘test2.js‘,function(error,date){    //读取文件，回调函数第一个参数表示错误信息，第二个参数为读取的文本内容
    if(error){
        console.log(error);
    }else{
        console.log(‘end async read‘);    //异步读取结束
    }
});

结果：

看出是按这个顺序执行的：同步读取开始---------->同步读取结束---------->异步读取开始---------->异步读取结束

结论：同步读取阻塞下面代码执行。