Node.js 文件系统模块 | 8月更文挑战

文件系统模块（简称 fs）容许咱们访问计算机上的文件系统并与之交互。

使用 fs 模块，咱们能够执行如下操做：

• 建立文件和目录
• 修改文件和目录
• 删除文件和目录
• 读取文件和目录的内容
• ...

建议：文件系统模块比较复杂，建议查看官方文档，你能够看到全部的方法。

本文将向您介绍最多见和最有用的 fs 方法。事不宜迟，让咱们看看这些方法是什么。

如何使用 fs

文件系统模块是一个核心的 Node.js 模块。这意味着咱们没必要安装它。咱们惟一须要作的就是将 fs 模块导入到本身的文件中。

所以，在文件顶部添加：

const fs = require('fs')
复制代码

如今，咱们可使用前缀 fs 从文件系统模块调用任何方法。

或者，咱们能够只从 fs API 导入所需的方法，以下所示：

const { writeFile, readFile } = require('fs')
复制代码

注意：为了方便起见，咱们还须要导入 path 模块。它是另外一个核心 Node.js 模块，它容许咱们使用文件和目录路径。

导入 fs 模块后，在文件中添加：

const path = require('path')
复制代码

使用文件系统模块时，path 模块不是必需的。但它对咱们有很大的帮助！

同步与异步

须要注意的是，默认状况下，全部 fs 方法都是异步的。可是，咱们能够经过在方法末尾添加 Sync 来使用同步版本。

例如，writeFile 方法的同步版本为 writeFileSync。同步方法将同步的完成代码，所以它们阻塞了主线程。阻塞 Node.js 中的主线程被认为是很差的作法，咱们不该该这么作。

所以，如下咱们都将使用文件系统模块中的异步方法。

写入文件

要从 Node.js 应用程序写入文件，请使用 writeFile 方法。

writeFile 方法至少接受如下参数：

• 文件名
• 内容
• 回调

若是指定的文件已经存在，它会将旧内容替换为您做为参数提供的内容。若是指定的文件不存在，则建立一个新文件。

导入 fs 和 path 模块后，在文件中编写如下代码：

fs.writeFile('content.txt', 'All work and no play makes Jack a dull boy!', err => {
  if (err) throw err
​
  process.stdout.write('建立成功!')
})
复制代码

上面的代码将建立了一个名为 content.txt 的新文件，并添加了文本 All work and no play makes Jack a dull boy! 做为内容。若是存在任何错误，回调函数将抛出该错误。不然，它将向控制台输出文件建立成功。

writeFile 还有其余变体，例如：

• fs.writeFileSync — 同步写入文件
• fsPromises.writeFile — 使用基于 Promise 的 API 写入文件

点击此处查看此要点

从文件中读取

在读取文件以前，须要建立并存储文件的路径。path 模块的路径在这里很方便。

使用 join 模块中的 path 方法，您能够建立文件路径，以下所示：

const filePath = path.join(process.cwd(), 'content.txt')
复制代码

第一个参数 process.cwd() 返回当前工做目录。如今您已经有了文件路径，能够读取文件的内容了。

在文件中编写如下代码：

fs.readFile(filePath, (error, content) => {
  if (error) throw error
​
  process.stdout.write(content)
})
复制代码

readFile 方法至少接受两个参数：

• 文件的路径
• 回调

若是有错误，它会抛出一个错误。不然，它会在终端中输出文件内容。

readFile 还有其余变体，例如：

• fs.readFileSync — 同步写入文件
• fsPromises.readFile — 使用基于 Promise 的 API 写入文件

点击此处查看此要点

读取目录的内容

在目录中显示文件与读取文件内容很是类似。可是，不是传递文件路径，而是传递当前工做目录（咱们能够传递任何其余目录）。

而后，传递一个回调函数来处理响应。在文件中编写如下代码：

fs.readdir(process.cwd(), (error, files) => {
  if (error) throw error
​
  console.log(files)
})
复制代码

到目前为止，咱们只使用 process.stdout.write 将内容输出到终端。可是，您能够简单地使用 console.log，就像上面的代码片断同样。

若是运行该应用程序，咱们应该会获得一个包含目录中全部文件的数组。

点击此处查看此要点

删除文件

文件系统模块有一种方法，容许您删除文件。可是，须要注意的是，它只适用于文件，不适用于目录。

