文件 I/O 是由简单封装的标准 POSIX 函数提供的。 通过 require('fs') 使用该模块,所有的方法都有异步和同步的形式。
异步形式始终以完成回调作为它最后一个参数,传给完成回调的参数取决于具体方法,但第一个参数总是留给异常,如果操作成功完成,则第一个参数会是 null 或 undefined。
当使用同步形式时,任何异常都会被立即抛出。 可以使用 try/catch 来处理异常,或让它们往上冒泡。
异步方法不保证执行顺序。 所以下面的例子容易出错:
fs.stat 可能在 fs.rename 之前执行,正确的方法是把回调链起来。
推荐开发者使用这些函数的异步版本。 同步版本会阻塞整个进程,直到它们完成(停止所有连接)。
【fs.open(path, flags[, mode], callback)】参数如下:
flags可以是:
[注意]使用'rs+'模式不会使fs.open()进入同步阻塞调用。如果那是你想要的,则应该使用fs.openSync()。
文件的回调函数中的第二个参数fd代表文件标识,与定时器标识类似,用于标识文件,且随着文件的打开顺序递增。
【fs.openSync(path, flags[, mode])】
fs.open() 的同步版本。 返回一个表示文件描述符的整数。
【fs.read(fd, buffer, offset, length, position, callback)】参数如下:
由于使用read()方法,会将文件内容读取buffer对象中,所以需要提前先准备一个buffer对象。
【fs.readSync(fd, buffer, offset, length, position)】
fs.read() 的同步版本,返回 bytesRead 的数量
【fs.write(fd, buffer, offset, length[, position], callback)】参数如下:
[注意]多次对同一文件使用fs.write且不等待回调,是不安全的。对于这种情况,强烈推荐使用 fs.createWriteStream。
当我们要对打开的文件进行写操作的时候,打开文件的模式应该是读写模式。
【fs.write(fd, data[, position[, encoding]], callback)】
该方法写入data到fd指定的文件。如果data不是一个Buffer实例,则该值将被强制转换为一个字符串。
不同于写入 buffer,该方法整个字符串必须被写入。不能指定子字符串,这是因为结果数据的字节偏移量可能与字符串的偏移量不同。
【fs.writeSync()】
fs.write() 的同步版本,返回写入的字节数。
【fs.close(fd, callback)】参数如下:
一个文件被操作后,要及时将该文件关闭
【fs.closeSync(fd)】
fs.close(fd, callback)的同步版本,返回undefined
在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是有意义的。这样可以不必等到操作完了在进入下一次遍历,有利于提升效率。