Node.js如何使用檔案系統模組？常用fs模組方法介紹

本篇文章帶大家了解一下Node.js中的檔案系統模組，介紹一下使用檔案系統模組（fs模組）的方法，並介紹一些最常見且最有用的 fs 方法。

檔案系統模組（簡稱 fs）允許我們存取電腦上的檔案系統並與之互動。 【推薦學習：《nodejs 教學》】

#使用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 寫入檔案

檢視此重點：https://gist.github.com/catalinpit/571ba06c06214b5c8744036c6500af92

從檔案中讀取

在讀取檔案之前，需要建立並儲存檔案的路徑。

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 寫入檔案

檢視此要點：https://gist.github.com/catalinpit/badc2a539a44412892a0e05a9575d54d

读取目录的内容

在目录中显示文件与读取文件内容非常相似。但是，不是传递文件路径，而是传递当前工作目录（我们可以传递任何其他目录）。

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

fs.readdir(process.cwd(), (error, files) => {
  if (error) throw error

  console.log(files)
})

到目前为止，我们只使用 process.stdout.write 将内容输出到终端。但是，您可以简单地使用 console.log，就像上面的代码片段一样。

如果运行该应用程序，我们应该会得到一个包含目录中所有文件的数组。

查看此要点：https://gist.github.com/catalinpit/f82c4e6ae3acd5d97efdecb0bc67979e

删除文件

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

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

fs.unlink(filePath, error => {
  if (error) throw error

  console.log('文件已删除!')
})

如果您重新运行代码，您的文件将被删除！

查看此要点：https://gist.github.com/catalinpit/b1201434218c400f77e042109bfce99e

创建目录

我们可以使用 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。

查看此要点：https://gist.github.com/catalinpit/09bad802541102c0cce2a2e4c3985066

删除目录

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

因此，在文件中编写以下代码：

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 选项以及何时不避免问题是很重要的。

查看此要点：https://gist.github.com/catalinpit/a8cb6aca75cef8d6ac5043eae9ba22ce

目录/文件重命名

使用 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 方法包含三个参数：

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

因此，要重命名文件或目录，我们需要传递当前文件/目录的名称和新名称。运行应用程序后，应更新目录/文件的名称。

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

查看此要点：https://gist.github.com/catalinpit/5c3e7c6ae39d09996ff67175a719122e

向文件中添加内容

我们还可以使用 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!')
})

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

查看此要点：https://gist.github.com/catalinpit/7c8d40db53dea9e6831f9ee89d92475c

原文地址：https://juejin.cn/post/6991848361527607327

作者：lio_zero

更多编程相关知识，请访问：编程视频！！

以上是Node.js如何使用檔案系統模組？常用fs模組方法介紹的詳細內容。更多資訊請關注PHP中文網其他相關文章！