介绍
在 Node.js 中,fs (file system) 模块提供了一种操作文件系统的方式。它是一个核心模块,不需要安装即可使用。fs 模块提供了许多同步和异步操作,包括读取和写入文件、获取文件信息、创建和删除目录等等。
本文将详细介绍 fs 模块的常用方法及其用法,并给出相关示例代码。
使用
引入模块
在使用 fs 模块之前,需要先引入它。可以使用以下方式:
const fs = require('fs');
读取文件
读取文件是 fs 模块中最常用的操作之一。fs 模块提供了三种读取文件的方法:异步、同步和流式。其中,异步读取是最常用的一种,因为它能够在文件读取完成后自动触发回调函数。
以下是异步读取文件的代码示例:
fs.readFile('file.txt', 'utf8', (err, data) => { if (err) throw err; console.log(data); });
在上面的代码中,我们使用 readFile()
方法读取文件。第一个参数指定要读取的文件名,第二个参数指定编码方式,第三个参数是一个回调函数,用于接收读取后的文件内容。如果读取文件时发生错误,err 参数将会被赋值为错误信息。
写入文件
写入文件与读取文件一样,也是 fs 模块中常用的操作之一。与读取文件不同的是,写入文件时需要同时指定文件名和内容。
以下是异步写入文件的代码示例:
fs.writeFile('file.txt', 'Hello, world!', err => { if (err) throw err; console.log('File saved!'); });
在上面的代码中,我们使用 writeFile()
方法写入文件。第一个参数指定要写入的文件名,第二个参数指定要写入的内容,第三个参数是一个回调函数,用于接收写入操作的结果。如果写入文件时发生错误,err 参数将会被赋值为错误信息。
获取文件信息
获取文件信息是 fs 模块另一个常用的操作。fs 模块提供了 stat()
和 lstat()
方法用于获取文件信息。
以下是使用 stat()
方法获取文件信息的代码示例:
fs.stat('file.txt', (err, stats) => { if (err) throw err; console.log(stats.isFile()); });
在上面的代码中,我们使用 stat()
方法获取文件信息。第一个参数指定要获取信息的文件名,第二个参数是一个回调函数,用于接收获取的文件信息。在回调函数中,我们调用 isFile()
方法判断获取的文件信息是否为一个文件。
创建目录
如果想要创建一个新的目录,可以使用 fs 模块中的 mkdir()
方法。
以下是创建目录的代码示例:
fs.mkdir('newdir', err => { if (err) throw err; console.log('Directory created!'); });
在上面的代码中,我们使用 mkdir()
方法创建一个名为 newdir
的目录。如果创建目录时发生错误,err 参数将会被赋值为错误信息。
删除文件或目录
删除文件或目录是 fs 模块中常用的操作之一。可以使用 unlink()
方法删除文件,使用 rmdir()
方法删除目录。
以下是删除文件或目录的代码示例:
-- -------------------- ---- ------- --------------------- --- -- - -- ----- ----- ---- ----------------- ----------- --- ------------------ --- -- - -- ----- ----- ---- ---------------------- ----------- ---
在上面的代码中,我们使用 unlink()
方法删除文件,使用 rmdir()
方法删除目录。如果删除文件或目录时发生错误,err 参数将会被赋值为错误信息。
总结
在 Node.js 中,fs 模块提供了许多操作文件系统的方法。本文介绍了 fs 模块的常用方法及其用法,并给出了相关示例代码。我们希望本文可以帮助初学者更好地掌握 fs 模块的使用方法。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64a28a2a48841e9894ef2f6a