当以文件路径做为参数调用 unlink 方法时，它将删除该文件。将如下代码段添加到文件中：

fs.unlink(filePath, error => {
  if (error) throw error
​
  console.log('文件已删除!')
})
复制代码

若是您从新运行代码，您的文件将被删除！

点击此处查看此要点

建立目录

咱们可使用 mkdir 方法异步建立目录。在文件中编写如下代码：

fs.mkdir(`${process.cwd()}/myFolder/secondFolder`, { recursive: true }, (err) => {
  if (err) throw err
​
  console.log('已成功建立文件夹!')
})
复制代码

首先，要在当前工做目录中建立一个新文件夹。如前所述，您可使用 cwd() 方法从 process 对象获取当前工做目录。

而后，传递要建立的一个或多个文件夹。可是，这并不意味着您必须在当前工做目录中建立新文件夹。你能够在任何地方建立它们。

如今，第二个参数是递归选项。若是未将其设置为 true，则没法建立多个文件夹。若是将 recursive 选项设置为 false，上述代码将给出一个错误。试试看！

可是，若是您只想建立一个文件夹，则无需将 recursive 选项设置为 true。

如下代码能够正常工做！

fs.mkdir(`${process.cwd()}/myFolder`, err => {
  if (err) throw err
​
  console.log('已成功建立文件夹!')
});
复制代码

所以，我想强调使用 recursive。若是要在文件夹中建立文件夹，则须要将其设置为 true。它将建立全部文件夹，即便它们不存在。

另外一方面，若是您只想建立一个文件夹，能够将其保留为 false。

点击此处查看此要点

删除目录

删除目录的逻辑相似于建立目录。若是您查看为建立目录而编写的代码和下面的代码，您会发现类似之处。

所以，在文件中编写如下代码：

fs.rmdir(`${process.cwd()}/myFolder/`, { recursive: true }, err => {
  if (err) throw err
​
  console.log('已成功删除文件夹!')
})
复制代码

使用文件系统模块中的 rmdir 方法，并传递如下参数：

• 要删除的目录
• 递归属性
• 回调

若是将 recursive 属性设置为 true，它将删除文件夹及其内容。请务必注意，若是文件夹中包含内容，则须要将其设置为 true。不然，您将获得一个错误。

如下代码段仅在文件夹为空时有效：

fs.rmdir(`${process.cwd()}/myFolder/`, err => {
  if (err) throw err

  console.log('已成功删除文件夹!')
})
复制代码

若是 myFolder 中有其余文件和/或文件夹，若是未传递 { recursive: true }，则会出现错误。

知道什么时候使用 recursive 选项以及什么时候不避免问题是很重要的。

点击此处查看此要点

目录/文件重命名

使用 fs 模块，您能够重命名目录和文件。下面的代码片断显示了如何使用 rename 方法进行此操做。

// 重命名一个目录
fs.rename(`${process.cwd()}/myFolder/secondFolder`, `${process.cwd()}/myFolder/newFolder`, err => {
  if (err) throw err

  console.log('目录重命名!')
});

// 重命名一个文件
fs.rename(`${process.cwd()}/content.txt`, `${process.cwd()}/newFile.txt`, err => {
  if (err) throw err

  console.log('文件重命名!')
});
复制代码

rename 方法包含三个参数：

• 第一个参数是现有的文件夹/文件
• 第二个参数是新名称
• 回调

所以，要重命名文件或目录，咱们须要传递当前文件/目录的名称和新名称。运行应用程序后，应更新目录/文件的名称。

须要注意的是，若是新路径已经存在（例如，文件/文件夹的新名称），它将被覆盖。所以，请确保不要错误地覆盖现有文件/文件夹。

点击此处查看此要点

向文件中添加内容

咱们还可使用 appendFile 方法向现有文件添加新内容。

若是比较 writeFile 和 appendFile 这两种方法，咱们能够发现它们是类似的。传递文件路径、内容和回调。

fs.appendFile(filePath, '\nAll work and no play makes Jack a dull boy!', err => {
  if (err) throw err
  
  console.log('All work and no play makes Jack a dull boy!')
})
复制代码

上面的代码片断演示了如何向现有文件添加新内容。若是运行应用程序并打开文件，您应该会看到其中的新内容。

点击此处查看此要点