当前位置: 首页 > 后端技术 > Node.js

node.js中fs模块常用API汇总

时间:2023-04-03 12:12:25 Node.js

node.js中fs模块和readline模块主要对应系统的文件操作。node中的文件操作和网络操作都是阻塞操作,所以有大量的异步回调函数,其回调函数遵循上一篇介绍的node.js中回调函数的规则。而且为了避免出错,我们在进行文件操作时,总是使用文件的绝对物理路径来传递文件路径参数。这里常用的是path.join()和__dirname。详细用法请参考node.js中全局成员和__dirname路径模块的使用。在文件操作API中,每一个异步操作API都有对应的同步方法。这里只介绍异步API。一般来说,同步方法只比异步方法少一个回调函数的参数。fs模块中常用的API1,fs.stat(path,callback)这个方法用于检测文件的状态,可以用来判断一个文件是否存在。path参数传入文件的绝对物理路径,callback回调函数有两个参数err和stats。其中err为错误信息参数,stats为文件状态对象。如果输入文件路径中的文件不存在,则会出现如下错误信息。2.fs.writeFile(path,data[,options],callback)该方法可以用来向指定文件写入内容,该内容会覆盖文件中原有的内容。如果输入文件路径下的文件不存在,则先加载该文件,然后写入指定内容。path参数是文件的绝对物理路径,data是需要写入文件的数据内容。options参数可选,传入编码格式即可,不传则默认为utf8。callback回调参数中只有一个错误信息参数err,一般在写入失败时触发。3.fs.appendFile(path,data[,options],callback)该方法可用于向指定文件添加和写入内容。内容不会覆盖文件中的原有内容,只会在原有内容的基础上执行。附加。如果输入文件路径下的文件不存在,则先加载该文件,然后写入指定内容。path参数是文件的绝对物理路径,data是需要写入文件的数据内容。options参数可选,传入编码格式即可,不传则默认为utf8。callback回调参数中只有一个错误信息参数err,一般在追加写入失败时触发。4.fs.unlink(path,callback)这个方法可以用来删除指定的文件。path参数为文件的绝对物理路径,callback回调参数中只有一个错误信息参数err,一般在文件不存在或删除文件失败时触发。5.fs.readFile(path[,options],callback)该方法用于读取指定文件的内容,path参数为文件的绝对物理路径,options参数可选,编码格式可以传入,比如读取一个文本文件时,可以传入'utf8',如果不指定编码格式,读取的文件内容默认以Buffer格式输出,所以一般传这个参数在.callback回调参数中有两个参数err和data,其中err为错误信息参数,一般在文件不存在或读取文件失败时调用,data为文件内容。6.fs.rename(oldPath,newPath,callback)该方法可用于移动或重命名指定文件。oldPath参数为文件原路径,newPath参数为文件移动或重命名后的路径。两个参数都必须能够传入文件的完整绝对物理路径。callback回调参数中只有一个错误信息参数,一般在oldPath指定的文件不存在或操作失败时调用。注意:文件新建路径下的文件夹必须存在,如果不存在,会出现如下错误信息。7.fs.mkdir(path[,model],callback)该方法可以用来创建目录文件夹,其中path为目录的绝对物理路径,callback回调函数中只有一个错误信息参数,通常在失败时调用的目录中创建。注意:该方法无法完成多级目录的创建,node中需要创建的文件夹必须全部存在。否则,将出现一条错误消息。8.fs.rmdir(path,callback)这个方法可以用来删除一个空目录。其中path为目录的绝对物理路径,回调函数只有一个错误信息参数,一般在目录不存在或删除操作失败时触发。注意:传入目录路径中的目录必须为空目录,否则会出现如下错误信息,无法完成删除操作。9.fs.readdir(path,callback)该方法可以用来读取指定目录下的信息。其中path为目录的绝对物理路径。回调函数中有两个参数err和files。err是错误消息参数。一般在目录不存在或读取失败时触发调用。files是一个数组对象,包含目录中所有文件夹和文件的名称。(只有文件夹名和文件名,没有路径形式)。